software.amazon.awscdk.services.codepipeline

Class Pipeline.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.Pipeline.Builder

Enclosing class:

Pipeline

public static final class Pipeline.Builder
extends java.lang.Object

A fluent builder for Pipeline.

Method Summary

Modifier and Type	Method and Description
Pipeline.Builder	artifactBucket(IBucket artifactBucket) The S3 bucket used by this Pipeline to store artifacts.
Pipeline	build()
static Pipeline.Builder	create(software.constructs.Construct scope, java.lang.String id)
Pipeline.Builder	crossAccountKeys(java.lang.Boolean crossAccountKeys) Create KMS keys for cross-account deployments.
Pipeline.Builder	crossRegionReplicationBuckets(java.util.Map<java.lang.String,? extends IBucket> crossRegionReplicationBuckets) A map of region to S3 bucket name used for cross-region CodePipeline.
Pipeline.Builder	enableKeyRotation(java.lang.Boolean enableKeyRotation) Enable KMS key rotation for the generated KMS keys.
Pipeline.Builder	pipelineName(java.lang.String pipelineName) Name of the pipeline.
Pipeline.Builder	restartExecutionOnUpdate(java.lang.Boolean restartExecutionOnUpdate) Indicates whether to rerun the AWS CodePipeline pipeline after you update it.
Pipeline.Builder	reuseCrossRegionSupportStacks(java.lang.Boolean reuseCrossRegionSupportStacks) Reuse the same cross region support stack for all pipelines in the App.
Pipeline.Builder	role(IRole role) The IAM role to be assumed by this Pipeline.
Pipeline.Builder	stages(java.util.List<? extends StageProps> stages) The list of Stages, in order, to create this Pipeline with.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static Pipeline.Builder create(software.constructs.Construct scope,
                                      java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Pipeline.Builder.

artifactBucket

public Pipeline.Builder artifactBucket(IBucket artifactBucket)

The S3 bucket used by this Pipeline to store artifacts.

Default: - A new S3 bucket will be created.

Parameters:

artifactBucket - The S3 bucket used by this Pipeline to store artifacts. This parameter is required.

Returns:

this

crossAccountKeys

public Pipeline.Builder crossAccountKeys(java.lang.Boolean crossAccountKeys)

Create KMS keys for cross-account deployments.

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

Parameters:

crossAccountKeys - Create KMS keys for cross-account deployments. This parameter is required.

Returns:

this

crossRegionReplicationBuckets

public Pipeline.Builder crossRegionReplicationBuckets(java.util.Map<java.lang.String,? extends IBucket> crossRegionReplicationBuckets)

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

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.

Parameters:

crossRegionReplicationBuckets - A map of region to S3 bucket name used for cross-region CodePipeline. This parameter is required.

Returns:

this

enableKeyRotation

public Pipeline.Builder enableKeyRotation(java.lang.Boolean enableKeyRotation)

Enable KMS key rotation for the generated KMS keys.

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)

Parameters:

enableKeyRotation - Enable KMS key rotation for the generated KMS keys. This parameter is required.

Returns:

this

pipelineName

public Pipeline.Builder pipelineName(java.lang.String pipelineName)

Name of the pipeline.

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

Parameters:

pipelineName - Name of the pipeline. This parameter is required.

Returns:

this

restartExecutionOnUpdate

public Pipeline.Builder restartExecutionOnUpdate(java.lang.Boolean restartExecutionOnUpdate)

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

Default: false

Parameters:

restartExecutionOnUpdate - Indicates whether to rerun the AWS CodePipeline pipeline after you update it. This parameter is required.

Returns:

this

reuseCrossRegionSupportStacks

public Pipeline.Builder reuseCrossRegionSupportStacks(java.lang.Boolean reuseCrossRegionSupportStacks)

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

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

Parameters:

reuseCrossRegionSupportStacks - Reuse the same cross region support stack for all pipelines in the App. This parameter is required.

Returns:

this

role

public Pipeline.Builder role(IRole role)

The IAM role to be assumed by this Pipeline.

Default: a new IAM role will be created.

Parameters:

role - The IAM role to be assumed by this Pipeline. This parameter is required.

Returns:

this

stages

public Pipeline.Builder stages(java.util.List<? extends StageProps> stages)

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

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

Default: - None.

Parameters:

stages - The list of Stages, in order, to create this Pipeline with. This parameter is required.

Returns:

this

build

public Pipeline build()