software.amazon.awscdk.pipelines

Class CodePipelineProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.CodePipelineProps.Jsii$Proxy

All Implemented Interfaces:

CodePipelineProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CodePipelineProps

@Stability(value=Experimental)
 @Internal
public static final class CodePipelineProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CodePipelineProps

An implementation for CodePipelineProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.pipelines.CodePipelineProps

CodePipelineProps.Builder, CodePipelineProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(IFileSetProducer synth, CodeBuildOptions assetPublishingCodeBuildDefaults, String cliVersion, CodeBuildOptions codeBuildDefaults, Pipeline codePipeline, Boolean crossAccountKeys, List<? extends DockerCredential> dockerCredentials, Boolean dockerEnabledForSelfMutation, Boolean dockerEnabledForSynth, String pipelineName, Boolean publishAssetsInParallel, Boolean selfMutation, CodeBuildOptions selfMutationCodeBuildDefaults) Constructor that initializes the object based on literal property values passed by the CodePipelineProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
CodeBuildOptions	getAssetPublishingCodeBuildDefaults() (experimental) Additional customizations to apply to the asset publishing CodeBuild projects.
String	getCliVersion() (experimental) CDK CLI version to use in self-mutation and asset publishing steps.
CodeBuildOptions	getCodeBuildDefaults() (experimental) Customize the CodeBuild projects created for this pipeline.
Pipeline	getCodePipeline() (experimental) An existing Pipeline to be reused and built upon.
Boolean	getCrossAccountKeys() (experimental) Create KMS keys for the artifact buckets, allowing cross-account deployments.
List<DockerCredential>	getDockerCredentials() (experimental) A list of credentials used to authenticate to Docker registries.
Boolean	getDockerEnabledForSelfMutation() (experimental) Enable Docker for the self-mutate step.
Boolean	getDockerEnabledForSynth() (experimental) Enable Docker for the 'synth' step.
String	getPipelineName() (experimental) The name of the CodePipeline pipeline.
Boolean	getPublishAssetsInParallel() (experimental) Publish assets in multiple CodeBuild projects.
Boolean	getSelfMutation() (experimental) Whether the pipeline will update itself.
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.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.pipelines.CodePipelineProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(IFileSetProducer synth,
                     CodeBuildOptions assetPublishingCodeBuildDefaults,
                     String cliVersion,
                     CodeBuildOptions codeBuildDefaults,
                     Pipeline codePipeline,
                     Boolean crossAccountKeys,
                     List<? extends DockerCredential> dockerCredentials,
                     Boolean dockerEnabledForSelfMutation,
                     Boolean dockerEnabledForSynth,
                     String pipelineName,
                     Boolean publishAssetsInParallel,
                     Boolean selfMutation,
                     CodeBuildOptions selfMutationCodeBuildDefaults)

Constructor that initializes the object based on literal property values passed by the CodePipelineProps.Builder.

Method Detail

getSynth

public final IFileSetProducer getSynth()

Description copied from interface: CodePipelineProps

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

Specified by:

getSynth in interface CodePipelineProps

getAssetPublishingCodeBuildDefaults

public final CodeBuildOptions getAssetPublishingCodeBuildDefaults()

Description copied from interface: CodePipelineProps

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

Default: - Only `codeBuildProjectDefaults` are applied

Specified by:

getAssetPublishingCodeBuildDefaults in interface CodePipelineProps

getCliVersion

public final String getCliVersion()

Description copied from interface: CodePipelineProps

(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

Specified by:

getCliVersion in interface CodePipelineProps

getCodeBuildDefaults

public final CodeBuildOptions getCodeBuildDefaults()

Description copied from interface: CodePipelineProps

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

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

Specified by:

getCodeBuildDefaults in interface CodePipelineProps

getCodePipeline

public final Pipeline getCodePipeline()

Description copied from interface: CodePipelineProps

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

[disable-awslint:ref-via-interface]

Default: - a new underlying pipeline is created.

Specified by:

getCodePipeline in interface CodePipelineProps

getCrossAccountKeys

public final Boolean getCrossAccountKeys()

Description copied from interface: CodePipelineProps

(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

Specified by:

getCrossAccountKeys in interface CodePipelineProps

getDockerCredentials

public final List<DockerCredential> getDockerCredentials()

Description copied from interface: CodePipelineProps

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

Specified by:

getDockerCredentials in interface CodePipelineProps

getDockerEnabledForSelfMutation

public final Boolean getDockerEnabledForSelfMutation()

Description copied from interface: CodePipelineProps

(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

Specified by:

getDockerEnabledForSelfMutation in interface CodePipelineProps

getDockerEnabledForSynth

public final Boolean getDockerEnabledForSynth()

Description copied from interface: CodePipelineProps

(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

Specified by:

getDockerEnabledForSynth in interface CodePipelineProps

getPipelineName

public final String getPipelineName()

Description copied from interface: CodePipelineProps

(experimental) The name of the CodePipeline pipeline.

Default: - Automatically generated

Specified by:

getPipelineName in interface CodePipelineProps

getPublishAssetsInParallel

public final Boolean getPublishAssetsInParallel()

Description copied from interface: CodePipelineProps

(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

Specified by:

getPublishAssetsInParallel in interface CodePipelineProps

getSelfMutation

public final Boolean getSelfMutation()

Description copied from interface: CodePipelineProps

(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

Specified by:

getSelfMutation in interface CodePipelineProps

getSelfMutationCodeBuildDefaults

public final CodeBuildOptions getSelfMutationCodeBuildDefaults()

Description copied from interface: CodePipelineProps

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

Default: - Only `codeBuildProjectDefaults` are applied

Specified by:

getSelfMutationCodeBuildDefaults in interface CodePipelineProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object