Config is a bag of related configuration state. Each bag contains any number of configuration variables, indexed by simple keys, and each has a name that uniquely identifies it; two bags with different names do not share values for variables that otherwise share the same key. For example, a bag whose name is pulumi:foo, with keys a, b, and c, is entirely separate from a bag whose name is pulumi:bar with the same simple key names. Each key has a fully qualified names, such as pulumi:foo:a, ..., and pulumi:bar:a, respectively.
Attributes
- Companion
- object
- Graph
-
- Supertypes
Members list
Value members
Concrete methods
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Type parameters
- A
-
the type of the configuration or secret value
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret value of the requested type
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret Boolean value
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret Double value
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret Int value
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret besom.json.JsValue value
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Type parameters
- A
-
the type to deserialize configuration or secret JSON value into
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret deserialized JSON value of the requested type
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
an optional configuration or secret String value
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Type parameters
- A
-
the type of the configuration or secret value
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret value of the requested type or ConfigError
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret Boolean value or ConfigError
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret Double value or ConfigError
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret Int value or ConfigError
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret besom.json.JsValue value or ConfigError
Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Type parameters
- A
-
the type to deserialize configuration or secret JSON value into
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret deserialized JSON value of the requested type or ConfigError
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Loads a configuration or secret value by its key, or throws if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.
Value parameters
- Context
-
the Besom context
- key
-
the requested configuration or secret key
Attributes
- Returns
-
the configuration or secret String value or ConfigError