heroku.pipeline.Pipeline

Example Usage

# Create Heroku apps for staging and production
resource "heroku_app" "staging" {
  name   = "test-app-staging"
  region = "us"
}

resource "heroku_app" "production" {
  name   = "test-app-production"
  region = "us"
}

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

  owner {
	  id   = "00b4aef3-073c-425b-92ab-274e483d19db"
	  type = "team"
  }
}

# Couple apps to different pipeline stages
resource "heroku_pipeline_coupling" "staging" {
  app_id   = heroku_app.staging.id
  pipeline = heroku_pipeline.test.id
  stage    = "staging"
}

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

Create Pipeline Resource

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

Constructor syntax

new Pipeline(name: string, args?: PipelineArgs, opts?: CustomResourceOptions);

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

@overload
def Pipeline(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             name: Optional[str] = None,
             owner: Optional[PipelineOwnerArgs] = None)

func NewPipeline(ctx *Context, name string, args *PipelineArgs, opts ...ResourceOption) (*Pipeline, error)

public Pipeline(string name, PipelineArgs? args = null, CustomResourceOptions? opts = null)

public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)

type: heroku:pipeline:Pipeline
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 pipelineResource = new Heroku.Pipeline.Pipeline("pipelineResource", new()
{
    Name = "string",
    Owner = new Heroku.Pipeline.Inputs.PipelineOwnerArgs
    {
        Id = "string",
        Type = "string",
    },
});

example, err := pipeline.NewPipeline(ctx, "pipelineResource", &pipeline.PipelineArgs{
	Name: pulumi.String("string"),
	Owner: &pipeline.PipelineOwnerArgs{
		Id:   pulumi.String("string"),
		Type: pulumi.String("string"),
	},
})

var pipelineResource = new Pipeline("pipelineResource", PipelineArgs.builder()
    .name("string")
    .owner(PipelineOwnerArgs.builder()
        .id("string")
        .type("string")
        .build())
    .build());

pipeline_resource = heroku.pipeline.Pipeline("pipelineResource",
    name="string",
    owner={
        "id": "string",
        "type": "string",
    })

const pipelineResource = new heroku.pipeline.Pipeline("pipelineResource", {
    name: "string",
    owner: {
        id: "string",
        type: "string",
    },
});

type: heroku:pipeline:Pipeline
properties:
    name: string
    owner:
        id: string
        type: string

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

Outputs

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

Look up Existing Pipeline Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        owner: Optional[PipelineOwnerArgs] = None) -> Pipeline

func GetPipeline(ctx *Context, name string, id IDInput, state *PipelineState, opts ...ResourceOption) (*Pipeline, error)

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

public static Pipeline get(String name, Output<String> id, PipelineState state, CustomResourceOptions options)

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

Supporting Types

PipelineOwner, PipelineOwnerArgs

Import

Pipelines can be imported using the Pipeline id, e.g.

$ pulumi import heroku:pipeline/pipeline:Pipeline 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.