CodePipelineProps

class aws_cdk.pipelines.CodePipelineProps(*, synth, artifact_bucket=None, asset_publishing_code_build_defaults=None, cli_version=None, code_build_defaults=None, code_pipeline=None, cross_account_keys=None, cross_region_replication_buckets=None, docker_credentials=None, docker_enabled_for_self_mutation=None, docker_enabled_for_synth=None, enable_key_rotation=None, pipeline_name=None, publish_assets_in_parallel=None, reuse_cross_region_support_stacks=None, role=None, self_mutation=None, self_mutation_code_build_defaults=None, synth_code_build_defaults=None, use_change_sets=None)

Bases: object

Properties for a CodePipeline.

Parameters:

  • synth (IFileSetProducer) – 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.

  • artifact_bucket (Optional[IBucket]) – An existing S3 Bucket to use for storing the pipeline’s artifact. Default: - A new S3 bucket will be created.

  • asset_publishing_code_build_defaults (Union[CodeBuildOptions, Dict[str, Any], None]) – Additional customizations to apply to the asset publishing CodeBuild projects. Default: - Only codeBuildDefaults are applied

  • cli_version (Optional[str]) – 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. 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

  • code_build_defaults (Union[CodeBuildOptions, Dict[str, Any], None]) – Customize the CodeBuild projects created for this pipeline. Default: - All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_7_0

  • code_pipeline (Optional[Pipeline]) – An existing Pipeline to be reused and built upon. [disable-awslint:ref-via-interface] Default: - a new underlying pipeline is created.

  • cross_account_keys (Optional[bool]) – 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

  • cross_region_replication_buckets (Optional[Mapping[str, IBucket]]) – A map of region to S3 bucket name used for cross-region CodePipeline. For every Action that you specify targeting a different region than the Pipeline itself, if you don’t provide an explicit Bucket for that region using this property, the construct will automatically create a Stack containing an S3 Bucket in that region. Passed directly through to the {@link cp.Pipeline}. Default: - no cross region replication buckets.

  • docker_credentials (Optional[Sequence[DockerCredential]]) – 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: []

  • docker_enabled_for_self_mutation (Optional[bool]) – 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

  • docker_enabled_for_synth (Optional[bool]) – 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-lib/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

  • enable_key_rotation (Optional[bool]) – Enable KMS key rotation for the generated KMS keys. By default KMS key rotation is disabled, but will add additional costs when enabled. Default: - false (key rotation is disabled)

  • pipeline_name (Optional[str]) – The name of the CodePipeline pipeline. Default: - Automatically generated

  • publish_assets_in_parallel (Optional[bool]) – 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

  • reuse_cross_region_support_stacks (Optional[bool]) – Reuse the same cross region support stack for all pipelines in the App. Default: - true (Use the same support stack for all pipelines in App)

  • role (Optional[IRole]) – The IAM role to be assumed by this Pipeline. Default: - A new role is created

  • self_mutation (Optional[bool]) – 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

  • self_mutation_code_build_defaults (Union[CodeBuildOptions, Dict[str, Any], None]) – Additional customizations to apply to the self mutation CodeBuild projects. Default: - Only codeBuildDefaults are applied

  • synth_code_build_defaults (Union[CodeBuildOptions, Dict[str, Any], None]) – Additional customizations to apply to the synthesize CodeBuild projects. Default: - Only codeBuildDefaults are applied

  • use_change_sets (Optional[bool]) – Deploy every stack by creating a change set and executing it. When enabled, creates a “Prepare” and “Execute” action for each stack. Disable to deploy the stack in one pipeline action. Default: true

ExampleMetadata:

infused

Example:

# code_pipeline: codepipeline.Pipeline


source_artifact = codepipeline.Artifact("MySourceArtifact")

pipeline = pipelines.CodePipeline(self, "Pipeline",
    code_pipeline=code_pipeline,
    synth=pipelines.ShellStep("Synth",
        input=pipelines.CodePipelineFileSet.from_artifact(source_artifact),
        commands=["npm ci", "npm run build", "npx cdk synth"]
    )
)

Attributes

artifact_bucket

An existing S3 Bucket to use for storing the pipeline’s artifact.

Default:

  • A new S3 bucket will be created.

asset_publishing_code_build_defaults

Additional customizations to apply to the asset publishing CodeBuild projects.

Default:

  • Only codeBuildDefaults are applied

cli_version

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.

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

code_build_defaults

Customize the CodeBuild projects created for this pipeline.

Default:

  • All projects run non-privileged build, SMALL instance, LinuxBuildImage.STANDARD_7_0

code_pipeline

An existing Pipeline to be reused and built upon.

[disable-awslint:ref-via-interface]

Default:

  • a new underlying pipeline is created.

cross_account_keys

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

cross_region_replication_buckets

A map of region to S3 bucket name used for cross-region CodePipeline.

For every Action that you specify targeting a different region than the Pipeline itself, if you don’t provide an explicit Bucket for that region using this property, the construct will automatically create a Stack containing an S3 Bucket in that region. Passed directly through to the {@link cp.Pipeline}.

Default:

  • no cross region replication buckets.

docker_credentials

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:

[]

docker_enabled_for_self_mutation

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

docker_enabled_for_synth

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-lib/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

enable_key_rotation

Enable KMS key rotation for the generated KMS keys.

By default KMS key rotation is disabled, but will add additional costs when enabled.

Default:

  • false (key rotation is disabled)

pipeline_name

The name of the CodePipeline pipeline.

Default:

  • Automatically generated

publish_assets_in_parallel

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

reuse_cross_region_support_stacks

Reuse the same cross region support stack for all pipelines in the App.

Default:

  • true (Use the same support stack for all pipelines in App)

role

The IAM role to be assumed by this Pipeline.

Default:

  • A new role is created

self_mutation

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

self_mutation_code_build_defaults

Additional customizations to apply to the self mutation CodeBuild projects.

Default:

  • Only codeBuildDefaults are applied

synth

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.

synth_code_build_defaults

Additional customizations to apply to the synthesize CodeBuild projects.

Default:

  • Only codeBuildDefaults are applied

use_change_sets

Deploy every stack by creating a change set and executing it.

When enabled, creates a “Prepare” and “Execute” action for each stack. Disable to deploy the stack in one pipeline action.

Default:

true