pulumi/sdk/go/pulumi/config/require.go

138 lines
5.0 KiB
Go

// Copyright 2016-2022, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by "generate.go"; DO NOT EDIT.
package config
import (
"encoding/json"
"fmt"
"github.com/spf13/cast"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func failf(format string, a ...interface{}) {
panic(fmt.Errorf(format, a...))
}
func require(ctx *pulumi.Context, key string, secret bool, use, insteadOf string) string {
v, ok := get(ctx, key, use, insteadOf)
secretText := " "
if secret {
secretText = " --secret "
}
if !ok {
failf("Missing required configuration variable '%s'\n"+
"\tplease set a value using the command `pulumi config set%s%s <value>`",
key, secretText, key)
}
return v
}
// Require loads a configuration value by its key, or panics if it doesn't exist.
func Require(ctx *pulumi.Context, key string) string {
return require(ctx, key, false, "RequireSecret", "Require")
}
func requireObject(ctx *pulumi.Context, key string, secret bool, output interface{}, use, insteadOf string) {
v := require(ctx, key, secret, use, insteadOf)
if err := json.Unmarshal([]byte(v), output); err != nil {
failf("unable to unmarshall required configuration variable '%s'; %s", key, err)
}
}
// RequireObject loads an optional configuration value by its key into the output variable,
// or panics if unable to do so.
func RequireObject(ctx *pulumi.Context, key string, output interface{}) {
requireObject(ctx, key, false, output, "RequireSecretObject", "RequireObject")
}
func requireBool(ctx *pulumi.Context, key string, secret bool, use, insteadOf string) bool {
v := require(ctx, key, secret, use, insteadOf)
o, err := cast.ToBoolE(v)
if err != nil {
failf("unable to parse required configuration variable '%s'; %s", key, err)
}
return o
}
// RequireBool loads an optional configuration value by its key, as a bool, or panics if it doesn't exist.
func RequireBool(ctx *pulumi.Context, key string) bool {
return requireBool(ctx, key, false, "RequireSecretBool", "RequireBool")
}
func requireFloat64(ctx *pulumi.Context, key string, secret bool, use, insteadOf string) float64 {
v := require(ctx, key, secret, use, insteadOf)
o, err := cast.ToFloat64E(v)
if err != nil {
failf("unable to parse required configuration variable '%s'; %s", key, err)
}
return o
}
// RequireFloat64 loads an optional configuration value by its key, as a float64, or panics if it doesn't exist.
func RequireFloat64(ctx *pulumi.Context, key string) float64 {
return requireFloat64(ctx, key, false, "RequireSecretFloat64", "RequireFloat64")
}
func requireInt(ctx *pulumi.Context, key string, secret bool, use, insteadOf string) int {
v := require(ctx, key, secret, use, insteadOf)
o, err := cast.ToIntE(v)
if err != nil {
failf("unable to parse required configuration variable '%s'; %s", key, err)
}
return o
}
// RequireInt loads an optional configuration value by its key, as a int, or panics if it doesn't exist.
func RequireInt(ctx *pulumi.Context, key string) int {
return requireInt(ctx, key, false, "RequireSecretInt", "RequireInt")
}
// RequireSecret loads a configuration value by its key returning it wrapped in a secret Output,
// or panics if it doesn't exist.
func RequireSecret(ctx *pulumi.Context, key string) pulumi.StringOutput {
return pulumi.ToSecret(require(ctx, key, true, "", "")).(pulumi.StringOutput)
}
// RequireSecretObject loads an optional configuration value by its key into the output variable,
// returning it wrapped in a secret Output, or panics if unable to do so.
func RequireSecretObject(ctx *pulumi.Context, key string, output interface{}) pulumi.Output {
requireObject(ctx, key, true, output, "", "")
return pulumi.ToSecret(output)
}
// RequireSecretBool loads an optional configuration value by its key,
// as a bool wrapped in a secret Output, or panics if it doesn't exist.
func RequireSecretBool(ctx *pulumi.Context, key string) pulumi.BoolOutput {
return pulumi.ToSecret(requireBool(ctx, key, true, "", "")).(pulumi.BoolOutput)
}
// RequireSecretFloat64 loads an optional configuration value by its key,
// as a float64 wrapped in a secret Output, or panics if it doesn't exist.
func RequireSecretFloat64(ctx *pulumi.Context, key string) pulumi.Float64Output {
return pulumi.ToSecret(requireFloat64(ctx, key, true, "", "")).(pulumi.Float64Output)
}
// RequireSecretInt loads an optional configuration value by its key,
// as a int wrapped in a secret Output, or panics if it doesn't exist.
func RequireSecretInt(ctx *pulumi.Context, key string) pulumi.IntOutput {
return pulumi.ToSecret(requireInt(ctx, key, true, "", "")).(pulumi.IntOutput)
}