@Deprecated
public static final class CdkPipelineProps.Builder
extends java.lang.Object
CdkPipelineProps| Constructor and Description |
|---|
Builder()
Deprecated.
|
@Deprecated public CdkPipelineProps.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)
CdkPipelineProps.getCloudAssemblyArtifact()cloudAssemblyArtifact - The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action. This parameter is required.this@Deprecated public CdkPipelineProps.Builder assetBuildSpec(BuildSpec assetBuildSpec)
CdkPipelineProps.getAssetBuildSpec()assetBuildSpec - Custom BuildSpec that is merged with generated one (for asset publishing actions).this@Deprecated public CdkPipelineProps.Builder assetPreInstallCommands(java.util.List<java.lang.String> assetPreInstallCommands)
CdkPipelineProps.getAssetPreInstallCommands()assetPreInstallCommands - Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors.this@Deprecated public CdkPipelineProps.Builder cdkCliVersion(java.lang.String cdkCliVersion)
CdkPipelineProps.getCdkCliVersion()cdkCliVersion - 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.this@Deprecated public CdkPipelineProps.Builder codePipeline(Pipeline codePipeline)
CdkPipelineProps.getCodePipeline()codePipeline - 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]
this@Deprecated public CdkPipelineProps.Builder crossAccountKeys(java.lang.Boolean crossAccountKeys)
CdkPipelineProps.getCrossAccountKeys()crossAccountKeys - 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.
this@Deprecated public CdkPipelineProps.Builder dockerCredentials(java.util.List<? extends DockerCredential> dockerCredentials)
CdkPipelineProps.getDockerCredentials()dockerCredentials - A list of credentials used to authenticate to Docker registries.
Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.this@Deprecated public CdkPipelineProps.Builder enableKeyRotation(java.lang.Boolean enableKeyRotation)
CdkPipelineProps.getEnableKeyRotation()enableKeyRotation - Enables KMS key rotation for cross-account keys.
Cannot be set if crossAccountKeys was set to false.
Key rotation costs $1/month when enabled.
this@Deprecated public CdkPipelineProps.Builder pipelineName(java.lang.String pipelineName)
CdkPipelineProps.getPipelineName()pipelineName - Name of the pipeline.
Can only be set if codePipeline is not set.this@Deprecated public CdkPipelineProps.Builder selfMutating(java.lang.Boolean selfMutating)
CdkPipelineProps.getSelfMutating()selfMutating - 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.
this@Deprecated public CdkPipelineProps.Builder selfMutationBuildSpec(BuildSpec selfMutationBuildSpec)
CdkPipelineProps.getSelfMutationBuildSpec()selfMutationBuildSpec - Custom BuildSpec that is merged with generated one (for self-mutation stage).this@Deprecated public CdkPipelineProps.Builder singlePublisherPerType(java.lang.Boolean singlePublisherPerType)
CdkPipelineProps.getSinglePublisherPerType()singlePublisherPerType - Whether this pipeline creates one asset upload action per asset type or one asset upload per asset.this@Deprecated public CdkPipelineProps.Builder sourceAction(IAction sourceAction)
CdkPipelineProps.getSourceAction()sourceAction - The CodePipeline action used to retrieve the CDK app's source.this@Deprecated public CdkPipelineProps.Builder subnetSelection(SubnetSelection subnetSelection)
CdkPipelineProps.getSubnetSelection()subnetSelection - Which subnets to use.
Only used if 'vpc' is supplied.this@Deprecated public CdkPipelineProps.Builder supportDockerAssets(java.lang.Boolean supportDockerAssets)
CdkPipelineProps.getSupportDockerAssets()supportDockerAssets - 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.
this@Deprecated public CdkPipelineProps.Builder synthAction(IAction synthAction)
CdkPipelineProps.getSynthAction()synthAction - The CodePipeline action build and synthesis step of the CDK app.this@Deprecated public CdkPipelineProps.Builder vpc(IVpc vpc)
CdkPipelineProps.getVpc()vpc - The VPC where to execute the CdkPipeline actions.this@Deprecated public CdkPipelineProps build()
CdkPipelinePropsjava.lang.NullPointerException - if any required attribute was not provided