public static final class CodePipelineProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CodePipelineProps
CodePipelineProps
CodePipelineProps.Builder, CodePipelineProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
CodeBuildOptions |
getAssetPublishingCodeBuildDefaults()
Additional customizations to apply to the asset publishing CodeBuild projects.
|
java.lang.String |
getCliVersion()
CDK CLI version to use in self-mutation and asset publishing steps.
|
CodeBuildOptions |
getCodeBuildDefaults()
Customize the CodeBuild projects created for this pipeline.
|
Pipeline |
getCodePipeline()
An existing Pipeline to be reused and built upon.
|
java.lang.Boolean |
getCrossAccountKeys()
Create KMS keys for the artifact buckets, allowing cross-account deployments.
|
java.util.List<DockerCredential> |
getDockerCredentials()
A list of credentials used to authenticate to Docker registries.
|
java.lang.Boolean |
getDockerEnabledForSelfMutation()
Enable Docker for the self-mutate step.
|
java.lang.Boolean |
getDockerEnabledForSynth()
Enable Docker for the 'synth' step.
|
java.lang.String |
getPipelineName()
The name of the CodePipeline pipeline.
|
java.lang.Boolean |
getPublishAssetsInParallel()
Publish assets in multiple CodeBuild projects.
|
java.lang.Boolean |
getReuseCrossRegionSupportStacks()
Reuse the same cross region support stack for all pipelines in the App.
|
java.lang.Boolean |
getSelfMutation()
Whether the pipeline will update itself.
|
CodeBuildOptions |
getSelfMutationCodeBuildDefaults()
Additional customizations to apply to the self mutation CodeBuild projects.
|
IFileSetProducer |
getSynth()
The build step that produces the CDK Cloud Assembly.
|
CodeBuildOptions |
getSynthCodeBuildDefaults()
Additional customizations to apply to the synthesize CodeBuild projects.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final IFileSetProducer getSynth()
CodePipelineProps
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
.
getSynth
in interface CodePipelineProps
public final CodeBuildOptions getAssetPublishingCodeBuildDefaults()
CodePipelineProps
Default: - Only `codeBuildDefaults` are applied
getAssetPublishingCodeBuildDefaults
in interface CodePipelineProps
public final java.lang.String getCliVersion()
CodePipelineProps
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.
We recommend you do not specify this value, as not specifying it always uses the latest CLI version which is backwards compatible with old versions.
If you do specify it, be aware that this version should always be equal to or higher than the
version of the CDK framework used by the CDK app, when the CDK commands are
run during your pipeline execution. When you change this version, the next
time the SelfMutate
step runs it will still be using the CLI of the the
previous version that was in this property: it will only start using the
new version after SelfMutate
completes successfully. That means that if
you want to update both framework and CLI version, you should update the
CLI version first, commit, push and deploy, and only then update the
framework version.
Default: - Latest version
getCliVersion
in interface CodePipelineProps
public final CodeBuildOptions getCodeBuildDefaults()
CodePipelineProps
Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_5_0
getCodeBuildDefaults
in interface CodePipelineProps
public final Pipeline getCodePipeline()
CodePipelineProps
[disable-awslint:ref-via-interface]
Default: - a new underlying pipeline is created.
getCodePipeline
in interface CodePipelineProps
public final java.lang.Boolean getCrossAccountKeys()
CodePipelineProps
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
getCrossAccountKeys
in interface CodePipelineProps
public final java.util.List<DockerCredential> getDockerCredentials()
CodePipelineProps
Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.
Default: []
getDockerCredentials
in interface CodePipelineProps
public final java.lang.Boolean getDockerEnabledForSelfMutation()
CodePipelineProps
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
getDockerEnabledForSelfMutation
in interface CodePipelineProps
public final java.lang.Boolean getDockerEnabledForSynth()
CodePipelineProps
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
getDockerEnabledForSynth
in interface CodePipelineProps
public final java.lang.String getPipelineName()
CodePipelineProps
Default: - Automatically generated
getPipelineName
in interface CodePipelineProps
public final java.lang.Boolean getPublishAssetsInParallel()
CodePipelineProps
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
getPublishAssetsInParallel
in interface CodePipelineProps
public final java.lang.Boolean getReuseCrossRegionSupportStacks()
CodePipelineProps
Default: - true (Use the same support stack for all pipelines in App)
getReuseCrossRegionSupportStacks
in interface CodePipelineProps
public final java.lang.Boolean getSelfMutation()
CodePipelineProps
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
getSelfMutation
in interface CodePipelineProps
public final CodeBuildOptions getSelfMutationCodeBuildDefaults()
CodePipelineProps
Default: - Only `codeBuildDefaults` are applied
getSelfMutationCodeBuildDefaults
in interface CodePipelineProps
public final CodeBuildOptions getSynthCodeBuildDefaults()
CodePipelineProps
Default: - Only `codeBuildDefaults` are applied
getSynthCodeBuildDefaults
in interface CodePipelineProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()