software.amazon.awscdk.pipelines

Interface CodePipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodePipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-08-11T10:33:08.817Z")
 @Stability(value=Experimental)
public interface CodePipelineProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a `CodePipeline`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CodePipelineProps.Builder A builder for CodePipelineProps
static class	CodePipelineProps.Jsii$Proxy An implementation for CodePipelineProps

Method Summary

Modifier and Type	Method and Description
static CodePipelineProps.Builder	builder()
default CodeBuildOptions	getAssetPublishingCodeBuildDefaults() (experimental) Additional customizations to apply to the asset publishing CodeBuild projects.
default String	getCliVersion() (experimental) CDK CLI version to use in self-mutation and asset publishing steps.
default CodeBuildOptions	getCodeBuildDefaults() (experimental) Customize the CodeBuild projects created for this pipeline.
default Pipeline	getCodePipeline() (experimental) An existing Pipeline to be reused and built upon.
default Boolean	getCrossAccountKeys() (experimental) Create KMS keys for the artifact buckets, allowing cross-account deployments.
default List<DockerCredential>	getDockerCredentials() (experimental) A list of credentials used to authenticate to Docker registries.
default Boolean	getDockerEnabledForSelfMutation() (experimental) Enable Docker for the self-mutate step.
default Boolean	getDockerEnabledForSynth() (experimental) Enable Docker for the 'synth' step.
default String	getPipelineName() (experimental) The name of the CodePipeline pipeline.
default Boolean	getPublishAssetsInParallel() (experimental) Publish assets in multiple CodeBuild projects.
default Boolean	getSelfMutation() (experimental) Whether the pipeline will update itself.
default CodeBuildOptions	getSelfMutationCodeBuildDefaults() (experimental) Additional customizations to apply to the self mutation CodeBuild projects.
IFileSetProducer	getSynth() (experimental) The build step that produces the CDK Cloud Assembly.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSynth

@Stability(value=Experimental)
 @NotNull
IFileSetProducer getSynth()

(experimental) 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.

getAssetPublishingCodeBuildDefaults

@Stability(value=Experimental)
 @Nullable
default CodeBuildOptions getAssetPublishingCodeBuildDefaults()

(experimental) Additional customizations to apply to the asset publishing CodeBuild projects.

Default: - Only `codeBuildProjectDefaults` are applied

getCliVersion

@Stability(value=Experimental)
 @Nullable
default String getCliVersion()

(experimental) 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.

You should not typically need to specify this value.

Default: - Latest version

getCodeBuildDefaults

@Stability(value=Experimental)
 @Nullable
default CodeBuildOptions getCodeBuildDefaults()

(experimental) Customize the CodeBuild projects created for this pipeline.

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

getCodePipeline

@Stability(value=Experimental)
 @Nullable
default Pipeline getCodePipeline()

(experimental) An existing Pipeline to be reused and built upon.

[disable-awslint:ref-via-interface]

Default: - a new underlying pipeline is created.

getCrossAccountKeys

@Stability(value=Experimental)
 @Nullable
default Boolean getCrossAccountKeys()

(experimental) 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

getDockerCredentials

@Stability(value=Experimental)
 @Nullable
default List<DockerCredential> getDockerCredentials()

(experimental) 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: []

getDockerEnabledForSelfMutation

@Stability(value=Experimental)
 @Nullable
default Boolean getDockerEnabledForSelfMutation()

(experimental) 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

getDockerEnabledForSynth

@Stability(value=Experimental)
 @Nullable
default Boolean getDockerEnabledForSynth()

(experimental) 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

getPipelineName

@Stability(value=Experimental)
 @Nullable
default String getPipelineName()

(experimental) The name of the CodePipeline pipeline.

Default: - Automatically generated

getPublishAssetsInParallel

@Stability(value=Experimental)
 @Nullable
default Boolean getPublishAssetsInParallel()

(experimental) 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

getSelfMutation

@Stability(value=Experimental)
 @Nullable
default Boolean getSelfMutation()

(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

getSelfMutationCodeBuildDefaults

@Stability(value=Experimental)
 @Nullable
default CodeBuildOptions getSelfMutationCodeBuildDefaults()

(experimental) Additional customizations to apply to the self mutation CodeBuild projects.

Default: - Only `codeBuildProjectDefaults` are applied

builder

@Stability(value=Experimental)
static CodePipelineProps.Builder builder()

Returns:

a CodePipelineProps.Builder of CodePipelineProps