CdkPipelineProps
- class aws_cdk.pipelines.CdkPipelineProps(*, cloud_assembly_artifact, asset_build_spec=None, asset_pre_install_commands=None, cdk_cli_version=None, code_pipeline=None, cross_account_keys=None, docker_credentials=None, enable_key_rotation=None, pipeline_name=None, self_mutating=None, self_mutation_build_spec=None, single_publisher_per_type=None, source_action=None, subnet_selection=None, support_docker_assets=None, synth_action=None, vpc=None)
Bases:
object
(deprecated) Properties for a CdkPipeline.
- Parameters:
cloud_assembly_artifact (
Artifact
) – (deprecated) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.asset_build_spec (
Optional
[BuildSpec
]) – (deprecated) Custom BuildSpec that is merged with generated one (for asset publishing actions). Default: - noneasset_pre_install_commands (
Optional
[Sequence
[str
]]) – (deprecated) Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors. Default: -cdk_cli_version (
Optional
[str
]) – (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 versioncode_pipeline (
Optional
[Pipeline
]) – (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 withrestartExecutionOnUpdate: true
. [disable-awslint:ref-via-interface] Default: - A new CodePipeline is automatically generatedcross_account_keys (
Optional
[bool
]) – (deprecated) Create KMS keys for cross-account deployments. This controls whether the pipeline is enabled for cross-account deployments. Can only be set ifcodePipeline
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 tofalse
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: truedocker_credentials (
Optional
[Sequence
[DockerCredential
]]) – (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: []enable_key_rotation (
Optional
[bool
]) – (deprecated) Enables KMS key rotation for cross-account keys. Cannot be set ifcrossAccountKeys
was set tofalse
. Key rotation costs $1/month when enabled. Default: - false (key rotation is disabled)pipeline_name (
Optional
[str
]) – (deprecated) Name of the pipeline. Can only be set ifcodePipeline
is not set. Default: - A name is automatically generatedself_mutating (
Optional
[bool
]) – (deprecated) Whether the pipeline will update itself. This needs to be set totrue
to allow the pipeline to reconfigure itself when assets or stages are being added to it, andtrue
is the recommended setting. You can temporarily set this tofalse
while you are iterating on the pipeline itself and prefer to deploy changes usingcdk deploy
. Default: trueself_mutation_build_spec (
Optional
[BuildSpec
]) – (deprecated) Custom BuildSpec that is merged with generated one (for self-mutation stage). Default: - nonesingle_publisher_per_type (
Optional
[bool
]) – (deprecated) Whether this pipeline creates one asset upload action per asset type or one asset upload per asset. Default: falsesource_action (
Optional
[IAction
]) – (deprecated) The CodePipeline action used to retrieve the CDK app’s source. Default: - Required unlesscodePipeline
is givensubnet_selection (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – (deprecated) Which subnets to use. Only used if ‘vpc’ is supplied. Default: - All private subnets.support_docker_assets (
Optional
[bool
]) – (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 totrue
, the build step will run in non-privileged mode and consequently will fail with a message like: .. epigraph:: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running? This flag has an effect only ifselfMutating
is alsotrue
. Default: - falsesynth_action (
Optional
[IAction
]) – (deprecated) The CodePipeline action build and synthesis step of the CDK app. Default: - Required unlesscodePipeline
orsourceAction
is givenvpc (
Optional
[IVpc
]) – (deprecated) The VPC where to execute the CdkPipeline actions. Default: - No VPC
- Deprecated:
This class is part of the old API. Use the API based on the
CodePipeline
class instead- Stability:
deprecated
- ExampleMetadata:
infused
Example:
source_artifact = codepipeline.Artifact() cloud_assembly_artifact = codepipeline.Artifact() pipeline = pipelines.CdkPipeline(self, "MyPipeline", cloud_assembly_artifact=cloud_assembly_artifact, synth_action=pipelines.SimpleSynthAction.standard_npm_synth( source_artifact=source_artifact, cloud_assembly_artifact=cloud_assembly_artifact, environment=codebuild.BuildEnvironment( privileged=True ) ) )
Attributes
- asset_build_spec
(deprecated) Custom BuildSpec that is merged with generated one (for asset publishing actions).
- Default:
none
- Stability:
deprecated
- asset_pre_install_commands
(deprecated) Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors.
- Default:
- Stability:
deprecated
- cdk_cli_version
(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
- Stability:
deprecated
- cloud_assembly_artifact
(deprecated) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.
- Stability:
deprecated
- code_pipeline
(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
- Stability:
deprecated
- cross_account_keys
(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
- Stability:
deprecated
- docker_credentials
(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:
[]
- Stability:
deprecated
- enable_key_rotation
(deprecated) Enables KMS key rotation for cross-account keys.
Cannot be set if
crossAccountKeys
was set tofalse
.Key rotation costs $1/month when enabled.
- Default:
false (key rotation is disabled)
- Stability:
deprecated
- pipeline_name
(deprecated) Name of the pipeline.
Can only be set if
codePipeline
is not set.- Default:
A name is automatically generated
- Stability:
deprecated
- self_mutating
(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, andtrue
is the recommended setting.You can temporarily set this to
false
while you are iterating on the pipeline itself and prefer to deploy changes usingcdk deploy
.- Default:
true
- Stability:
deprecated
- self_mutation_build_spec
(deprecated) Custom BuildSpec that is merged with generated one (for self-mutation stage).
- Default:
none
- Stability:
deprecated
- single_publisher_per_type
(deprecated) Whether this pipeline creates one asset upload action per asset type or one asset upload per asset.
- Default:
false
- Stability:
deprecated
- source_action
(deprecated) The CodePipeline action used to retrieve the CDK app’s source.
- Default:
Required unless
codePipeline
is given
- Stability:
deprecated
- subnet_selection
(deprecated) Which subnets to use.
Only used if ‘vpc’ is supplied.
- Default:
All private subnets.
- Stability:
deprecated
- support_docker_assets
(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: .. epigraph: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 alsotrue
.- Default:
false
- Stability:
deprecated
- synth_action
(deprecated) The CodePipeline action build and synthesis step of the CDK app.
- Default:
Required unless
codePipeline
orsourceAction
is given
- Stability:
deprecated
- vpc
(deprecated) The VPC where to execute the CdkPipeline actions.
- Default:
No VPC
- Stability:
deprecated