Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. Variable
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.Variable

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

    Retrieves a config item.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

const example = new scm.Variable("example", {folder: "Shared"});

    import pulumi
import pulumi_scm as scm

example = scm.Variable("example", folder="Shared")

    package main

import (
	"github.com/pulumi/pulumi-scm/sdk/go/scm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scm.NewVariable(ctx, "example", &scm.VariableArgs{
			Folder: pulumi.String("Shared"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = new Scm.Variable("example", new()
    {
        Folder = "Shared",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.Variable;
import com.pulumi.scm.VariableArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Variable("example", VariableArgs.builder()
            .folder("Shared")
            .build());

    }
}

    resources:
  example:
    type: scm:Variable
    properties:
      folder: Shared

    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: Optional[VariableArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Variable(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             device: Optional[str] = None,
             folder: Optional[str] = None,
             name: Optional[str] = None,
             snippet: Optional[str] = None,
             type: 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 = null, CustomResourceOptions? opts = null)
    public Variable(String name, VariableArgs args)
public Variable(String name, VariableArgs args, CustomResourceOptions options)

    type: scm: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 Scm.Variable("variableResource", new()
{
    Description = "string",
    Device = "string",
    Folder = "string",
    Name = "string",
    Snippet = "string",
    Type = "string",
    Value = "string",
});

    example, err := scm.NewVariable(ctx, "variableResource", &scm.VariableArgs{
	Description: pulumi.String("string"),
	Device:      pulumi.String("string"),
	Folder:      pulumi.String("string"),
	Name:        pulumi.String("string"),
	Snippet:     pulumi.String("string"),
	Type:        pulumi.String("string"),
	Value:       pulumi.String("string"),
})

    var variableResource = new Variable("variableResource", VariableArgs.builder()
    .description("string")
    .device("string")
    .folder("string")
    .name("string")
    .snippet("string")
    .type("string")
    .value("string")
    .build());

    variable_resource = scm.Variable("variableResource",
    description="string",
    device="string",
    folder="string",
    name="string",
    snippet="string",
    type="string",
    value="string")

    const variableResource = new scm.Variable("variableResource", {
    description: "string",
    device: "string",
    folder: "string",
    name: "string",
    snippet: "string",
    type: "string",
    value: "string",
});

    type: scm:Variable
properties:
    description: string
    device: string
    folder: string
    name: string
    snippet: string
    type: 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:

    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Snippet string
    The Snippet param.
    Type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    Value string
    value can accept either string or integer.
    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Snippet string
    The Snippet param.
    Type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    Value string
    value can accept either string or integer.
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet String
    The Snippet param.
    type String
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value String
    value can accept either string or integer.
    description string
    The Description param.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet string
    The Snippet param.
    type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value string
    value can accept either string or integer.
    description str
    The Description param.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet str
    The Snippet param.
    type str
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value str
    value can accept either string or integer.
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    snippet String
    The Snippet param.
    type String
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value String
    value can accept either string or integer.

    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.
    Overridden bool
    The Overridden param.
    Tfid string
    Id string
    The provider-assigned unique ID for this managed resource.
    Overridden bool
    The Overridden param.
    Tfid string
    id String
    The provider-assigned unique ID for this managed resource.
    overridden Boolean
    The Overridden param.
    tfid String
    id string
    The provider-assigned unique ID for this managed resource.
    overridden boolean
    The Overridden param.
    tfid string
    id str
    The provider-assigned unique ID for this managed resource.
    overridden bool
    The Overridden param.
    tfid str
    id String
    The provider-assigned unique ID for this managed resource.
    overridden Boolean
    The Overridden param.
    tfid String

    Look up Existing Variable Resource

    Get an existing Variable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VariableState, opts?: CustomResourceOptions): Variable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        folder: Optional[str] = None,
        name: Optional[str] = None,
        overridden: Optional[bool] = None,
        snippet: Optional[str] = None,
        tfid: Optional[str] = None,
        type: Optional[str] = None,
        value: Optional[str] = None) -> Variable
    func GetVariable(ctx *Context, name string, id IDInput, state *VariableState, opts ...ResourceOption) (*Variable, error)
    public static Variable Get(string name, Input<string> id, VariableState? state, CustomResourceOptions? opts = null)
    public static Variable get(String name, Output<String> id, VariableState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Overridden bool
    The Overridden param.
    Snippet string
    The Snippet param.
    Tfid string
    Type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    Value string
    value can accept either string or integer.
    Description string
    The Description param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    Overridden bool
    The Overridden param.
    Snippet string
    The Snippet param.
    Tfid string
    Type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    Value string
    value can accept either string or integer.
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden Boolean
    The Overridden param.
    snippet String
    The Snippet param.
    tfid String
    type String
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value String
    value can accept either string or integer.
    description string
    The Description param.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden boolean
    The Overridden param.
    snippet string
    The Snippet param.
    tfid string
    type string
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value string
    value can accept either string or integer.
    description str
    The Description param.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden bool
    The Overridden param.
    snippet str
    The Snippet param.
    tfid str
    type str
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value str
    value can accept either string or integer.
    description String
    The Description param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    Alphanumeric string begin with letter: [0-9a-zA-Z._-]. String length must not exceed 63 characters.
    overridden Boolean
    The Overridden param.
    snippet String
    The Snippet param.
    tfid String
    type String
    The Type param. String must be one of these: "percent", "count", "ip-netmask", "zone", "ip-range", "ip-wildcard", "device-priority", "device-id", "egress-max", "as-number", "fqdn", "port", "link-tag", "group-id", "rate", "router-id", "qos-profile", "timer".
    value String
    value can accept either string or integer.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm