Variable class

Creates a variable within the given configuration. You cannot create a variable with a name that is a prefix of an existing variable name, or a name that has an existing variable name as a prefix. To learn more about creating a variable, read the Setting and Getting Data documentation.

Constructors

Variable(String name, {VariableArgs? args, CustomResourceOptions? options})

Creates a new Variable. name The Pulumi resource name. args Arguments used to configure this Variable. The set of arguments for Variable. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

configId ↔ Output<String>

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The name of the variable resource, in the format: projects/PROJECT_ID/configs/CONFIG_NAME/variables/VARIABLE_NAME The [PROJECT_ID] must be a valid project ID, [CONFIG_NAME] must be a valid RuntimeConfig resource and [VARIABLE_NAME] follows Unix file system file path naming. The [VARIABLE_NAME] can contain ASCII letters, numbers, slashes and dashes. Slashes are used as path element separators and are not part of the [VARIABLE_NAME] itself, so [VARIABLE_NAME] must contain at least one non-slash character. Multiple slashes are coalesced into single slash character. Each path segment should match 0-9A-Za-z? regular expression. The length of a [VARIABLE_NAME] must be less than 256 characters. Once you create a variable, you cannot change the variable name.

late, final

project ↔ Output<String>

late, final

requestId ↔ Output<String?>

An optional but recommended unique request_id. If the server receives two create() requests with the same request_id, then the second request will be ignored and the first resource created and stored in the backend is returned. Empty request_id fields are ignored. It is responsibility of the client to ensure uniqueness of the request_id strings. request_id strings are limited to 64 characters.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The current state of the variable. The variable state indicates the outcome of the variables().watch call and is visible through the get and list calls.

late, final

text ↔ Output<String>

The string value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. For example, text: "my text value". The string must be valid UTF-8.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The time of the last variable update. Timestamp will be UTC timestamp.

late, final

urn ↔ Output<String>

late, final, inherited

value ↔ Output<String>

The binary value of the variable. The length of the value must be less than 4096 bytes. Empty values are also accepted. The value must be base64 encoded, and must comply with IETF RFC4648 (https://www.ietf.org/rfc/rfc4648.txt). Only one of value or text can be set.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited