software.amazon.awscdk.pipelines

Class CdkPipeline.Builder

java.lang.Object

software.amazon.awscdk.pipelines.CdkPipeline.Builder

Enclosing class:

CdkPipeline

Deprecated.

@Deprecated
public static final class CdkPipeline.Builder
extends java.lang.Object

(deprecated) A fluent builder for CdkPipeline.

Method Summary

Modifier and Type	Method and Description
CdkPipeline.Builder	assetBuildSpec(BuildSpec assetBuildSpec) Deprecated.
CdkPipeline.Builder	assetPreInstallCommands(java.util.List<java.lang.String> assetPreInstallCommands) Deprecated.
CdkPipeline	build() Deprecated.
CdkPipeline.Builder	cdkCliVersion(java.lang.String cdkCliVersion) Deprecated.
CdkPipeline.Builder	cloudAssemblyArtifact(Artifact cloudAssemblyArtifact) Deprecated.
CdkPipeline.Builder	codePipeline(Pipeline codePipeline) Deprecated.
static CdkPipeline.Builder	create(software.constructs.Construct scope, java.lang.String id) Deprecated.
CdkPipeline.Builder	crossAccountKeys(java.lang.Boolean crossAccountKeys) Deprecated.
CdkPipeline.Builder	dockerCredentials(java.util.List<? extends DockerCredential> dockerCredentials) Deprecated.
CdkPipeline.Builder	enableKeyRotation(java.lang.Boolean enableKeyRotation) Deprecated.
CdkPipeline.Builder	pipelineName(java.lang.String pipelineName) Deprecated.
CdkPipeline.Builder	selfMutating(java.lang.Boolean selfMutating) Deprecated.
CdkPipeline.Builder	selfMutationBuildSpec(BuildSpec selfMutationBuildSpec) Deprecated.
CdkPipeline.Builder	singlePublisherPerType(java.lang.Boolean singlePublisherPerType) Deprecated.
CdkPipeline.Builder	sourceAction(IAction sourceAction) Deprecated.
CdkPipeline.Builder	subnetSelection(SubnetSelection subnetSelection) Deprecated.
CdkPipeline.Builder	supportDockerAssets(java.lang.Boolean supportDockerAssets) Deprecated.
CdkPipeline.Builder	synthAction(IAction synthAction) Deprecated.
CdkPipeline.Builder	vpc(IVpc vpc) Deprecated.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Deprecated.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of CdkPipeline.Builder.

cloudAssemblyArtifact

@Deprecated
public CdkPipeline.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)

Deprecated.

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

assetBuildSpec

@Deprecated
public CdkPipeline.Builder assetBuildSpec(BuildSpec assetBuildSpec)

Deprecated.

(deprecated) Custom BuildSpec that is merged with generated one (for asset publishing actions).

Default: - none

Parameters:

assetBuildSpec - Custom BuildSpec that is merged with generated one (for asset publishing actions). This parameter is required.

Returns:

this

assetPreInstallCommands

@Deprecated
public CdkPipeline.Builder assetPreInstallCommands(java.util.List<java.lang.String> assetPreInstallCommands)

Deprecated.

(deprecated) Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors.

Default: -

Parameters:

assetPreInstallCommands - Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors. This parameter is required.

Returns:

this

cdkCliVersion

@Deprecated
public CdkPipeline.Builder cdkCliVersion(java.lang.String cdkCliVersion)

Deprecated.

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

@Deprecated
public CdkPipeline.Builder codePipeline(Pipeline codePipeline)

Deprecated.

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

@Deprecated
public CdkPipeline.Builder crossAccountKeys(java.lang.Boolean crossAccountKeys)

Deprecated.

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

dockerCredentials

@Deprecated
public CdkPipeline.Builder dockerCredentials(java.util.List<? extends DockerCredential> dockerCredentials)

Deprecated.

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

enableKeyRotation

@Deprecated
public CdkPipeline.Builder enableKeyRotation(java.lang.Boolean enableKeyRotation)

Deprecated.

(deprecated) Enables KMS key rotation for cross-account keys.

Cannot be set if crossAccountKeys was set to false.

Key rotation costs $1/month when enabled.

Default: - false (key rotation is disabled)

Parameters:

enableKeyRotation - Enables KMS key rotation for cross-account keys. This parameter is required.

Returns:

this

pipelineName

@Deprecated
public CdkPipeline.Builder pipelineName(java.lang.String pipelineName)

Deprecated.

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

@Deprecated
public CdkPipeline.Builder selfMutating(java.lang.Boolean selfMutating)

Deprecated.

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

selfMutationBuildSpec

@Deprecated
public CdkPipeline.Builder selfMutationBuildSpec(BuildSpec selfMutationBuildSpec)

Deprecated.

(deprecated) Custom BuildSpec that is merged with generated one (for self-mutation stage).

Default: - none

Parameters:

selfMutationBuildSpec - Custom BuildSpec that is merged with generated one (for self-mutation stage). This parameter is required.

Returns:

this

singlePublisherPerType

@Deprecated
public CdkPipeline.Builder singlePublisherPerType(java.lang.Boolean singlePublisherPerType)

Deprecated.

(deprecated) Whether this pipeline creates one asset upload action per asset type or one asset upload per asset.

Default: false

Parameters:

singlePublisherPerType - Whether this pipeline creates one asset upload action per asset type or one asset upload per asset. This parameter is required.

Returns:

this

sourceAction

@Deprecated
public CdkPipeline.Builder sourceAction(IAction sourceAction)

Deprecated.

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

@Deprecated
public CdkPipeline.Builder subnetSelection(SubnetSelection subnetSelection)

Deprecated.

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

supportDockerAssets

@Deprecated
public CdkPipeline.Builder supportDockerAssets(java.lang.Boolean supportDockerAssets)

Deprecated.

(deprecated) Whether the pipeline needs to build Docker images in the UpdatePipeline stage.

If the UpdatePipeline stage tries to build a Docker image and this flag is not set to true, the build step will run in non-privileged mode and consequently will fail with a message like:

Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?

This flag has an effect only if selfMutating is also true.

Default: - false

Parameters:

supportDockerAssets - Whether the pipeline needs to build Docker images in the UpdatePipeline stage. This parameter is required.

Returns:

this

synthAction

@Deprecated
public CdkPipeline.Builder synthAction(IAction synthAction)

Deprecated.

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

@Deprecated
public CdkPipeline.Builder vpc(IVpc vpc)

Deprecated.

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

@Deprecated
public CdkPipeline build()

Deprecated.