Class PipelineProps

Inheritance

System.Object

PipelineProps

Implements

Namespace: Amazon.CDK.AWS.CodePipeline

Assembly: Amazon.CDK.AWS.CodePipeline.dll

Syntax (csharp)

public class PipelineProps : Object, IPipelineProps

Syntax (vb)

Public Class PipelineProps
    Inherits Object
    Implements IPipelineProps

Remarks

ExampleMetadata: infused

Examples

PipelineProject project;

Repository repository = new Repository(this, "MyRepository", new RepositoryProps {
    RepositoryName = "MyRepository"
});
PipelineProject project = new PipelineProject(this, "MyProject");

Artifact sourceOutput = new Artifact();
CodeCommitSourceAction sourceAction = new CodeCommitSourceAction(new CodeCommitSourceActionProps {
    ActionName = "CodeCommit",
    Repository = repository,
    Output = sourceOutput
});
CodeBuildAction buildAction = new CodeBuildAction(new CodeBuildActionProps {
    ActionName = "CodeBuild",
    Project = project,
    Input = sourceOutput,
    Outputs = new [] { new Artifact() },  // optional
    ExecuteBatchBuild = true,  // optional, defaults to false
    CombineBatchBuildArtifacts = true
});

new Pipeline(this, "MyPipeline", new PipelineProps {
    Stages = new [] { new StageProps {
        StageName = "Source",
        Actions = new [] { sourceAction }
    }, new StageProps {
        StageName = "Build",
        Actions = new [] { buildAction }
    } }
});

Synopsis

Constructors

PipelineProps()

Properties

ArtifactBucket	The S3 bucket used by this Pipeline to store artifacts.
CrossAccountKeys	Create KMS keys for cross-account deployments.
CrossRegionReplicationBuckets	A map of region to S3 bucket name used for cross-region CodePipeline.
EnableKeyRotation	Enable KMS key rotation for the generated KMS keys.
PipelineName	Name of the pipeline.
RestartExecutionOnUpdate	Indicates whether to rerun the AWS CodePipeline pipeline after you update it.
ReuseCrossRegionSupportStacks	Reuse the same cross region support stack for all pipelines in the App.
Role	The IAM role to be assumed by this Pipeline.
Stages	The list of Stages, in order, to create this Pipeline with.

Constructors

PipelineProps()

public PipelineProps()

Properties

ArtifactBucket

The S3 bucket used by this Pipeline to store artifacts.

public IBucket ArtifactBucket { get; set; }

Property Value

IBucket

Remarks

Default: - A new S3 bucket will be created.

CrossAccountKeys

Create KMS keys for cross-account deployments.

public Nullable<bool> CrossAccountKeys { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

This controls whether the pipeline is enabled for cross-account deployments.

By default cross-account deployments are enabled, but this feature requires that KMS Customer Master Keys are created which have a cost of $1/month.

If you do not need cross-account deployments, you can set this to false to not create those keys and save on that cost (the artifact bucket will be encrypted with an AWS-managed key). However, cross-account deployments will no longer be possible.

Default: true

CrossRegionReplicationBuckets

A map of region to S3 bucket name used for cross-region CodePipeline.

public IDictionary<string, IBucket> CrossRegionReplicationBuckets { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, IBucket>

Remarks

For every Action that you specify targeting a different region than the Pipeline itself, if you don't provide an explicit Bucket for that region using this property, the construct will automatically create a Stack containing an S3 Bucket in that region.

Default: - None.

EnableKeyRotation

Enable KMS key rotation for the generated KMS keys.

public Nullable<bool> EnableKeyRotation { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

By default KMS key rotation is disabled, but will add an additional $1/month for each year the key exists when enabled.

Default: - false (key rotation is disabled)

PipelineName

Name of the pipeline.

public string PipelineName { get; set; }

Property Value

System.String

Remarks

Default: - AWS CloudFormation generates an ID and uses that for the pipeline name.

RestartExecutionOnUpdate

Indicates whether to rerun the AWS CodePipeline pipeline after you update it.

public Nullable<bool> RestartExecutionOnUpdate { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

ReuseCrossRegionSupportStacks

Reuse the same cross region support stack for all pipelines in the App.

public Nullable<bool> ReuseCrossRegionSupportStacks { get; set; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: - true (Use the same support stack for all pipelines in App)

Role

The IAM role to be assumed by this Pipeline.

public IRole Role { get; set; }

Property Value

IRole

Remarks

Default: a new IAM role will be created.

Stages

The list of Stages, in order, to create this Pipeline with.

public IStageProps[] Stages { get; set; }

Property Value

IStageProps[]

Remarks

You can always add more Stages later by calling {@link Pipeline#addStage}.

Default: - None.

Implements

IPipelineProps