config

package
Version: v3.40.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2022 License: Apache-2.0 Imports: 5 Imported by: 159

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrMissingVar = missingVariable{}

Functions

func Get

func Get(ctx *pulumi.Context, key string) string

Get loads an optional configuration value by its key, or returns "" if it doesn't exist.

func GetBool

func GetBool(ctx *pulumi.Context, key string) bool

GetBool loads an optional configuration value by its key, as a bool, or returns false if it doesn't exist.

func GetFloat64

func GetFloat64(ctx *pulumi.Context, key string) float64

GetFloat64 loads an optional configuration value by its key, as a float64, or returns 0 if it doesn't exist.

func GetInt

func GetInt(ctx *pulumi.Context, key string) int

GetInt loads an optional configuration value by its key, as a int, or returns 0 if it doesn't exist.

func GetObject

func GetObject(ctx *pulumi.Context, key string, output interface{}) error

GetObject attempts to load an optional configuration value by its key into the specified output variable.

func GetSecret

func GetSecret(ctx *pulumi.Context, key string) pulumi.StringOutput

GetSecret loads an optional configuration value by its key, or "" if it does not exist, into a secret Output.

func GetSecretBool

func GetSecretBool(ctx *pulumi.Context, key string) pulumi.BoolOutput

GetSecretBool loads an optional bool configuration value by its key, or false if it does not exist, into a secret Output.

func GetSecretFloat64

func GetSecretFloat64(ctx *pulumi.Context, key string) pulumi.Float64Output

GetSecretFloat64 loads an optional float64 configuration value by its key, or false if it does not exist, into a secret Output.

func GetSecretInt

func GetSecretInt(ctx *pulumi.Context, key string) pulumi.IntOutput

GetSecretInt loads an optional int configuration value by its key, or false if it does not exist, into a secret Output.

func GetSecretObject

func GetSecretObject(ctx *pulumi.Context, key string, output interface{}) (pulumi.Output, error)

GetSecretObject attempts to load an optional configuration value by its key into the specified output variable.

func Require

func Require(ctx *pulumi.Context, key string) string

Require loads a configuration value by its key, or panics if it doesn't exist.

func RequireBool

func RequireBool(ctx *pulumi.Context, key string) bool

RequireBool loads an optional configuration value by its key, as a bool, or panics if it doesn't exist.

func RequireFloat64

func RequireFloat64(ctx *pulumi.Context, key string) float64

RequireFloat64 loads an optional configuration value by its key, as a float64, or panics if it doesn't exist.

func RequireInt

func RequireInt(ctx *pulumi.Context, key string) int

RequireInt loads an optional configuration value by its key, as a int, or panics if it doesn't exist.

func RequireObject

func RequireObject(ctx *pulumi.Context, key string, output interface{})

RequireObject loads an optional configuration value by its key into the output variable, or panics if unable to do so.

func RequireSecret

func RequireSecret(ctx *pulumi.Context, key string) pulumi.StringOutput

RequireSecret loads a configuration value by its key returning it wrapped in a secret Output, or panics if it doesn't exist.

func RequireSecretBool

func RequireSecretBool(ctx *pulumi.Context, key string) pulumi.BoolOutput

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 RequireSecretFloat64

func RequireSecretFloat64(ctx *pulumi.Context, key string) pulumi.Float64Output

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 RequireSecretInt

func RequireSecretInt(ctx *pulumi.Context, key string) pulumi.IntOutput

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 RequireSecretObject

func RequireSecretObject(ctx *pulumi.Context, key string, output interface{}) pulumi.Output

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 Try

func Try(ctx *pulumi.Context, key string) (string, error)

Try loads a configuration value by its key, returning a non-nil error if it doesn't exist.

func TryBool

func TryBool(ctx *pulumi.Context, key string) (bool, error)

TryBool loads an optional configuration value by its key, as a bool, or returns an error if it doesn't exist or can't be parsed.

func TryFloat64

