heroku.pipeline.ConfigVar

Provides a resource to manage a pipeline’s config vars.

The pipeline config var API can only retrieve config vars that can be set at the pipeline level. Additionally, these two supported pipeline stages are:

• Heroku CI config vars (test stage)
• Review Apps config vars (review stage)

The development, staging & production stages do not have stage-level config vars, only those on the apps within each stage.

Example Usage

# Create a Heroku pipeline
resource "heroku_pipeline" "test-pipeline" {
  name = "test-app"
}

resource "heroku_pipeline_config_var" "configs" {
  pipeline_id = heroku_pipeline.test-pipeline.id
  pipeline_stage = "test"
  
  vars = {
    ENV = "test"
    TARGET = "develop"
  }

  sensitive_vars = {
    TEST_ACCESS_TOKEN = "some_access token"
  }
}

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

Constructor 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:

Outputs

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

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, str]] = 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)

resources:  _:    type: heroku:pipeline:ConfigVar    get:      id: ${id}

Import

This resource defines two config var attributes with one of them used for masking any sensitive/secret variables

during a pulumi preview|apply in a CI build, terminal, etc. This ‘sensitive’ distinction for config vars is unique to

this provider and not a built-in feature of the Heroku Platform API. Therefore, it will not be possible to import

this resource.

However, it is safe to define the resource in your configuration file and execute a pulumi up

as the end result is noop when the config vars already exist on the remote resource.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository

heroku pulumiverse/pulumi-heroku

License

Apache-2.0

Notes

This Pulumi package is based on the heroku Terraform Provider.