Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(kms): Allow opting out of "Retain" deletion policy #1685

Merged
merged 6 commits into from
Feb 13, 2019
Merged

feat(kms): Allow opting out of "Retain" deletion policy #1685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ccb805f
feat(kms): Allow opting out of "Retain" deletion policy
RomainMuller Feb 6, 2019
6aad146
Merge branch 'master' into rmuller/control-kms-key-deletion-policy
Feb 6, 2019
23a71b6
PR feedback
RomainMuller Feb 6, 2019
d854e40
Merge remote-tracking branch 'origin/master' into rmuller/control-kms…
RomainMuller Feb 6, 2019
0797a5b
Merge remote-tracking branch 'origin/master' into rmuller/control-kms…
RomainMuller Feb 8, 2019
eb3d07c
Fix merge artifact
RomainMuller Feb 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion packages/@aws-cdk/aws-kms/lib/key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,14 @@ export interface EncryptionKeyProps {
* administer the key will be created.
*/
policy?: PolicyDocument;

/**
* Whether the encryption key should be retained when it is removed from the Stack. This is useful when one wants to
* retain access to data that was encrypted with a key that is being retired.
*
* @default true
*/
retain?: boolean;
}

/**
Expand Down Expand Up @@ -155,7 +163,9 @@ export class EncryptionKey extends EncryptionKeyBase {
});

this.keyArn = resource.keyArn;
resource.options.deletionPolicy = DeletionPolicy.Retain;
resource.options.deletionPolicy = props.retain === false
? DeletionPolicy.Delete
: DeletionPolicy.Retain;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-kms/test/integ.key-sharing.lit.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"Version": "2012-10-17"
}
},
"DeletionPolicy": "Retain"
"DeletionPolicy": "Delete"
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a good practice it is usually preferable not to modify existing tests but rather add new tests

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well... technically I'm only touching here because I want to stop littering the account with one-off keys that we'll never use again... 😅

"MyKeyAlias1B45D9DA": {
"Type": "AWS::KMS::Alias",
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-kms/test/integ.key-sharing.lit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class KeyStack extends cdk.Stack {

constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
super(scope, id, props);
this.key = new kms.EncryptionKey(this, 'MyKey');
this.key = new kms.EncryptionKey(this, 'MyKey', { retain: false });
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-kms/test/integ.key.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
"Version": "2012-10-17"
}
},
"DeletionPolicy": "Retain"
"DeletionPolicy": "Delete"
},
"MyKeyAlias1B45D9DA": {
"Type": "AWS::KMS::Alias",
Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-kms/test/integ.key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const app = new App();

const stack = new Stack(app, `aws-cdk-kms-1`);

const key = new EncryptionKey(stack, 'MyKey');
const key = new EncryptionKey(stack, 'MyKey', { retain: false });

key.addToResourcePolicy(new PolicyStatement()
.addAllResources()
Expand Down
12 changes: 11 additions & 1 deletion packages/@aws-cdk/aws-kms/test/test.key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { exactlyMatchTemplate, expect } from '@aws-cdk/assert';
import { exactlyMatchTemplate, expect, haveResource, ResourcePart } from '@aws-cdk/assert';
import { PolicyDocument, PolicyStatement } from '@aws-cdk/aws-iam';
import { App, Stack, Tag } from '@aws-cdk/cdk';
import { Test } from 'nodeunit';
Expand Down Expand Up @@ -64,6 +64,16 @@ export = {
test.done();
},

'default with no retention'(test: Test) {
const app = new App();
const stack = new Stack(app, 'TestStack');

new EncryptionKey(stack, 'MyKey', { retain: false });

expect(app.synthesizeStack(stack.name)).to(haveResource('AWS::KMS::Key', { DeletionPolicy: "Delete" }, ResourcePart.CompleteDefinition));
test.done();
},

'default with some permission'(test: Test) {
const app = new App();
const stack = new Stack(app, 'Test');
Expand Down