software.amazon.awscdk.pipelines

Class CdkPipelineProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CdkPipelineProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CdkPipelineProps

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

An implementation for CdkPipelineProps

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

CdkPipelineProps.Builder, CdkPipelineProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(Artifact cloudAssemblyArtifact, String cdkCliVersion, Pipeline codePipeline, Boolean crossAccountKeys, String pipelineName, Boolean selfMutating, IAction sourceAction, SubnetSelection subnetSelection, IAction synthAction, IVpc vpc) Constructor that initializes the object based on literal property values passed by the CdkPipelineProps.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)
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.
Pipeline	getCodePipeline() (experimental) Existing CodePipeline to add deployment stages to.
Boolean	getCrossAccountKeys() (experimental) Create KMS keys for cross-account deployments.
String	getPipelineName() (experimental) Name of the pipeline.
Boolean	getSelfMutating() (experimental) Whether the pipeline will update itself.
IAction	getSourceAction() (experimental) The CodePipeline action used to retrieve the CDK app's source.
SubnetSelection	getSubnetSelection() (experimental) Which subnets to use.
IAction	getSynthAction() (experimental) The CodePipeline action build and synthesis step of the CDK app.
IVpc	getVpc() (experimental) The VPC where to execute the CdkPipeline actions.
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.CdkPipelineProps

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(Artifact cloudAssemblyArtifact,
                     String cdkCliVersion,
                     Pipeline codePipeline,
                     Boolean crossAccountKeys,
                     String pipelineName,
                     Boolean selfMutating,
                     IAction sourceAction,
                     SubnetSelection subnetSelection,
                     IAction synthAction,
                     IVpc vpc)

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

Method Detail

getCloudAssemblyArtifact

public final Artifact getCloudAssemblyArtifact()

Description copied from interface: CdkPipelineProps

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

Specified by:

getCloudAssemblyArtifact in interface CdkPipelineProps

getCdkCliVersion

public final String getCdkCliVersion()

Description copied from interface: CdkPipelineProps

(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

Specified by:

getCdkCliVersion in interface CdkPipelineProps

getCodePipeline

public final Pipeline getCodePipeline()

Description copied from interface: CdkPipelineProps

(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

Specified by:

getCodePipeline in interface CdkPipelineProps

getCrossAccountKeys

public final Boolean getCrossAccountKeys()

Description copied from interface: CdkPipelineProps

(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

Specified by:

getCrossAccountKeys in interface CdkPipelineProps

getPipelineName

public final String getPipelineName()

Description copied from interface: CdkPipelineProps

(experimental) Name of the pipeline.

Can only be set if codePipeline is not set.

Default: - A name is automatically generated

Specified by:

getPipelineName in interface CdkPipelineProps

getSelfMutating

public final Boolean getSelfMutating()

Description copied from interface: CdkPipelineProps

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

getSelfMutating in interface CdkPipelineProps

getSourceAction

public final IAction getSourceAction()

Description copied from interface: CdkPipelineProps

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

Default: - Required unless `codePipeline` is given

Specified by:

getSourceAction in interface CdkPipelineProps

getSubnetSelection

public final SubnetSelection getSubnetSelection()

Description copied from interface: CdkPipelineProps

(experimental) Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

Specified by:

getSubnetSelection in interface CdkPipelineProps

getSynthAction

public final IAction getSynthAction()

Description copied from interface: CdkPipelineProps

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

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

Specified by:

getSynthAction in interface CdkPipelineProps

getVpc

public final IVpc getVpc()

Description copied from interface: CdkPipelineProps

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

Default: - No VPC

Specified by:

getVpc in interface CdkPipelineProps

$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