1. Packages
  2. Heroku
  3. API Docs
  4. pipeline
  5. ConfigVar
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns

heroku.pipeline.ConfigVar

Explore with Pulumi AI

heroku logo
Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns

    Create ConfigVar Resource

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

    Constructor syntax

    new ConfigVar(name: string, args: ConfigVarArgs, opts?: CustomResourceOptions);
    @overload
    def ConfigVar(resource_name: str,
                  args: ConfigVarArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConfigVar(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  pipeline_id: Optional[str] = None,
                  pipeline_stage: Optional[str] = None,
                  sensitive_vars: Optional[Mapping[str, str]] = None,
                  vars: Optional[Mapping[str, str]] = None)
    func NewConfigVar(ctx *Context, name string, args ConfigVarArgs, opts ...ResourceOption) (*ConfigVar, error)
    public ConfigVar(string name, ConfigVarArgs args, CustomResourceOptions? opts = null)
    public ConfigVar(String name, ConfigVarArgs args)
    public ConfigVar(String name, ConfigVarArgs args, CustomResourceOptions options)
    
    type: heroku:pipeline:ConfigVar
    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 ConfigVarArgs
    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 ConfigVarArgs
    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 ConfigVarArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigVarArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigVarArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var configVarResource = new Heroku.Pipeline.ConfigVar("configVarResource", new()
    {
        PipelineId = "string",
        PipelineStage = "string",
        SensitiveVars = 
        {
            { "string", "string" },
        },
        Vars = 
        {
            { "string", "string" },
        },
    });
    
    example, err := pipeline.NewConfigVar(ctx, "configVarResource", &pipeline.ConfigVarArgs{
    	PipelineId:    pulumi.String("string"),
    	PipelineStage: pulumi.String("string"),
    	SensitiveVars: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Vars: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var configVarResource = new ConfigVar("configVarResource", ConfigVarArgs.builder()
        .pipelineId("string")
        .pipelineStage("string")
        .sensitiveVars(Map.of("string", "string"))
        .vars(Map.of("string", "string"))
        .build());
    
    config_var_resource = heroku.pipeline.ConfigVar("configVarResource",
        pipeline_id="string",
        pipeline_stage="string",
        sensitive_vars={
            "string": "string",
        },
        vars={
            "string": "string",
        })
    
    const configVarResource = new heroku.pipeline.ConfigVar("configVarResource", {
        pipelineId: "string",
        pipelineStage: "string",
        sensitiveVars: {
            string: "string",
        },
        vars: {
            string: "string",
        },
    });
    
    type: heroku:pipeline:ConfigVar
    properties:
        pipelineId: string
        pipelineStage: string
        sensitiveVars:
            string: string
        vars:
            string: string
    

    ConfigVar Resource Properties

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

    Inputs

    The ConfigVar resource accepts the following input properties:

    PipelineId string
    PipelineStage string
    SensitiveVars Dictionary<string, string>
    Vars Dictionary<string, string>
    PipelineId string
    PipelineStage string
    SensitiveVars map[string]string
    Vars map[string]string
    pipelineId String
    pipelineStage String
    sensitiveVars Map<String,String>
    vars Map<String,String>
    pipelineId string
    pipelineStage string
    sensitiveVars {[key: string]: string}
    vars {[key: string]: string}
    pipeline_id str
    pipeline_stage str
    sensitive_vars Mapping[str, str]
    vars Mapping[str, str]
    pipelineId String
    pipelineStage String
    sensitiveVars Map<String>
    vars Map<String>

    Outputs

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

    AllVars Dictionary<string, object>
    Id string
    The provider-assigned unique ID for this managed resource.
    AllVars map[string]interface{}
    Id string
    The provider-assigned unique ID for this managed resource.
    allVars Map<String,Object>
    id String
    The provider-assigned unique ID for this managed resource.
    allVars {[key: string]: any}
    id string
    The provider-assigned unique ID for this managed resource.
    all_vars Mapping[str, Any]
    id str
    The provider-assigned unique ID for this managed resource.
    allVars Map<Any>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConfigVar Resource

    Get an existing ConfigVar 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?: ConfigVarState, opts?: CustomResourceOptions): ConfigVar
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            all_vars: Optional[Mapping[str, Any]] = None,
            pipeline_id: Optional[str] = None,
            pipeline_stage: Optional[str] = None,
            sensitive_vars: Optional[Mapping[str, str]] = None,
            vars: Optional[Mapping[str, str]] = None) -> ConfigVar
    func GetConfigVar(ctx *Context, name string, id IDInput, state *ConfigVarState, opts ...ResourceOption) (*ConfigVar, error)
    public static ConfigVar Get(string name, Input<string> id, ConfigVarState? state, CustomResourceOptions? opts = null)
    public static ConfigVar get(String name, Output<String> id, ConfigVarState 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:
    AllVars Dictionary<string, object>
    PipelineId string
    PipelineStage string
    SensitiveVars Dictionary<string, string>
    Vars Dictionary<string, string>
    AllVars map[string]interface{}
    PipelineId string
    PipelineStage string
    SensitiveVars map[string]string
    Vars map[string]string
    allVars Map<String,Object>
    pipelineId String
    pipelineStage String
    sensitiveVars Map<String,String>
    vars Map<String,String>
    allVars {[key: string]: any}
    pipelineId string
    pipelineStage string
    sensitiveVars {[key: string]: string}
    vars {[key: string]: string}
    all_vars Mapping[str, Any]
    pipeline_id str
    pipeline_stage str
    sensitive_vars Mapping[str, str]
    vars Mapping[str, str]
    allVars Map<Any>
    pipelineId String
    pipelineStage String
    sensitiveVars Map<String>
    vars Map<String>

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.3 published on Friday, Apr 14, 2023 by pulumiverse - Marcel Arns