heroku.pipeline.Coupling

Provides a Heroku Pipeline Coupling resource.

A pipeline is a group of Heroku apps that share the same codebase. Once a pipeline is created using heroku.pipeline.Pipeline, and apps are added to different stages using heroku.pipeline.Coupling, you can promote app slugs to the downstream stages.

See heroku.pipeline.Pipeline for complete usage documentation.

Example Usage

resource "heroku_pipeline_coupling" "production" {
  app_id   = heroku_app.production.id
  pipeline = heroku_pipeline.test.id
  stage    = "production"
}

Create Coupling Resource

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

Constructor syntax

new Coupling(name: string, args: CouplingArgs, opts?: CustomResourceOptions);

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

@overload
def Coupling(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             app_id: Optional[str] = None,
             pipeline: Optional[str] = None,
             stage: Optional[str] = None)

func NewCoupling(ctx *Context, name string, args CouplingArgs, opts ...ResourceOption) (*Coupling, error)

public Coupling(string name, CouplingArgs args, CustomResourceOptions? opts = null)

public Coupling(String name, CouplingArgs args)
public Coupling(String name, CouplingArgs args, CustomResourceOptions options)

type: heroku:pipeline:Coupling
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 couplingResource = new Heroku.Pipeline.Coupling("couplingResource", new()
{
    AppId = "string",
    Pipeline = "string",
    Stage = "string",
});

example, err := pipeline.NewCoupling(ctx, "couplingResource", &pipeline.CouplingArgs{
	AppId:    pulumi.String("string"),
	Pipeline: pulumi.String("string"),
	Stage:    pulumi.String("string"),
})

var couplingResource = new Coupling("couplingResource", CouplingArgs.builder()
    .appId("string")
    .pipeline("string")
    .stage("string")
    .build());

coupling_resource = heroku.pipeline.Coupling("couplingResource",
    app_id="string",
    pipeline="string",
    stage="string")

const couplingResource = new heroku.pipeline.Coupling("couplingResource", {
    appId: "string",
    pipeline: "string",
    stage: "string",
});

type: heroku:pipeline:Coupling
properties:
    appId: string
    pipeline: string
    stage: string

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

Outputs

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

Look up Existing Coupling Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        pipeline: Optional[str] = None,
        stage: Optional[str] = None) -> Coupling

func GetCoupling(ctx *Context, name string, id IDInput, state *CouplingState, opts ...ResourceOption) (*Coupling, error)

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

public static Coupling get(String name, Output<String> id, CouplingState state, CustomResourceOptions options)

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

Import

Pipeline couplings can be imported using the Pipeline coupling id, e.g.

$ pulumi import heroku:pipeline/coupling:Coupling foobar 12345678

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.