Heroku v1.0.4, Apr 8 25

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

heroku.app.ConfigAssociation

Explore with Pulumi AI

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

pulumiverse/pulumi-heroku

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.

Create ConfigAssociation Resource

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

Constructor syntax

new ConfigAssociation(name: string, args: ConfigAssociationArgs, opts?: CustomResourceOptions);

@overload
def ConfigAssociation(resource_name: str,
                      args: ConfigAssociationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ConfigAssociation(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      app_id: Optional[str] = None,
                      sensitive_vars: Optional[Mapping[str, str]] = None,
                      vars: Optional[Mapping[str, str]] = None)

func NewConfigAssociation(ctx *Context, name string, args ConfigAssociationArgs, opts ...ResourceOption) (*ConfigAssociation, error)

public ConfigAssociation(string name, ConfigAssociationArgs args, CustomResourceOptions? opts = null)

public ConfigAssociation(String name, ConfigAssociationArgs args)
public ConfigAssociation(String name, ConfigAssociationArgs args, CustomResourceOptions options)

type: heroku:app:ConfigAssociation
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 ConfigAssociationArgs: 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 ConfigAssociationArgs: 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 ConfigAssociationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConfigAssociationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConfigAssociationArgs: 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 configAssociationResource = new Heroku.App.ConfigAssociation("configAssociationResource", new()
{
    AppId = "string",
    SensitiveVars = 
    {
        { "string", "string" },
    },
    Vars = 
    {
        { "string", "string" },
    },
});

example, err := app.NewConfigAssociation(ctx, "configAssociationResource", &app.ConfigAssociationArgs{
	AppId: pulumi.String("string"),
	SensitiveVars: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Vars: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var configAssociationResource = new ConfigAssociation("configAssociationResource", ConfigAssociationArgs.builder()
    .appId("string")
    .sensitiveVars(Map.of("string", "string"))
    .vars(Map.of("string", "string"))
    .build());

config_association_resource = heroku.app.ConfigAssociation("configAssociationResource",
    app_id="string",
    sensitive_vars={
        "string": "string",
    },
    vars={
        "string": "string",
    })

const configAssociationResource = new heroku.app.ConfigAssociation("configAssociationResource", {
    appId: "string",
    sensitiveVars: {
        string: "string",
    },
    vars: {
        string: "string",
    },
});

type: heroku:app:ConfigAssociation
properties:
    appId: string
    sensitiveVars:
        string: string
    vars:
        string: string

ConfigAssociation 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 ConfigAssociation resource accepts the following input properties:

AppId string: Heroku app ID (do not use app name)
SensitiveVars Dictionary<string, string>
Vars Dictionary<string, string>: Map of config vars that can be output in plaintext.

AppId string: Heroku app ID (do not use app name)
SensitiveVars map[string]string
Vars map[string]string: Map of config vars that can be output in plaintext.

appId String: Heroku app ID (do not use app name)
sensitiveVars Map<String,String>
vars Map<String,String>: Map of config vars that can be output in plaintext.

appId string: Heroku app ID (do not use app name)
sensitiveVars {[key: string]: string}
vars {[key: string]: string}: Map of config vars that can be output in plaintext.

app_id str: Heroku app ID (do not use app name)
sensitive_vars Mapping[str, str]
vars Mapping[str, str]: Map of config vars that can be output in plaintext.

appId String: Heroku app ID (do not use app name)
sensitiveVars Map<String>
vars Map<String>: Map of config vars that can be output in plaintext.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ConfigAssociation Resource

Get an existing ConfigAssociation 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?: ConfigAssociationState, opts?: CustomResourceOptions): ConfigAssociation

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        sensitive_vars: Optional[Mapping[str, str]] = None,
        vars: Optional[Mapping[str, str]] = None) -> ConfigAssociation

func GetConfigAssociation(ctx *Context, name string, id IDInput, state *ConfigAssociationState, opts ...ResourceOption) (*ConfigAssociation, error)

public static ConfigAssociation Get(string name, Input<string> id, ConfigAssociationState? state, CustomResourceOptions? opts = null)

public static ConfigAssociation get(String name, Output<String> id, ConfigAssociationState state, CustomResourceOptions options)

resources:  _:    type: heroku:app:ConfigAssociation    get:      id: ${id}

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:

AppId string: Heroku app ID (do not use app name)
SensitiveVars Dictionary<string, string>
Vars Dictionary<string, string>: Map of config vars that can be output in plaintext.

AppId string: Heroku app ID (do not use app name)
SensitiveVars map[string]string
Vars map[string]string: Map of config vars that can be output in plaintext.

appId String: Heroku app ID (do not use app name)
sensitiveVars Map<String,String>
vars Map<String,String>: Map of config vars that can be output in plaintext.

appId string: Heroku app ID (do not use app name)
sensitiveVars {[key: string]: string}
vars {[key: string]: string}: Map of config vars that can be output in plaintext.

app_id str: Heroku app ID (do not use app name)
sensitive_vars Mapping[str, str]
vars Mapping[str, str]: Map of config vars that can be output in plaintext.

appId String: Heroku app ID (do not use app name)
sensitiveVars Map<String>
vars Map<String>: Map of config vars that can be output in plaintext.

Package Details

Repository: heroku pulumiverse/pulumi-heroku
License: Apache-2.0
Notes: This Pulumi package is based on the heroku Terraform Provider.

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

pulumiverse/pulumi-heroku

heroku.app.ConfigAssociation

On this page

On this page

Import

Create ConfigAssociation Resource

Constructor syntax

Parameters

Constructor example

ConfigAssociation Resource Properties

Inputs

Outputs

Look up Existing ConfigAssociation Resource

Package Details

On this page

On this page