Class Config

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.

Constructors

constructor

Properties

name

Methods

get getBoolean getNumber getObject getSecret getSecretBoolean getSecretNumber getSecretObject require requireBoolean requireNumber requireObject requireSecret requireSecretBoolean requireSecretNumber requireSecretObject

Constructors

constructor

Properties

Readonly name

name: string

name is the configuration bag's logical name and uniquely identifies it. The default is the name of the current project.

Methods

get

  • get<K>(key, opts?): undefined | K

  • get loads an optional configuration value by its key, or undefined if it doesn't exist.

    Type Parameters

    • K extends string = string

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: StringConfigOptions<K>

      An options bag to constrain legal values.

    Returns undefined | K

getBoolean

  • getBoolean(key): undefined | boolean

  • getBoolean loads an optional configuration value, as a boolean, by its key, or undefined if it doesn't exist. If the configuration value isn't a legal boolean, this function will throw an error.

    Parameters

    • key: string

      The key to lookup.

    Returns undefined | boolean

getNumber

  • getNumber(key, opts?): undefined | number

  • getNumber loads an optional configuration value, as a number, by its key, or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: NumberConfigOptions

      An options bag to constrain legal values.

    Returns undefined | number

getObject

  • getObject<T>(key): undefined | T

  • getObject loads an optional configuration value, as an object, by its key, or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.

    Type Parameters

    • T

    Parameters

    • key: string

      The key to lookup.

    Returns undefined | T

getSecret

  • getSecret<K>(key, opts?): undefined | Output<K>

  • getSecret loads an optional configuration value by its key, marking it as a secret, or undefined if it doesn't exist.

    Type Parameters

    • K extends string = string

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: StringConfigOptions<K>

      An options bag to constrain legal values.

    Returns undefined | Output<K>

getSecretBoolean

  • getSecretBoolean(key): undefined | OutputInstance<boolean>

  • getSecretBoolean loads an optional configuration value, as a boolean, by its key, making it as a secret or undefined if it doesn't exist. If the configuration value isn't a legal boolean, this function will throw an error.

    Parameters

    • key: string

      The key to lookup.

    Returns undefined | OutputInstance<boolean>

getSecretNumber

  • getSecretNumber(key, opts?): undefined | OutputInstance<number>

  • getSecretNumber loads an optional configuration value, as a number, by its key, marking it as a secret or undefined if it doesn't exist. If the configuration value isn't a legal number, this function will throw an error.

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: NumberConfigOptions

      An options bag to constrain legal values.

    Returns undefined | OutputInstance<number>

getSecretObject

  • getSecretObject<T>(key): undefined | Output<T>

  • getSecretObject loads an optional configuration value, as an object, by its key, marking it as a secret or undefined if it doesn't exist. This routine simply JSON parses and doesn't validate the shape of the contents.

    Type Parameters

    • T

    Parameters

    • key: string

      The key to lookup.

    Returns undefined | Output<T>

require

  • require<K>(key, opts?): K

  • require loads a configuration value by its given key. If it doesn't exist, an error is thrown.

    Type Parameters

    • K extends string = string

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: StringConfigOptions<K>

      An options bag to constrain legal values.

    Returns K

requireBoolean

  • requireBoolean(key): boolean

  • requireBoolean loads a configuration value, as a boolean, by its given key. If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown.

    Parameters

    • key: string

      The key to lookup.

    Returns boolean

requireNumber

  • requireNumber(key, opts?): number

  • requireNumber loads a configuration value, as a number, by its given key. If it doesn't exist, or the configuration value is not a legal number, an error is thrown.

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: NumberConfigOptions

      An options bag to constrain legal values.

    Returns number

requireObject

  • requireObject<T>(key): T

  • requireObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object. If it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.

    Type Parameters

    • T

    Parameters

    • key: string

      The key to lookup.

    Returns T

requireSecret

  • requireSecret<K>(key, opts?): Output<K>

  • require loads a configuration value by its given key, marking it as a secret. If it doesn't exist, an error is thrown.

    Type Parameters

    • K extends string = string

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: StringConfigOptions<K>

      An options bag to constrain legal values.

    Returns Output<K>

requireSecretBoolean

  • requireSecretBoolean(key): OutputInstance<boolean>

  • requireSecretBoolean loads a configuration value, as a boolean, by its given key, marking it as a secret. If it doesn't exist, or the configuration value is not a legal boolean, an error is thrown.

    Parameters

    • key: string

      The key to lookup.

    Returns OutputInstance<boolean>

requireSecretNumber

  • requireSecretNumber(key, opts?): OutputInstance<number>

  • requireSecretNumber loads a configuration value, as a number, by its given key, marking it as a secret. If it doesn't exist, or the configuration value is not a legal number, an error is thrown.

    Parameters

    • key: string

      The key to lookup.

    • Optional opts: NumberConfigOptions

      An options bag to constrain legal values.

    Returns OutputInstance<number>

requireSecretObject

  • requireSecretObject<T>(key): Output<T>

  • requireSecretObject loads a configuration value as a JSON string and deserializes the JSON into a JavaScript object, marking it as a secret. If it doesn't exist, or the configuration value is not a legal JSON string, an error is thrown.

    Type Parameters

    • T

    Parameters

    • key: string

      The key to lookup.

    Returns Output<T>

Settings

Member Visibility

Theme

On This Page

constructornamegetgetBooleangetNumbergetObjectgetSecretgetSecretBooleangetSecretNumbergetSecretObjectrequirerequireBooleanrequireNumberrequireObjectrequireSecretrequireSecretBooleanrequireSecretNumberrequireSecretObject

Generated using TypeDoc