func TryFloat64(ctx *pulumi.Context, key string) (float64, error)

TryFloat64 loads an optional configuration value by its key, as a float64, or returns an error if it doesn't exist or can't be parsed.

func TryInt

func TryInt(ctx *pulumi.Context, key string) (int, error)

TryInt loads an optional configuration value by its key, as a int, or returns an error if it doesn't exist or can't be parsed.

func TryObject

func TryObject(ctx *pulumi.Context, key string, output interface{}) error

TryObject loads an optional configuration value by its key into the output variable, or returns an error if unable to do so.

func TrySecret

func TrySecret(ctx *pulumi.Context, key string) (pulumi.StringOutput, error)

TrySecret loads a configuration value by its key, returning a non-nil error if it doesn't exist.

func TrySecretBool

func TrySecretBool(ctx *pulumi.Context, key string) (pulumi.BoolOutput, error)

TrySecretBool loads an optional configuration value by its key, as a bool, or returns an error if it doesn't exist.

func TrySecretFloat64

func TrySecretFloat64(ctx *pulumi.Context, key string) (pulumi.Float64Output, error)

TrySecretFloat64 loads an optional configuration value by its key, as a float64, or returns an error if it doesn't exist.

func TrySecretInt

func TrySecretInt(ctx *pulumi.Context, key string) (pulumi.IntOutput, error)

TrySecretInt loads an optional configuration value by its key, as a int, or returns an error if it doesn't exist.

func TrySecretObject

func TrySecretObject(ctx *pulumi.Context, key string, output interface{}) (pulumi.Output, error)

TrySecretObject loads a configuration value by its key into the output variable, or returns an error if unable to do so.

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is a struct that permits access to config as a "bag" with a package name. This avoids needing to access config with the fully qualified name all of the time (e.g., a bag whose namespace is "p" automatically translates attempted reads of keys "k" into "p:k"). This is optional but can save on some boilerplate when accessing config.

func New

func New(ctx *pulumi.Context, namespace string) *Config

New creates a new config bag with the given context and namespace.

func (*Config) Get

func (c *Config) Get(key string) string

Get loads an optional configuration value by its key, or returns "" if it doesn't exist.

func (*Config) GetBool

func (c *Config) GetBool(key string) bool

GetBool loads an optional bool configuration value by its key, or returns false if it doesn't exist.

func (*Config) GetFloat64

func (c *Config) GetFloat64(key string) float64

GetFloat64 loads an optional float64 configuration value by its key, or returns 0 if it doesn't exist.

func (*Config) GetInt

func (c *Config) GetInt(key string) int

GetInt loads an optional int configuration value by its key, or returns 0 if it doesn't exist.

func (*Config) GetObject

func (c *Config) GetObject(key string, output interface{}) error

GetObject loads an optional configuration value into the specified output by its key, or returns an error if unable to do so.

func (*Config) GetSecret

func (c *Config) GetSecret(key string) pulumi.StringOutput

GetSecret loads an optional configuration value by its key or "" if it doesn't exist, and returns it wrapped in a secret Output.

func (*Config) GetSecretBool

func (c *Config) GetSecretBool(key string) pulumi.BoolOutput

GetSecretBool loads an optional bool configuration value by its key or false if it doesn't exist, and returns it wrapped in a secret Output.

func (*Config) GetSecretFloat64

func (c *Config) GetSecretFloat64(key string) pulumi.Float64Output

GetSecretFloat64 loads an optional float64 configuration value by its key or 0 if it doesn't exist, and returns it wrapped in a secret Output.

func (*Config) GetSecretInt

func (c *Config) GetSecretInt(key string) pulumi.IntOutput

GetSecretInt loads an optional int configuration value by its key or 0 if it doesn't exist, and returns it wrapped in a secret Output.

func (*Config) GetSecretObject

func (c *Config) GetSecretObject(key string, output interface{}) (pulumi.Output, error)

GetSecretObject loads an optional configuration value into the specified output by its key, returning it wrapped in a secret Output or an error if unable to do so.

