software.amazon.awscdk.pipelines

Interface CdkPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CdkPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:29.080Z")
 @Stability(value=Experimental)
public interface CdkPipelineProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a CdkPipeline.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CdkPipelineProps.Builder	builder()
default String	getCdkCliVersion() (experimental) CDK CLI version to use in pipeline.
Artifact	getCloudAssemblyArtifact() (experimental) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.
default Pipeline	getCodePipeline() (experimental) Existing CodePipeline to add deployment stages to.
default Boolean	getCrossAccountKeys() (experimental) Create KMS keys for cross-account deployments.
default String	getPipelineName() (experimental) Name of the pipeline.
default Boolean	getSelfMutating() (experimental) Whether the pipeline will update itself.
default IAction	getSourceAction() (experimental) The CodePipeline action used to retrieve the CDK app's source.
default SubnetSelection	getSubnetSelection() (experimental) Which subnets to use.
default IAction	getSynthAction() (experimental) The CodePipeline action build and synthesis step of the CDK app.
default IVpc	getVpc() (experimental) The VPC where to execute the CdkPipeline actions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudAssemblyArtifact

@Stability(value=Experimental)
 @NotNull
Artifact getCloudAssemblyArtifact()

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

getCdkCliVersion

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

(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

getCodePipeline

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

(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

getCrossAccountKeys

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

(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

getPipelineName

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

(experimental) Name of the pipeline.

Can only be set if codePipeline is not set.

Default: - A name is automatically generated

getSelfMutating

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

(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

getSourceAction

@Stability(value=Experimental)
 @Nullable
default IAction getSourceAction()

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

Default: - Required unless `codePipeline` is given

getSubnetSelection

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getSubnetSelection()

(experimental) Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

getSynthAction

@Stability(value=Experimental)
 @Nullable
default IAction getSynthAction()

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

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

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

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

Default: - No VPC

builder

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

Returns:

a CdkPipelineProps.Builder of CdkPipelineProps