1. Packages
  2. Google Cloud Native
  3. API Docs
  4. runtimeconfig
  5. runtimeconfig/v1beta1
  6. Variable

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.runtimeconfig/v1beta1.Variable

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    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.

    Create Variable Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Variable(name: string, args: VariableArgs, opts?: CustomResourceOptions);
    @overload
    def Variable(resource_name: str,
                 args: VariableArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Variable(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 config_id: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 request_id: Optional[str] = None,
                 text: Optional[str] = None,
                 value: Optional[str] = None)
    func NewVariable(ctx *Context, name string, args VariableArgs, opts ...ResourceOption) (*Variable, error)
    public Variable(string name, VariableArgs args, CustomResourceOptions? opts = null)
    public Variable(String name, VariableArgs args)
    public Variable(String name, VariableArgs args, CustomResourceOptions options)
    
    type: google-native:runtimeconfig/v1beta1:Variable
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VariableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VariableArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VariableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VariableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VariableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var variableResource = new GoogleNative.RuntimeConfig.V1Beta1.Variable("variableResource", new()
    {
        ConfigId = "string",
        Name = "string",
        Project = "string",
        RequestId = "string",
        Text = "string",
        Value = "string",
    });
    
    example, err := runtimeconfig.NewVariable(ctx, "variableResource", &runtimeconfig.VariableArgs{
    	ConfigId:  pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Project:   pulumi.String("string"),
    	RequestId: pulumi.String("string"),
    	Text:      pulumi.String("string"),
    	Value:     pulumi.String("string"),
    })
    
    var variableResource = new Variable("variableResource", VariableArgs.builder()
        .configId("string")
        .name("string")
        .project("string")
        .requestId("string")
        .text("string")
        .value("string")
        .build());
    
    variable_resource = google_native.runtimeconfig.v1beta1.Variable("variableResource",
        config_id="string",
        name="string",
        project="string",
        request_id="string",
        text="string",
        value="string")
    
    const variableResource = new google_native.runtimeconfig.v1beta1.Variable("variableResource", {
        configId: "string",
        name: "string",
        project: "string",
        requestId: "string",
        text: "string",
        value: "string",
    });
    
    type: google-native:runtimeconfig/v1beta1:Variable
    properties:
        configId: string
        name: string
        project: string
        requestId: string
        text: string
        value: string
    

    Variable Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Variable resource accepts the following input properties:

    ConfigId string
    Name 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.
    Project string
    RequestId 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.
    Text 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.
    Value 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.
    ConfigId string
    Name 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.
    Project string
    RequestId 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.
    Text 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.
    Value 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.
    configId String
    name 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.
    project String
    requestId 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.
    text 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.
    value 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.
    configId string
    name 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.
    project string
    requestId 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.
    text 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.
    value 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.
    config_id str
    name str
    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.
    project str
    request_id str
    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.
    text str
    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.
    value str
    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.
    configId String
    name 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.
    project String
    requestId 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.
    text 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.
    value 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Variable resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    State 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.
    UpdateTime string
    The time of the last variable update. Timestamp will be UTC timestamp.
    Id string
    The provider-assigned unique ID for this managed resource.
    State 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.
    UpdateTime string
    The time of the last variable update. Timestamp will be UTC timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    state 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.
    updateTime String
    The time of the last variable update. Timestamp will be UTC timestamp.
    id string
    The provider-assigned unique ID for this managed resource.
    state 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.
    updateTime string
    The time of the last variable update. Timestamp will be UTC timestamp.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    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.
    update_time str
    The time of the last variable update. Timestamp will be UTC timestamp.
    id String
    The provider-assigned unique ID for this managed resource.
    state 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.
    updateTime String
    The time of the last variable update. Timestamp will be UTC timestamp.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi