software.amazon.awscdk.pipelines

Class CdkPipeline.Builder

java.lang.Object

software.amazon.awscdk.pipelines.CdkPipeline.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CdkPipeline>

Enclosing class:

CdkPipeline

@Stability(value=Experimental)
public static final class CdkPipeline.Builder
extends Object
implements software.amazon.jsii.Builder<CdkPipeline>

(experimental) A fluent builder for CdkPipeline.

Method Summary

Modifier and Type	Method and Description
CdkPipeline	build()
CdkPipeline.Builder	cdkCliVersion(String cdkCliVersion) (experimental) CDK CLI version to use in pipeline.
CdkPipeline.Builder	cloudAssemblyArtifact(Artifact cloudAssemblyArtifact) (experimental) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.
CdkPipeline.Builder	codePipeline(Pipeline codePipeline) (experimental) Existing CodePipeline to add deployment stages to.
static CdkPipeline.Builder	create(software.constructs.Construct scope, String id)
CdkPipeline.Builder	crossAccountKeys(Boolean crossAccountKeys) (experimental) Create KMS keys for cross-account deployments.
CdkPipeline.Builder	pipelineName(String pipelineName) (experimental) Name of the pipeline.
CdkPipeline.Builder	selfMutating(Boolean selfMutating) (experimental) Whether the pipeline will update itself.
CdkPipeline.Builder	sourceAction(IAction sourceAction) (experimental) The CodePipeline action used to retrieve the CDK app's source.
CdkPipeline.Builder	subnetSelection(SubnetSelection subnetSelection) (experimental) Which subnets to use.
CdkPipeline.Builder	synthAction(IAction synthAction) (experimental) The CodePipeline action build and synthesis step of the CDK app.
CdkPipeline.Builder	vpc(IVpc vpc) (experimental) The VPC where to execute the CdkPipeline actions.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static CdkPipeline.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CdkPipeline.Builder.

cloudAssemblyArtifact

@Stability(value=Experimental)
public CdkPipeline.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)

(experimental) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.

Parameters:

cloudAssemblyArtifact - The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action. This parameter is required.

Returns:

this

cdkCliVersion

@Stability(value=Experimental)
public CdkPipeline.Builder cdkCliVersion(String cdkCliVersion)

(experimental) CDK CLI version to use in pipeline.

Some Actions in the pipeline will download and run a version of the CDK CLI. Specify the version here.

Default: - Latest version

Parameters:

cdkCliVersion - CDK CLI version to use in pipeline. This parameter is required.

Returns:

this

codePipeline

@Stability(value=Experimental)
public CdkPipeline.Builder codePipeline(Pipeline codePipeline)

(experimental) Existing CodePipeline to add deployment stages to.

Use this if you want more control over the CodePipeline that gets created. You can choose to not pass this value, in which case a new CodePipeline is created with default settings.

If you pass an existing CodePipeline, it should should have been created with restartExecutionOnUpdate: true.

[disable-awslint:ref-via-interface]

Default: - A new CodePipeline is automatically generated

Parameters:

codePipeline - Existing CodePipeline to add deployment stages to. This parameter is required.

Returns:

this

crossAccountKeys

@Stability(value=Experimental)
public CdkPipeline.Builder crossAccountKeys(Boolean crossAccountKeys)

(experimental) Create KMS keys for cross-account deployments.

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

Can only be set if codePipeline is not set.

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

pipelineName

@Stability(value=Experimental)
public CdkPipeline.Builder pipelineName(String pipelineName)

(experimental) Name of the pipeline.

Can only be set if codePipeline is not set.

Default: - A name is automatically generated

Parameters:

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

Returns:

this

selfMutating

@Stability(value=Experimental)
public CdkPipeline.Builder selfMutating(Boolean selfMutating)

(experimental) Whether the pipeline will update itself.

This needs to be set to true to allow the pipeline to reconfigure itself when assets or stages are being added to it, and true is the recommended setting.

You can temporarily set this to false while you are iterating on the pipeline itself and prefer to deploy changes using cdk deploy.

Default: true

Parameters:

selfMutating - Whether the pipeline will update itself. This parameter is required.

Returns:

this

sourceAction

@Stability(value=Experimental)
public CdkPipeline.Builder sourceAction(IAction sourceAction)

(experimental) The CodePipeline action used to retrieve the CDK app's source.

Default: - Required unless `codePipeline` is given

Parameters:

sourceAction - The CodePipeline action used to retrieve the CDK app's source. This parameter is required.

Returns:

this

subnetSelection

@Stability(value=Experimental)
public CdkPipeline.Builder subnetSelection(SubnetSelection subnetSelection)

(experimental) Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

Parameters:

subnetSelection - Which subnets to use. This parameter is required.

Returns:

this

synthAction

@Stability(value=Experimental)
public CdkPipeline.Builder synthAction(IAction synthAction)

(experimental) The CodePipeline action build and synthesis step of the CDK app.

Default: - Required unless `codePipeline` or `sourceAction` is given

Parameters:

synthAction - The CodePipeline action build and synthesis step of the CDK app. This parameter is required.

Returns:

this

vpc

@Stability(value=Experimental)
public CdkPipeline.Builder vpc(IVpc vpc)

(experimental) The VPC where to execute the CdkPipeline actions.

Default: - No VPC

Parameters:

vpc - The VPC where to execute the CdkPipeline actions. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public CdkPipeline build()

Specified by:

build in interface software.amazon.jsii.Builder<CdkPipeline>