Package: aws-cdk.pipelines
CDK Pipelines---AWS CDK v1 has reached End-of-Support on 2023-06-01.
This package is no longer being updated, and users should migrate to AWS CDK v2.For more information on how to migrate, see theMigrating to AWS CDK v2guide.A construct library for painless Continuous Delivery of CDK applications.CDK Pipelines is anopinionated construct library. It is purpose-built to
deploy one or more copies of your CDK applications using CloudFormation with a
minimal amount of effort on your part. It isnotintended to support arbitrary
deployment pipelines, and very specifically it is not built to use CodeDeploy to
applications to instances, or deploy your custom-built ECR images to an ECS
cluster directly: use CDK file assets with CloudFormation Init for instances, or
CDK container assets for ECS clusters instead.Give the CDK Pipelines way of doing things a shot first: you might find it does
everything you need. If you want or need more control, we recommend you drop
down to using theaws-codepipelineconstruct library directly.This module contains two sets of APIs: anoriginaland amodernversion of
CDK Pipelines. ThemodernAPI has been updated to be easier to work with and
customize, and will be the preferred API going forward. Theoriginalversion
of the API is still available for backwards compatibility, but we recommend migrating
to the new version if possible.Compared to the original API, the modern API: has more sensible defaults; is
more flexible; supports parallel deployments; supports multiple synth inputs;
allows more control of CodeBuild project generation; supports deployment
engines other than CodePipeline.The README for the original API, as well as a migration guide, can be found inour GitHub repository.At a glanceDeploying your application continuously starts by defining aMyApplicationStage, a subclass ofStagethat contains the stacks that make
up a single copy of your application.You then define aPipeline, instantiate as many instances ofMyApplicationStageas you want for your test and production environments, with
different parameters for each, and callingpipeline.addStage()for each of
them. You can deploy to the same account and Region, or to a different one,
with the same amount of code. TheCDK Pipelineslibrary takes care of the
details.CDK Pipelines supports multipledeployment engines(seeUsing a different deployment engine),
and comes with a deployment engine that deploys CDK apps using AWS CodePipeline.
To use the CodePipeline engine, define aCodePipelineconstruct.  The following
example creates a CodePipeline that deploys an application from GitHub:# The stacks for our app are minimally defined here.  The internals of these# stacks aren't important, except that DatabaseStack exposes an attribute# "table" for a database table it defines, and ComputeStack accepts a reference# to this table in its properties.#classDatabaseStack(Stack):def__init__(self,scope,id):super().__init__(scope,id)self.table=dynamodb.Table(self,"Table",partition_key=dynamodb.Attribute(name="id",type=dynamodb.AttributeType.STRING))classComputeStack(Stack):def__init__(self,scope,id,*,table):super().__init__(scope,id)## Stack to hold the pipeline#classMyPipelineStack(Stack):def__init__(self,scope,id,*,description=None,env=None,stackName=None,tags=None,synthesizer=None,terminationProtection=None,analyticsReporting=None):super().__init__(scope,id,description=description,env=env,stackName=stackName,tags=tags,synthesizer=synthesizer,terminationProtection=terminationProtection,analyticsReporting=analyticsReporting)pipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",# Use a connection created using the AWS console to authenticate to GitHub# Other sources are available.input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]))# 'MyApplication' is defined below. Call `addStage` as many times as# necessary with any account and region (may be different from the# pipeline's).pipeline.add_stage(MyApplication(self,"Prod",env=cdk.Environment(account="123456789012",region="eu-west-1")))## Your application## May consist of one or more Stacks (here, two)## By declaring our DatabaseStack and our ComputeStack inside a Stage,# we make sure they are deployed together, or not at all.#classMyApplication(Stage):def__init__(self,scope,id,*,env=None,outdir=None):super().__init__(scope,id,env=env,outdir=outdir)db_stack=DatabaseStack(self,"Database")ComputeStack(self,"Compute",table=db_stack.table)# In your main fileMyPipelineStack(self,"PipelineStack",env=cdk.Environment(account="123456789012",region="eu-west-1"))The pipeline isself-mutating, which means that if you add new
application stages in the source code, or new stacks toMyApplication, the
pipeline will automatically reconfigure itself to deploy those new stages and
stacks.(Note that you have tobootstrapall environments before the above code
will work, and switch on "Modern synthesis" if you are using
CDKv1. See the sectionCDK Environment Bootstrappingbelow for
more information).Provisioning the pipelineTo provision the pipeline you have defined, make sure the target environment
has been bootstrapped (see below), and then execute deploying thePipelineStackonce. Afterwards, the pipeline will keep itself up-to-date.Important: be sure togit commitandgit pushbefore deploying the
Pipeline stack usingcdk deploy!The reason is that the pipeline will start deploying and self-mutating
right away based on the sources in the repository, so the sources it finds
in there should be the ones you want it to find.Run the following commands to get the pipeline going:$gitcommit-a$gitpush$cdkdeployPipelineStackAdministrative permissions to the account are only necessary up until
this point. We recommend you remove access to these credentials after doing this.Working on the pipelineThe self-mutation feature of the Pipeline might at times get in the way
of the pipeline development workflow. Each change to the pipeline must be pushed
to git, otherwise, after the pipeline was updated usingcdk deploy, it will
automatically revert to the state found in git.To make the development more convenient, the self-mutation feature can be turned
off temporarily, by passingselfMutation: falseproperty, example:# Modern APImodern_pipeline=pipelines.CodePipeline(self,"Pipeline",self_mutation=False,synth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]))# Original APIcloud_assembly_artifact=codepipeline.Artifact()original_pipeline=pipelines.CdkPipeline(self,"Pipeline",self_mutating=False,cloud_assembly_artifact=cloud_assembly_artifact)Definining the pipelineThis section of the documentation describes the AWS CodePipeline engine,
which comes with this library. If you want to use a different deployment
engine, read the sectionUsing a different deployment enginebelow.Synth and sourcesTo define a pipeline, instantiate aCodePipelineconstruct from the@aws-cdk/pipelinesmodule. It takes one argument, asynthstep, which is
expected to produce the CDK Cloud Assembly as its single output (the contents of
thecdk.outdirectory after runningcdk synth). "Steps" are arbitrary
actions in the pipeline, typically used to run scripts or commands.For the synth, use aShellStepand specify the commands necessary to install
dependencies, the CDK CLI, build your project and runcdk synth; the specific
commands required will depend on the programming language you are using. For a
typical NPM-based project, the synth will look like this:# source: pipelines.IFileSetProducer# the repository sourcepipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=source,commands=["npm ci","npm run build","npx cdk synth"]))The pipeline assumes that yourShellStepwill produce acdk.outdirectory in the root, containing the CDK cloud assembly. If your
CDK project lives in a subdirectory, be sure to adjust theprimaryOutputDirectoryto match:# source: pipelines.IFileSetProducer# the repository sourcepipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=source,commands=["cd mysubdir","npm ci","npm run build","npx cdk synth"],primary_output_directory="mysubdir/cdk.out"))The underlying@aws-cdk/aws-codepipeline.Pipelineconstruct will be produced
whenapp.synth()is called. You can also force it to be produced
earlier by callingpipeline.buildPipeline(). After you've called
that method, you can inspect the constructs that were produced by
accessing the properties of thepipelineobject.Commands for other languages and package managersThe commands you pass tonew ShellStepwill be very similar to the commands
you run on your own workstation to install dependencies and synth your CDK
project. Here are some (non-exhaustive) examples for what those commands might
look like in a number of different situations.For Yarn, the install commands are different:# source: pipelines.IFileSetProducer# the repository sourcepipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=source,commands=["yarn install --frozen-lockfile","yarn build","npx cdk synth"]))For Python projects, remember to install the CDK CLI globally (as
there is nopackage.jsonto automatically install it for you):# source: pipelines.IFileSetProducer# the repository sourcepipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=source,commands=["pip install -r requirements.txt","npm install -g aws-cdk","cdk synth"]))For Java projects, remember to install the CDK CLI globally (as
there is nopackage.jsonto automatically install it for you),
and the Maven compilation step is automatically executed for you
as you runcdk synth:# source: pipelines.IFileSetProducer# the repository sourcepipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=source,commands=["npm install -g aws-cdk","cdk synth"]))You can adapt these examples to your own situation.Migrating from buildspec.yml filesYou may currently have the build instructions for your CodeBuild Projects in abuildspec.ymlfile in your source repository. In addition to your build
commands, the CodeBuild Project's buildspec also controls some information that
CDK Pipelines manages for you, like artifact identifiers, input artifact
locations, Docker authorization, and exported variables.Since there is no way in general for CDK Pipelines to modify the file in your
resource repository, CDK Pipelines configures the BuildSpec directly on the
CodeBuild Project, instead of loading it from thebuildspec.ymlfile.
This requires a pipeline self-mutation to update.To avoid this, put your build instructions in a separate script, for examplebuild.sh, and call that script from the buildcommandsarray:# source: pipelines.IFileSetProducerpipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=source,commands=["./build.sh"]))Doing so keeps your exact build instructions in sync with your source code in
the source repository where it belongs, and provides a convenient build script
for developers at the same time.CodePipeline SourcesIn CodePipeline,Sourcesdefine where the source of your application lives.
When a change to the source is detected, the pipeline will start executing.
Source objects can be created by factory methods on theCodePipelineSourceclass:GitHub, GitHub Enterprise, BitBucket using a connectionThe recommended way of connecting to GitHub or BitBucket is by using aconnection.
You will first use the AWS Console to authenticate to the source control
provider, and then use the connection ARN in your pipeline definition:pipelines.CodePipelineSource.connection("org/repo","branch",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")GitHub using OAuthYou can also authenticate to GitHub using a personal access token. This expects
that you've created a personal access token and stored it in Secrets Manager.
By default, the source object will look for a secret namedgithub-token, but
you can change the name. The token should have therepoandadmin:repo_hookscopes.pipelines.CodePipelineSource.git_hub("org/repo","branch",# This is optionalauthentication=cdk.SecretValue.secrets_manager("my-token"))CodeCommitYou can use a CodeCommit repository as the source. Either create or import
that the CodeCommit repository and then useCodePipelineSource.codeCommitto reference it:repository=codecommit.Repository.from_repository_name(self,"Repository","my-repository")pipelines.CodePipelineSource.code_commit(repository,"main")S3You can use a zip file in S3 as the source of the pipeline. The pipeline will be
triggered every time the file in S3 is changed:bucket=s3.Bucket.from_bucket_name(self,"Bucket","my-bucket")pipelines.CodePipelineSource.s3(bucket,"my/source.zip")ECRYou can use a Docker image in ECR as the source of the pipeline. The pipeline will be
triggered every time an image is pushed to ECR:repository=ecr.Repository(self,"Repository")pipelines.CodePipelineSource.ecr(repository)Additional inputsShellStepallows passing in more than one input: additional
inputs will be placed in the directories you specify. Any step that produces an
output file set can be used as an input, such as aCodePipelineSource, but
also otherShellStep:prebuild=pipelines.ShellStep("Prebuild",input=pipelines.CodePipelineSource.git_hub("myorg/repo1","main"),primary_output_directory="./build",commands=["./build.sh"])pipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.git_hub("myorg/repo2","main"),additional_inputs={"subdir":pipelines.CodePipelineSource.git_hub("myorg/repo3","main"),"../siblingdir":prebuild},commands=["./build.sh"]))CDK application deploymentsAfter you have defined the pipeline and thesynthstep, you can add one or
more CDKStageswhich will be deployed to their target environments. To do
so, callpipeline.addStage()on the Stage object:# pipeline: pipelines.CodePipeline# Do this as many times as necessary with any account and region# Account and region may different from the pipeline's.pipeline.add_stage(MyApplicationStage(self,"Prod",env=cdk.Environment(account="123456789012",region="eu-west-1")))CDK Pipelines will automatically discover allStacksin the givenStageobject, determine their dependency order, and add appropriate actions to the
pipeline to publish the assets referenced in those stacks and deploy the stacks
in the right order.If theStacksare targeted at an environment in a different AWS account or
Region and that environment has beenbootstrapped, CDK Pipelines will transparently make sure the IAM roles are set up
correctly and any requisite replication Buckets are created.Deploying in parallelBy default, all applications added to CDK Pipelines by callingaddStage()will
be deployed in sequence, one after the other. If you have a lot of stages, you can
speed up the pipeline by choosing to deploy some stages in parallel. You do this
by callingaddWave()instead ofaddStage(): awaveis a set of stages that
are all deployed in parallel instead of sequentially. Waves themselves are still
deployed in sequence. For example, the following will deploy two copies of your
application toeu-west-1andeu-central-1in parallel:# pipeline: pipelines.CodePipelineeurope_wave=pipeline.add_wave("Europe")europe_wave.add_stage(MyApplicationStage(self,"Ireland",env=cdk.Environment(region="eu-west-1")))europe_wave.add_stage(MyApplicationStage(self,"Germany",env=cdk.Environment(region="eu-central-1")))Deploying to other accounts / encrypting the Artifact BucketCDK Pipelines can transparently deploy to other Regions and other accounts
(provided those target environments have beenbootstrapped).
However, deploying to another account requires one additional piece of
configuration: you need to enablecrossAccountKeys: truewhen creating the
pipeline.This will encrypt the artifact bucket(s), but incurs a cost for maintaining the
KMS key.Example:pipeline=pipelines.CodePipeline(self,"Pipeline",# Encrypt artifacts, required for cross-account deploymentscross_account_keys=True,synth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]))ValidationEveryaddStage()andaddWave()command takes additional options. As part of these options,
you can specifypreandpoststeps, which are arbitrary steps that run before or after
the contents of the stage or wave, respectively. You can use these to add validations like
manual or automated gates to your pipeline. We recommend putting manual approval gates in the set ofpresteps, and automated approval gates in
the set ofpoststeps.The following example shows both an automated approval in the form of aShellStep, and
a manual approval in the form of aManualApprovalStepadded to the pipeline. Both must
pass in order to promote from thePreProdto theProdenvironment:# pipeline: pipelines.CodePipelinepreprod=MyApplicationStage(self,"PreProd")prod=MyApplicationStage(self,"Prod")pipeline.add_stage(preprod,post=[pipelines.ShellStep("Validate Endpoint",commands=["curl -Ssf https://my.webservice.com/"])])pipeline.add_stage(prod,pre=[pipelines.ManualApprovalStep("PromoteToProd")])You can also specify steps to be executed at the stack level. To achieve this, you can specify the stack and step via thestackStepsproperty:# pipeline: pipelines.CodePipelineclassMyStacksStage(Stage):def__init__(self,scope,id,*,env=None,outdir=None):super().__init__(scope,id,env=env,outdir=outdir)self.stack1=Stack(self,"stack1")self.stack2=Stack(self,"stack2")prod=MyStacksStage(self,"Prod")pipeline.add_stage(prod,stack_steps=[pipelines.StackSteps(stack=prod.stack1,pre=[pipelines.ManualApprovalStep("Pre-Stack Check")],# Executed before stack is preparedchange_set=[pipelines.ManualApprovalStep("ChangeSet Approval")],# Executed after stack is prepared but before the stack is deployedpost=[pipelines.ManualApprovalStep("Post-Deploy Check")]),pipelines.StackSteps(stack=prod.stack2,post=[pipelines.ManualApprovalStep("Post-Deploy Check")])])If you specify multiple steps, they will execute in parallel by default. You can add dependencies between them
to if you wish to specify an order. To add a dependency, callstep.addStepDependency():first_step=pipelines.ManualApprovalStep("A")second_step=pipelines.ManualApprovalStep("B")second_step.add_step_dependency(first_step)For convenience,Step.sequence()will take an array of steps and dependencies between adjacent steps,
so that the whole list executes in order:# Step A will depend on step B and step B will depend on step Cordered_steps=pipelines.Step.sequence([pipelines.ManualApprovalStep("A"),pipelines.ManualApprovalStep("B"),pipelines.ManualApprovalStep("C")])Using CloudFormation Stack Outputs in approvalsBecause many CloudFormation deployments result in the generation of resources with unpredictable
names, validations have support for reading back CloudFormation Outputs after a deployment. This
makes it possible to pass (for example) the generated URL of a load balancer to the test set.To use Stack Outputs, expose theCfnOutputobject you're interested in, and
pass it toenvFromCfnOutputsof theShellStep:# pipeline: pipelines.CodePipelineclassMyOutputStage(Stage):def__init__(self,scope,id,*,env=None,outdir=None):super().__init__(scope,id,env=env,outdir=outdir)self.load_balancer_address=CfnOutput(self,"Output",value="value")lb_app=MyOutputStage(self,"MyApp")pipeline.add_stage(lb_app,post=[pipelines.ShellStep("HitEndpoint",env_from_cfn_outputs={# Make the load balancer address available as $URL inside the commands"URL":lb_app.load_balancer_address},commands=["curl -Ssf $URL"])])Running scripts compiled during the synth stepAs part of a validation, you probably want to run a test suite that's more
elaborate than what can be expressed in a couple of lines of shell script.
You can bring additional files into the shell script validation by supplying
theinputoradditionalInputsproperty ofShellStep. The input can
be produced by theSynthstep, or come from a source or any other build
step.Here's an example that captures an additional output directory in the synth
step and runs tests from there:# synth: pipelines.ShellStepstage=MyApplicationStage(self,"MyApplication")pipeline=pipelines.CodePipeline(self,"Pipeline",synth=synth)pipeline.add_stage(stage,post=[pipelines.ShellStep("Approve",# Use the contents of the 'integ' directory from the synth step as the inputinput=synth.add_output_directory("integ"),commands=["cd integ && ./run.sh"])])Customizing CodeBuild ProjectsCDK pipelines will generate CodeBuild projects for eachShellStepyou use, and it
will also generate CodeBuild projects to publish assets and perform the self-mutation
of the pipeline. To control the various aspects of the CodeBuild projects that get
generated, use aCodeBuildStepinstead of aShellStep. This class has a number
of properties that allow you to customize various aspects of the projects:# vpc: ec2.Vpc# my_security_group: ec2.SecurityGrouppipelines.CodeBuildStep("Synth",# ...standard ShellStep props...commands=[],env={},# If you are using a CodeBuildStep explicitly, set the 'cdk.out' directory# to be the synth step's output.primary_output_directory="cdk.out",# Control the name of the projectproject_name="MyProject",# Control parts of the BuildSpec other than the regular 'build' and 'install' commandspartial_build_spec=codebuild.BuildSpec.from_object({"version":"0.2"}),# Control the build environmentbuild_environment=codebuild.BuildEnvironment(compute_type=codebuild.ComputeType.LARGE),timeout=Duration.minutes(90),# Control Elastic Network Interface creationvpc=vpc,subnet_selection=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_WITH_NAT),security_groups=[my_security_group],# Additional policy statements for the execution rolerole_policy_statements=[iam.PolicyStatement()])You can also configure defaults forallCodeBuild projects by passingcodeBuildDefaults,
or just for the synth, asset publishing, and self-mutation projects by passingsynthCodeBuildDefaults,assetPublishingCodeBuildDefaults, orselfMutationCodeBuildDefaults:# vpc: ec2.Vpc# my_security_group: ec2.SecurityGrouppipelines.CodePipeline(self,"Pipeline",# Standard CodePipeline propertiessynth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]),# Defaults for all CodeBuild projectscode_build_defaults=pipelines.CodeBuildOptions(# Prepend commands and configuration to all projectspartial_build_spec=codebuild.BuildSpec.from_object({"version":"0.2"}),# Control the build environmentbuild_environment=codebuild.BuildEnvironment(compute_type=codebuild.ComputeType.LARGE),# Control Elastic Network Interface creationvpc=vpc,subnet_selection=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_WITH_NAT),security_groups=[my_security_group],# Additional policy statements for the execution rolerole_policy=[iam.PolicyStatement()]),synth_code_build_defaults=pipelines.CodeBuildOptions(),asset_publishing_code_build_defaults=pipelines.CodeBuildOptions(),self_mutation_code_build_defaults=pipelines.CodeBuildOptions())Arbitrary CodePipeline actionsIf you want to add a type of CodePipeline action to the CDK Pipeline that
doesn't have a matching class yet, you can define your own step class that extendsStepand implementsICodePipelineActionFactory.Here's an example that adds a Jenkins step:classMyJenkinsStep(pipelines.Steppipelines.ICodePipelineActionFactory):def__init__(self,provider,input):super().__init__("MyJenkinsStep")# This is necessary if your step accepts parametres, like environment variables,# that may contain outputs from other steps. It doesn't matter what the# structure is, as long as it contains the values that may contain outputs.self.discover_referenced_outputs({"env":{}})defproduce_action(self,stage,*,scope,actionName,runOrder,variablesNamespace=None,artifacts,fallbackArtifact=None,pipeline,codeBuildDefaults=None,beforeSelfMutation=None):# This is where you control what type of Action gets added to the# CodePipelinestage.add_action(cpactions.JenkinsAction(# Copy 'actionName' and 'runOrder' from the optionsaction_name=action_name,run_order=run_order,# Jenkins-specific configurationtype=cpactions.JenkinsActionType.TEST,jenkins_provider=self.provider,project_name="MyJenkinsProject",# Translate the FileSet into a codepipeline.Artifactinputs=[artifacts.to_code_pipeline(self.input)]))returnpipelines.CodePipelineActionFactoryResult(run_orders_consumed=1)Using Docker in the pipelineDocker can be used in 3 different places in the pipeline:If you are using Docker image assets in your application stages: Docker will
run in the asset publishing projects.If you are using Docker image assets in your stack (for example as
images for your CodeBuild projects): Docker will run in the self-mutate project.If you are using Docker to bundle file assets anywhere in your project (for
example, if you are using such construct libraries as@aws-cdk/aws-lambda-nodejs): Docker will run in thesynthproject.For the first case, you don't need to do anything special. For the other two cases,
you need to make sure thatprivileged modeis enabled on the correct CodeBuild
projects, so that Docker can run correctly. The follow sections describe how to do
that.You may also need to authenticate to Docker registries to avoid being throttled.
See the sectionAuthenticating to Docker registriesbelow for information on how to do
that.Using Docker image assets in the pipelineIf yourPipelineStackis using Docker image assets (as opposed to the application
stacks the pipeline is deploying), for example by the use ofLinuxBuildImage.fromAsset(),
you need to passdockerEnabledForSelfMutation: trueto the pipeline. For example:pipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]),# Turn this on because the pipeline uses Docker image assetsdocker_enabled_for_self_mutation=True)pipeline.add_wave("MyWave",post=[pipelines.CodeBuildStep("RunApproval",commands=["command-from-image"],build_environment=codebuild.BuildEnvironment(# The user of a Docker image asset in the pipeline requires turning on# 'dockerEnabledForSelfMutation'.build_image=codebuild.LinuxBuildImage.from_asset(self,"Image",directory="./docker-image")))])Important: You must turn on thedockerEnabledForSelfMutationflag,
commit and allow the pipeline to self-updatebeforeadding the actual
Docker asset.Using bundled file assetsIf you are using asset bundling anywhere (such as automatically done for you
if you add a construct like@aws-cdk/aws-lambda-nodejs), you need to passdockerEnabledForSynth: trueto the pipeline. For example:pipeline=pipelines.CodePipeline(self,"Pipeline",synth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]),# Turn this on because the application uses bundled file assetsdocker_enabled_for_synth=True)Important: You must turn on thedockerEnabledForSynthflag,
commit and allow the pipeline to self-updatebeforeadding the actual
Docker asset.Authenticating to Docker registriesYou can specify credentials to use for authenticating to Docker registries as part of the
pipeline definition. This can be useful if any Docker image assets — in the pipeline or
any of the application stages — require authentication, either due to being in a
different environment (e.g., ECR repo) or to avoid throttling (e.g., DockerHub).docker_hub_secret=secretsmanager.Secret.from_secret_complete_arn(self,"DHSecret","arn:aws:...")custom_reg_secret=secretsmanager.Secret.from_secret_complete_arn(self,"CRSecret","arn:aws:...")repo1=ecr.Repository.from_repository_arn(self,"Repo","arn:aws:ecr:eu-west-1:0123456789012:repository/Repo1")repo2=ecr.Repository.from_repository_arn(self,"Repo","arn:aws:ecr:eu-west-1:0123456789012:repository/Repo2")pipeline=pipelines.CodePipeline(self,"Pipeline",docker_credentials=[pipelines.DockerCredential.docker_hub(docker_hub_secret),pipelines.DockerCredential.custom_registry("dockerregistry.example.com",custom_reg_secret),pipelines.DockerCredential.ecr([repo1,repo2])],synth=pipelines.ShellStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["npm ci","npm run build","npx cdk synth"]))For authenticating to Docker registries that require a username and password combination
(like DockerHub), create a Secrets Manager Secret with fields namedusernameandsecret, and import it (the field names change be customized).Authentication to ECR repostories is done using the execution role of the
relevant CodeBuild job. Both types of credentials can be provided with an
optional role to assume before requesting the credentials.By default, the Docker credentials provided to the pipeline will be available to
theSynth,Self-Update, andAsset Publishingactions within the
*pipeline. The scope of the credentials can be limited via theDockerCredentialUsageoption.docker_hub_secret=secretsmanager.Secret.from_secret_complete_arn(self,"DHSecret","arn:aws:...")# Only the image asset publishing actions will be granted read access to the secret.creds=pipelines.DockerCredential.docker_hub(docker_hub_secret,usages=[pipelines.DockerCredentialUsage.ASSET_PUBLISHING])CDK Environment BootstrappingAnenvironmentis an(account, region)pair where you want to deploy a
CDK stack (seeEnvironmentsin the CDK Developer Guide). In a Continuous Deployment pipeline, there are
at least two environments involved: the environment where the pipeline is
provisioned, and the environment where you want to deploy the application (or
different stages of the application). These can be the same, though best
practices recommend you isolate your different application stages from each
other in different AWS accounts or regions.Before you can provision the pipeline, you have tobootstrapthe environment you want
to create it in. If you are deploying your application to different environments, you
also have to bootstrap those and be sure to add atrustrelationship.After you have bootstrapped an environment and created a pipeline that deploys
to it, it's important that you don't delete the stack or change itsQualifier,
or future deployments to this environment will fail. If you want to upgrade
the bootstrap stack to a newer version, do that by updating it in-place.This library requires themodernbootstrapping stack which has
been updated specifically to support cross-account continuous delivery.If you are using CDKv2, you do not need to do anything else. Modern
bootstrapping and modern stack synthesis (also known as "default stack
synthesis") is the default.If you are using CDKv1, you need to opt in to modern bootstrapping and
modern stack synthesis using a feature flag. Make surecdk.jsonincludes:{"context":{"@aws-cdk/core:newStyleStackSynthesis":true}}And be sure to runcdk bootstrapin the same directory as thecdk.jsonfile.To bootstrap an environment for provisioning the pipeline:$npxcdkbootstrap\[--profileadmin-profile-1]\--cloudformation-execution-policiesarn:aws:iam::aws:policy/AdministratorAccess\aws://111111111111/us-east-1To bootstrap a different environment for deploying CDK applications into using
a pipeline in account111111111111:$npxcdkbootstrap\[--profileadmin-profile-2]\--cloudformation-execution-policiesarn:aws:iam::aws:policy/AdministratorAccess\--trust11111111111\aws://222222222222/us-east-2If you only want to trust an account to do lookups (e.g, when your CDK application has aVpc.fromLookup()call), use the option--trust-for-lookup:$npxcdkbootstrap\[--profileadmin-profile-2]\--cloudformation-execution-policiesarn:aws:iam::aws:policy/AdministratorAccess\--trust-for-lookup11111111111\aws://222222222222/us-east-2These command lines explained:npx: means to use the CDK CLI from the current NPM install. If you are using
a global install of the CDK CLI, leave this out.--profile: should indicate a profile with administrator privileges that has
permissions to provision a pipeline in the indicated account. You can leave this
flag out if either the AWS default credentials or theAWS_*environment
variables confer these permissions.--cloudformation-execution-policies: ARN of the managed policy that future CDK
deployments should execute with. By default this isAdministratorAccess, but
if you also specify the--trustflag to give another Account permissions to
deploy into the current account, you must specify a value here.--trust: indicates which other account(s) should have permissions to deploy
CDK applications into this account. In this case we indicate the Pipeline's account,
but you could also use this for developer accounts (don't do that for production
application accounts though!).--trust-for-lookup: gives a more limited set of permissions to the
trusted account, only allowing it to look up values such as availability zones, EC2 images and
VPCs.--trust-for-lookupdoes not give permissions to modify anything in the account.
Note that--trustimplies--trust-for-lookup, so you don't need to specify
the same acocunt twice.aws://222222222222/us-east-2: the account and region we're bootstrapping.Be aware that anyone who has access to the trusted Accountseffectively has all
permissions conferred by the configured CloudFormation execution policies,
allowing them to do things like read arbitrary S3 buckets and create arbitrary
infrastructure in the bootstrapped account.  Restrict the list of--trusted Accounts,
or restrict the policies configured by--cloudformation-execution-policies.Security tip: we recommend that you use administrative credentials to an
account only to bootstrap it and provision the initial pipeline. Otherwise,
access to administrative credentials should be dropped as soon as possible.On the use of AdministratorAccess: The use of theAdministratorAccesspolicy
ensures that your pipeline can deploy every type of AWS resource to your account.
Make sure you trust all the code and dependencies that make up your CDK app.
Check with the appropriate department within your organization to decide on the
proper policy to use.If your policy includes permissions to create on attach permission to a role,
developers can escalate their privilege with more permissive permission.
Thus, we recommend implementingpermissions boundaryin the CDK Execution role. To do this, you can bootstrap with the--templateoption witha customized templatethat contains a permission boundary.Migrating from old bootstrap stackThe bootstrap stack is a CloudFormation stack in your account namedCDKToolkitthat provisions a set of resources required for the CDK
to deploy into that environment.The "new" bootstrap stack (obtained by runningcdk bootstrapwithCDK_NEW_BOOTSTRAP=1) is slightly more elaborate than the "old" stack. It
contains:An S3 bucket and ECR repository with predictable names, so that we can reference
assets in these storage locationswithoutthe use of CloudFormation template
parameters.A set of roles with permissions to access these asset locations and to execute
CloudFormation, assumable from whatever accounts you specify under--trust.It is possible and safe to migrate from the old bootstrap stack to the new
bootstrap stack. This will create a new S3 file asset bucket in your account
and orphan the old bucket. You should manually delete the orphaned bucket
after you are sure you have redeployed all CDK applications and there are no
more references to the old asset bucket.Context LookupsYou might be using CDK constructs that need to look upruntime
context,
which is information from the target AWS Account and Region the CDK needs to
synthesize CloudFormation templates appropriate for that environment. Examples
of this kind of context lookups are the number of Availability Zones available
to you, a Route53 Hosted Zone ID, or the ID of an AMI in a given region. This
information is automatically looked up when you runcdk synth.By default, acdk synthperformed in a pipeline will not have permissions
to perform these lookups, and the lookups will fail. This is by design.Our recommended way of using lookupsis by runningcdk synthon the
developer workstation and checking in thecdk.context.jsonfile, which
contains the results of the context lookups. This will make sure your
synthesized infrastructure is consistent and repeatable. If you do not commitcdk.context.json, the results of the lookups may suddenly be different in
unexpected ways, and even produce results that cannot be deployed or will cause
data loss.  To give an account permissions to perform lookups against an
environment, without being able to deploy to it and make changes, runcdk bootstrap --trust-for-lookup=<account>.If you want to use lookups directly from the pipeline, you either need to accept
the risk of nondeterminism, or make sure you save and load thecdk.context.jsonfile somewhere between synth runs. Finally, you should
give the synth CodeBuild execution role permissions to assume the bootstrapped
lookup roles. As an example, doing so would look like this:pipelines.CodePipeline(self,"Pipeline",synth=pipelines.CodeBuildStep("Synth",input=pipelines.CodePipelineSource.connection("my-org/my-app","main",connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),commands=["...","npm ci","npm run build","npx cdk synth","..."],role_policy_statements=[iam.PolicyStatement(actions=["sts:AssumeRole"],resources=["*"],conditions={"StringEquals":{"iam:ResourceTag/aws-cdk:bootstrap-role":"lookup"}})]))The above example requires that the target environments have all
been bootstrapped with bootstrap stack version8, released with
CDK CLI1.114.0.Security ConsiderationsIt's important to stay safe while employing Continuous Delivery. The CDK Pipelines
library comes with secure defaults to the best of our ability, but by its
very nature the library cannot take care of everything.We therefore expect you to mind the following:Maintain dependency hygiene and vet 3rd-party software you use. Any software you
run on your build machine has the ability to change the infrastructure that gets
deployed. Be careful with the software you depend on.Use dependency locking to prevent accidental upgrades! The defaultCdkSynthsthat
come with CDK Pipelines will expectpackage-lock.jsonandyarn.lockto
ensure your dependencies are the ones you expect.Credentials to production environments should be short-lived. After
bootstrapping and the initial pipeline provisioning, there is no more need for
developers to have access to any of the account credentials; all further
changes can be deployed through git. Avoid the chances of credentials leaking
by not having them in the first place!Confirm permissions broadeningTo keep tabs on the security impact of changes going out through your pipeline,
you can insert a security check before any stage deployment. This security check
will check if the upcoming deployment would add any new IAM permissions or
security group rules, and if so pause the pipeline and require you to confirm
the changes.The security check will appear as two distinct actions in your pipeline: first
a CodeBuild project that runscdk diffon the stage that's about to be deployed,
followed by a Manual Approval action that pauses the pipeline. If it so happens
that there no new IAM permissions or security group rules will be added by the deployment,
the manual approval step is automatically satisfied. The pipeline will look like this:Pipeline
├── ...
├── MyApplicationStage
│    ├── MyApplicationSecurityCheck       // Security Diff Action
│    ├── MyApplicationManualApproval      // Manual Approval Action
│    ├── Stack.Prepare
│    └── Stack.Deploy
└── ...You can insert the security check by using aConfirmPermissionsBroadeningstep:# pipeline: pipelines.CodePipelinestage=MyApplicationStage(self,"MyApplication")pipeline.add_stage(stage,pre=[pipelines.ConfirmPermissionsBroadening("Check",stage=stage)])To get notified when there is a change that needs your manual approval,
create an SNS Topic, subscribe your own email address, and pass it in as
as thenotificationTopicproperty:# pipeline: pipelines.CodePipelinetopic=sns.Topic(self,"SecurityChangesTopic")topic.add_subscription(subscriptions.EmailSubscription("test@email.com"))stage=MyApplicationStage(self,"MyApplication")pipeline.add_stage(stage,pre=[pipelines.ConfirmPermissionsBroadening("Check",stage=stage,notification_topic=topic)])Note: Manual Approvals notifications only apply when an application has security
check enabled.Using a different deployment engineCDK Pipelines supports multipledeployment engines, but this module vends a
construct for only one such engine: AWS CodePipeline. It is also possible to
use CDK Pipelines to build pipelines backed by other deployment engines.Here is a list of CDK Libraries that integrate CDK Pipelines with
alternative deployment engines:GitHub Workflows:cdk-pipelines-githubTroubleshootingHere are some common errors you may encounter while using this library.Pipeline: Internal FailureIf you see the following error during deployment of your pipeline:CREATE_FAILED  | AWS::CodePipeline::Pipeline | Pipeline/Pipeline
Internal FailureThere's something wrong with your GitHub access token. It might be missing, or not have the
right permissions to access the repository you're trying to access.Key: Policy contains a statement with one or more invalid principalsIf you see the following error during deployment of your pipeline:CREATE_FAILED | AWS::KMS::Key | Pipeline/Pipeline/ArtifactsBucketEncryptionKey
Policy contains a statement with one or more invalid principals.One of the target (account, region) environments has not been bootstrapped
with the new bootstrap stack. Check your target environments and make sure
they are all bootstrapped.Message: no matching base directory path found for cdk.outIf you see this error during theSynthstep, it means that CodeBuild
is expecting to find acdk.outdirectory in the root of your CodeBuild project,
but the directory wasn't there. There are two common causes for this:cdk synthis not being executed:cdk synthused to be run
implicitly for you, but you now have to explicitly include the command.
For NPM-based projects, addnpx cdk synthto the end of thecommandsproperty, for other languages addnpm install -g aws-cdkandcdk synth.Your CDK project lives in a subdirectory: you added acd <somedirectory>command
to the list of commands; don't forget to tell theScriptStepabout the
different location ofcdk.out, by passingprimaryOutputDirectory: '<somedirectory>/cdk.out'.is in ROLLBACK_COMPLETE state and can not be updatedIf  you see the following error during execution of your pipeline:Stack ... is in ROLLBACK_COMPLETE state and can not be updated. (Service:
AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request
ID: ...)The stack failed its previous deployment, and is in a non-retryable state.
Go into the CloudFormation console, delete the stack, and retry the deployment.Cannot find module 'xxxx' or its corresponding type declarationsYou may see this if you are using TypeScript or other NPM-based languages,
when using NPM 7 on your workstation (where you generatepackage-lock.json)
and NPM 6 on the CodeBuild image used for synthesizing.It looks like NPM 7 has started writing less information topackage-lock.json,
leading NPM 6 reading that same file to not install all required packages anymore.Make sure you are using the same NPM version everywhere, either downgrade your
workstation's version or upgrade the CodeBuild version.Cannot find module '.../check-node-version.js' (MODULE_NOT_FOUND)The above error may be produced bynpxwhen executing the CDK CLI, or any
project that uses the AWS SDK for JavaScript, without the target application
having been installed yet. For example, it can be triggered bynpx cdk synthifaws-cdkis not in yourpackage.json.Work around this by either installing the target application using NPMbeforerunningnpx, or set the environment variableNPM_CONFIG_UNSAFE_PERM=true.Cannot connect to the Docker daemon at unix:///var/run/docker.sockIf, in the 'Synth' action (inside the 'Build' stage) of your pipeline, you get an error like this:stderr: docker: Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?.See 'docker run --help'.It means that the AWS CodeBuild project for 'Synth' is not configured to run in privileged mode,
which prevents Docker builds from happening. This typically happens if you use a CDK construct
that bundles asset using tools run via Docker, likeaws-lambda-nodejs,aws-lambda-python,aws-lambda-goand others.Make sure you set theprivilegedenvironment variable totruein the synth definition: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)))After turning onprivilegedMode: true, you will need to do a one-time manual cdk deploy of your
pipeline to get it going again (as with a broken 'synth' the pipeline will not be able to self
update to the right state).S3 error: Access DeniedAn "S3 Access Denied" error can have two causes:Asset hashes have changed, but self-mutation has been disabled in the pipeline.You have deleted and recreated the bootstrap stack, or changed its qualifier.Self-mutation step has been removedSome constructs, such as EKS clusters, generate nested stacks. When CloudFormation tries
to deploy those stacks, it may fail with this error:S3 error: Access Denied For more information check http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.htmlThis happens because the pipeline is not self-mutating and, as a consequence, theFileAssetXbuild projects get out-of-sync with the generated templates. To fix this, make sure theselfMutatingproperty is set totrue:cloud_assembly_artifact=codepipeline.Artifact()pipeline=pipelines.CdkPipeline(self,"MyPipeline",self_mutating=True,cloud_assembly_artifact=cloud_assembly_artifact)Bootstrap roles have been renamed or recreatedWhile attempting to deploy an application stage, the "Prepare" or "Deploy" stage may fail with a cryptic error like:Action execution failed Access Denied (Service: Amazon S3; Status Code: 403; Error Code: AccessDenied; Request ID: 0123456ABCDEFGH; S3 Extended Request ID: 3hWcrVkhFGxfiMb/rTJO0Bk7Qn95x5ll4gyHiFsX6Pmk/NT+uX9+Z1moEcfkL7H3cjH7sWZfeD0=; Proxy: null)This generally indicates that the roles necessary to deploy have been deleted (or deleted and re-created);
for example, if the bootstrap stack has been deleted and re-created, this scenario will happen. Under the hood,
the resources that rely on these roles (e.g.,cdk-$qualifier-deploy-role-$account-$region) point to different
canonical IDs than the recreated versions of these roles, which causes the errors. There are no simple solutions
to this issue, and for that reason westrongly recommendthat bootstrap stacks not be deleted and re-created
once created.The most automated way to solve the issue is to introduce a secondary bootstrap stack. By changing the qualifier
that the pipeline stack looks for, a change will be detected and the impacted policies and resources will be updated.
A hypothetical recovery workflow would look something like this:First, for all impacted environments, create a secondary bootstrap stack:$envCDK_NEW_BOOTSTRAP=1npxcdkbootstrap\--qualifierrandom1234\--toolkit-stack-nameCDKToolkitTemp\aws://111111111111/us-east-1Update all impacted stacks in the pipeline to use this new qualifier.
Seehttps://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.htmlfor more info.Stack(self,"MyStack",# Update this qualifier to match the one used above.synthesizer=cdk.DefaultStackSynthesizer(qualifier="randchars1234"))Deploy the updated stacks. This will update the stacks to use the roles created in the new bootstrap stack.(Optional) Restore back to the original state:Revert the change made in step #2 aboveRe-deploy the pipeline to use the original qualifier.Delete the temporary bootstrap stack(s)Manual AlternativeAlternatively, the errors can be resolved by finding each impacted resource and policy, and correcting the policies
by replacing the canonical IDs (e.g.,AROAYBRETNYCYV6ZF2R93) with the appropriate ARNs. As an example, the KMS
encryption key policy for the artifacts bucket may have a statement that looks like the following:{"Effect":"Allow","Principal":{// "AWS" : "AROAYBRETNYCYV6ZF2R93"  // Indicates this issue; replace this value"AWS":"arn:aws:iam::0123456789012:role/cdk-hnb659fds-deploy-role-0123456789012-eu-west-1",// Correct value},"Action":["kms:Decrypt","kms:DescribeKey"],"Resource":"*"}Any resource or policy that references the qualifier (hnb659fdsby default) will need to be updated.This CDK CLI is not compatible with the CDK library used by your applicationThe CDK CLI version used in your pipeline is too old to read the Cloud Assembly
produced by your CDK app.Most likely this happens in theSelfMutateaction, you are passing thecliVersionparameter to control the version of the CDK CLI, and you just updated the CDK
framework version that your application uses. You either forgot to change thecliVersionparameter, or changed thecliVersionin the same commit in which
you changed the framework version. Because a change to the pipeline settings needs
a successful run of theSelfMutatestep to be applied, the next iteration of theSelfMutatestep still executes with theoldCLI version, and that old CLI version
is not able to read the cloud assembly produced by the new framework version.Solution: change thecliVersionfirst, commit, push and deploy, and only then
change the framework version.We recommend you avoid specifying thecliVersionparameter at all. By default
the pipeline will use the latest CLI version, which will support all cloud assembly
versions.Known IssuesThere are some usability issues that are caused by underlying technology, and
cannot be remedied by CDK at this point. They are reproduced here for completeness.Console links to other accounts will not work: the AWS CodePipeline
console will assume all links are relative to the current account. You will
not be able to use the pipeline console to click through to a CloudFormation
stack in a different account.If a change set failed to apply the pipeline must restarted: if a change
set failed to apply, it cannot be retried. The pipeline must be restarted from
the top by clickingRelease Change.A stack that failed to create must be deleted manually: if a stack
failed to create on the first attempt, you must delete it using the
CloudFormation console before starting the pipeline again by clickingRelease Change.