feat(codepipeline): cross-environment (account+region) actions #3694
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -88,13 +88,18 @@ into a different region than your Pipeline is in. | |
|
|
||
| It works like this: | ||
|
|
||
| ```typescript | ||
| const pipeline = new codepipeline.Pipeline(this, 'MyFirstPipeline', { | ||
| // ... | ||
| crossRegionReplicationBuckets: { | ||
| // note that a physical name of the replication Bucket must be known at synthesis time | ||
| 'us-west-1': s3.Bucket.fromBucketAttributes(this, 'UsWest1ReplicationBucket', { | ||
| bucketName: 'my-us-west-1-replication-bucket', | ||
| // optional KMS key | ||
| encryptionKey: kms.Key.fromKeyArn(this, 'UsWest1ReplicationKey', | ||
| 'arn:aws:kms:us-west-1:123456789012:key/1234-5678-9012' | ||
| ), | ||
| }), | ||
| }, | ||
| }); | ||
|
|
||
|
|
@@ -128,6 +133,53 @@ $ cdk deploy MyMainStack | |
| See [the AWS docs here](https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-create-cross-region.html) | ||
| for more information on cross-region CodePipelines. | ||
|
|
||
| #### Creating an encrypted replication bucket | ||
|
|
||
| If you're passing a replication bucket created in a different stack, | ||
| like this: | ||
|
|
||
| ```typescript | ||
| const replicationStack = new Stack(app, 'ReplicationStack', { | ||
| env: { | ||
| region: 'us-west-1', | ||
| }, | ||
| }); | ||
| const key = new kms.Key(replicationStack, 'ReplicationKey'); | ||
| const replicationBucket = new s3.Bucket(replicationStack, 'ReplicationBucket', { | ||
| // like was said above - replication buckets need a set physical name | ||
| bucketName: PhysicalName.GENERATE_IF_NEEDED, | ||
| encryptionKey: key, // does not work! | ||
|
There was a problem hiding this comment. You'll get a "Can only reference cross stacks in the same region and account." error. There was a problem hiding this comment. Please follow up with @jerry-aws in a separate PR and revisit this doc. I think he will be able to help. |
||
| }); | ||
|
|
||
| // later... | ||
| new codepipeline.Pipeline(pipelineStack, 'Pipeline', { | ||
| crossRegionReplicationBuckets: { | ||
| 'us-west-1': replicationBucket, | ||
| }, | ||
| }); | ||
| ``` | ||
|
|
||
| When trying to encrypt it | ||
| (and note that if any of the cross-region actions happen to be cross-account as well, | ||
| the bucket *has to* be encrypted - otherwise the pipeline will fail at runtime), | ||
| you cannot use a key directly - KMS keys don't have physical names, | ||
| and so you can't reference them across environments. | ||
|
|
||
| In this case, you need to use an alias in place of the key when creating the bucket: | ||
|
|
||
| ```typescript | ||
| const key = new kms.Key(replicationStack, 'ReplicationKey'); | ||
| const alias = new kms.Alias(replicationStack, 'ReplicationAlias', { | ||
| // aliasName is required | ||
| aliasName: PhysicalName.GENERATE_IF_NEEDED, | ||
| targetKey: key, | ||
| }); | ||
| const replicationBucket = new s3.Bucket(replicationStack, 'ReplicationBucket', { | ||
| bucketName: PhysicalName.GENERATE_IF_NEEDED, | ||
| encryptionKey: alias, | ||
| }); | ||
| ``` | ||
|
|
||
| ### Events | ||
|
|
||
| #### Using a pipeline as an event target | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This documentation is weird. Should mostly describe how to do things and not what doesn't work...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just wanted to point out a potential "gotcha!" that might trip people up.
If you have a suggestion how to re-structure this documentation, I'm all ears.