func (*Config) Require

func (c *Config) Require(key string) string

Require loads a configuration value by its key, or panics if it doesn't exist.

func (*Config) RequireBool

func (c *Config) RequireBool(key string) bool

RequireBool loads a bool configuration value by its key, or panics if it doesn't exist.

func (*Config) RequireFloat64

func (c *Config) RequireFloat64(key string) float64

RequireFloat64 loads a float64 configuration value by its key, or panics if it doesn't exist.

func (*Config) RequireInt

func (c *Config) RequireInt(key string) int

RequireInt loads a int configuration value by its key, or panics if it doesn't exist.

func (*Config) RequireObject

func (c *Config) RequireObject(key string, output interface{})

RequireObject loads a required configuration value into the specified output by its key, or panics if unable to do so.

func (*Config) RequireSecret

func (c *Config) RequireSecret(key string) pulumi.StringOutput

RequireSecret loads a configuration value by its key and returns it wrapped in a secret output, or panics if it doesn't exist.

func (*Config) RequireSecretBool

func (c *Config) RequireSecretBool(key string) pulumi.BoolOutput

RequireSecretBool loads a bool configuration value by its key and returns is wrapped in a secret Output, or panics if it doesn't exist.

func (*Config) RequireSecretFloat64

func (c *Config) RequireSecretFloat64(key string) pulumi.Float64Output

RequireSecretFloat64 loads a float64 configuration value by its key and returns is wrapped in a secret Output, or panics if it doesn't exist.

func (*Config) RequireSecretInt

func (c *Config) RequireSecretInt(key string) pulumi.IntOutput

RequireSecretInt loads a int configuration value by its key and returns is wrapped in a secret Output, or panics if it doesn't exist.

func (*Config) RequireSecretObject

func (c *Config) RequireSecretObject(key string, output interface{}) pulumi.Output

RequireSecretObject loads a required configuration value into the specified output by its key and returns it wrapped in a secret Output, or panics if unable to do so.

func (*Config) Try

func (c *Config) Try(key string) (string, error)

Try loads a configuration value by its key, returning a non-nil error if it doesn't exist.

func (*Config) TryBool

func (c *Config) TryBool(key string) (bool, error)

TryBool loads an optional bool configuration value by its key, or returns an error if it doesn't exist.

func (*Config) TryFloat64

func (c *Config) TryFloat64(key string) (float64, error)

TryFloat64 loads an optional float64 configuration value by its key, or returns an error if it doesn't exist.

func (*Config) TryInt

func (c *Config) TryInt(key string) (int, error)

TryInt loads an optional int configuration value by its key, or returns an error if it doesn't exist.

func (*Config) TryObject

func (c *Config) TryObject(key string, output interface{}) error

TryObject loads an optional configuration value into the specified output by its key, or returns an error if unable to do so.

func (*Config) TrySecret

func (c *Config) TrySecret(key string) (pulumi.StringOutput, error)

TrySecret loads a configuration value by its key, returning a non-nil error if it doesn't exist.

func (*Config) TrySecretBool

func (c *Config) TrySecretBool(key string) (pulumi.BoolOutput, error)

TrySecretBool loads an optional bool configuration value by its key into a secret Output, or returns an error if it doesn't exist.

func (*Config) TrySecretFloat64

func (c *Config) TrySecretFloat64(key string) (pulumi.Float64Output, error)

TrySecretFloat64 loads an optional float64 configuration value by its key into a secret Output, or returns an error if it doesn't exist.

func (*Config) TrySecretInt

func (c *Config) TrySecretInt(key string) (pulumi.IntOutput, error)

TrySecretInt loads an optional int configuration value by its key into a secret Output, or returns an error if it doesn't exist.

func (*Config) TrySecretObject

func (c *Config) TrySecretObject(key string, output interface{}) (pulumi.Output, error)

TrySecretObject loads a configuration value by its key, returning a non-nil error if it doesn't exist.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL