software.amazon.awscdk.pipelines

Class CodePipeline.Builder

java.lang.Object

software.amazon.awscdk.pipelines.CodePipeline.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CodePipeline>

Enclosing class:

CodePipeline

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

A fluent builder for CodePipeline.

Method Summary

Modifier and Type	Method and Description
CodePipeline.Builder	assetPublishingCodeBuildDefaults(CodeBuildOptions assetPublishingCodeBuildDefaults) Additional customizations to apply to the asset publishing CodeBuild projects.
CodePipeline	build()
CodePipeline.Builder	cliVersion(String cliVersion) CDK CLI version to use in self-mutation and asset publishing steps.
CodePipeline.Builder	codeBuildDefaults(CodeBuildOptions codeBuildDefaults) Customize the CodeBuild projects created for this pipeline.
CodePipeline.Builder	codePipeline(Pipeline codePipeline) An existing Pipeline to be reused and built upon.
static CodePipeline.Builder	create(software.constructs.Construct scope, String id)
CodePipeline.Builder	crossAccountKeys(Boolean crossAccountKeys) Create KMS keys for the artifact buckets, allowing cross-account deployments.
CodePipeline.Builder	dockerCredentials(List<? extends DockerCredential> dockerCredentials) A list of credentials used to authenticate to Docker registries.
CodePipeline.Builder	dockerEnabledForSelfMutation(Boolean dockerEnabledForSelfMutation) Enable Docker for the self-mutate step.
CodePipeline.Builder	dockerEnabledForSynth(Boolean dockerEnabledForSynth) Enable Docker for the 'synth' step.
CodePipeline.Builder	pipelineName(String pipelineName) The name of the CodePipeline pipeline.
CodePipeline.Builder	publishAssetsInParallel(Boolean publishAssetsInParallel) Publish assets in multiple CodeBuild projects.
CodePipeline.Builder	reuseCrossRegionSupportStacks(Boolean reuseCrossRegionSupportStacks) Reuse the same cross region support stack for all pipelines in the App.
CodePipeline.Builder	role(IRole role) The IAM role to be assumed by this Pipeline.
CodePipeline.Builder	selfMutation(Boolean selfMutation) Whether the pipeline will update itself.
CodePipeline.Builder	selfMutationCodeBuildDefaults(CodeBuildOptions selfMutationCodeBuildDefaults) Additional customizations to apply to the self mutation CodeBuild projects.
CodePipeline.Builder	synth(IFileSetProducer synth) The build step that produces the CDK Cloud Assembly.
CodePipeline.Builder	synthCodeBuildDefaults(CodeBuildOptions synthCodeBuildDefaults) Additional customizations to apply to the synthesize CodeBuild projects.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CodePipeline.Builder.

synth

@Stability(value=Stable)
public CodePipeline.Builder synth(IFileSetProducer synth)

The build step that produces the CDK Cloud Assembly.

The primary output of this step needs to be the cdk.out directory generated by the cdk synth command.

If you use a ShellStep here and you don't configure an output directory, the output directory will automatically be assumed to be cdk.out.

Parameters:

synth - The build step that produces the CDK Cloud Assembly. This parameter is required.

Returns:

this

assetPublishingCodeBuildDefaults

@Stability(value=Stable)
public CodePipeline.Builder assetPublishingCodeBuildDefaults(CodeBuildOptions assetPublishingCodeBuildDefaults)

Additional customizations to apply to the asset publishing CodeBuild projects.

Default: - Only `codeBuildDefaults` are applied

Parameters:

assetPublishingCodeBuildDefaults - Additional customizations to apply to the asset publishing CodeBuild projects. This parameter is required.

Returns:

this

cliVersion

@Stability(value=Stable)
public CodePipeline.Builder cliVersion(String cliVersion)

CDK CLI version to use in self-mutation and asset publishing steps.

If you want to lock the CDK CLI version used in the pipeline, by steps that are automatically generated for you, specify the version here.

We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions.

If you do specify it, be aware that this version should always be equal to or higher than the version of the CDK framework used by the CDK app, when the CDK commands are run during your pipeline execution. When you change this version, the next time the SelfMutate step runs it will still be using the CLI of the the previous version that was in this property: it will only start using the new version after SelfMutate completes successfully. That means that if you want to update both framework and CLI version, you should update the CLI version first, commit, push and deploy, and only then update the framework version.

Default: - Latest version

Parameters:

cliVersion - CDK CLI version to use in self-mutation and asset publishing steps. This parameter is required.

Returns:

this

codeBuildDefaults

@Stability(value=Stable)
public CodePipeline.Builder codeBuildDefaults(CodeBuildOptions codeBuildDefaults)

Customize the CodeBuild projects created for this pipeline.

Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_5_0

Parameters:

codeBuildDefaults - Customize the CodeBuild projects created for this pipeline. This parameter is required.

Returns:

this

codePipeline

@Stability(value=Stable)
public CodePipeline.Builder codePipeline(Pipeline codePipeline)

An existing Pipeline to be reused and built upon.

[disable-awslint:ref-via-interface]

Default: - a new underlying pipeline is created.

Parameters:

codePipeline - An existing Pipeline to be reused and built upon. This parameter is required.

Returns:

this

crossAccountKeys

@Stability(value=Stable)
public CodePipeline.Builder crossAccountKeys(Boolean crossAccountKeys)

Create KMS keys for the artifact buckets, allowing cross-account deployments.

The artifact buckets have to be encrypted to support deploying CDK apps to another account, so if you want to do that or want to have your artifact buckets encrypted, be sure to set this value to true.

Be aware there is a cost associated with maintaining the KMS keys.

Default: false

Parameters:

crossAccountKeys - Create KMS keys for the artifact buckets, allowing cross-account deployments. This parameter is required.

Returns:

this

dockerCredentials

@Stability(value=Stable)
public CodePipeline.Builder dockerCredentials(List<? extends DockerCredential> dockerCredentials)

A list of credentials used to authenticate to Docker registries.

Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.

Default: []

Parameters:

dockerCredentials - A list of credentials used to authenticate to Docker registries. This parameter is required.

Returns:

this

dockerEnabledForSelfMutation

@Stability(value=Stable)
public CodePipeline.Builder dockerEnabledForSelfMutation(Boolean dockerEnabledForSelfMutation)

Enable Docker for the self-mutate step.

Set this to true if the pipeline itself uses Docker container assets (for example, if you use LinuxBuildImage.fromAsset() as the build image of a CodeBuild step in the pipeline).

You do not need to set it if you build Docker image assets in the application Stages and Stacks that are deployed by this pipeline.

Configures privileged mode for the self-mutation CodeBuild action.

If you are about to turn this on in an already-deployed Pipeline, set the value to true first, commit and allow the pipeline to self-update, and only then use the Docker asset in the pipeline.

Default: false

Parameters:

dockerEnabledForSelfMutation - Enable Docker for the self-mutate step. This parameter is required.

Returns:

this

dockerEnabledForSynth

@Stability(value=Stable)
public CodePipeline.Builder dockerEnabledForSynth(Boolean dockerEnabledForSynth)

Enable Docker for the 'synth' step.

Set this to true if you are using file assets that require "bundling" anywhere in your application (meaning an asset compilation step will be run with the tools provided by a Docker image), both for the Pipeline stack as well as the application stacks.

A common way to use bundling assets in your application is by using the @aws-cdk/aws-lambda-nodejs library.

Configures privileged mode for the synth CodeBuild action.

If you are about to turn this on in an already-deployed Pipeline, set the value to true first, commit and allow the pipeline to self-update, and only then use the bundled asset.

Default: false

Parameters:

dockerEnabledForSynth - Enable Docker for the 'synth' step. This parameter is required.

Returns:

this

pipelineName

@Stability(value=Stable)
public CodePipeline.Builder pipelineName(String pipelineName)

The name of the CodePipeline pipeline.

Default: - Automatically generated

Parameters:

pipelineName - The name of the CodePipeline pipeline. This parameter is required.

Returns:

this

publishAssetsInParallel

@Stability(value=Stable)
public CodePipeline.Builder publishAssetsInParallel(Boolean publishAssetsInParallel)

Publish assets in multiple CodeBuild projects.

If set to false, use one Project per type to publish all assets.

Publishing in parallel improves concurrency and may reduce publishing latency, but may also increase overall provisioning time of the CodeBuild projects.

Experiment and see what value works best for you.

Default: true

Parameters:

publishAssetsInParallel - Publish assets in multiple CodeBuild projects. This parameter is required.

Returns:

this

reuseCrossRegionSupportStacks

@Stability(value=Stable)
public CodePipeline.Builder reuseCrossRegionSupportStacks(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

@Stability(value=Stable)
public CodePipeline.Builder role(IRole role)

The IAM role to be assumed by this Pipeline.

Default: - A new role is created

Parameters:

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

Returns:

this

selfMutation

@Stability(value=Stable)
public CodePipeline.Builder selfMutation(Boolean selfMutation)

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:

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

Returns:

this

selfMutationCodeBuildDefaults

@Stability(value=Stable)
public CodePipeline.Builder selfMutationCodeBuildDefaults(CodeBuildOptions selfMutationCodeBuildDefaults)

Additional customizations to apply to the self mutation CodeBuild projects.

Default: - Only `codeBuildDefaults` are applied

Parameters:

selfMutationCodeBuildDefaults - Additional customizations to apply to the self mutation CodeBuild projects. This parameter is required.

Returns:

this

synthCodeBuildDefaults

@Stability(value=Stable)
public CodePipeline.Builder synthCodeBuildDefaults(CodeBuildOptions synthCodeBuildDefaults)

Additional customizations to apply to the synthesize CodeBuild projects.

Default: - Only `codeBuildDefaults` are applied

Parameters:

synthCodeBuildDefaults - Additional customizations to apply to the synthesize CodeBuild projects. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CodePipeline build()

Specified by:

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