CDK Constructs for AWS KMS
Project description
AWS KMS Construct Library
Defines a KMS key:
new EncryptionKey(this, 'MyKey', {
enableKeyRotation: true
});
Add a couple of aliases:
const key = new EncryptionKey(this, 'MyKey');
key.addAlias('alias/foo');
key.addAlias('alias/bar');
Sharing keys between stacks
To use a KMS key in a different stack in the same CDK application, pass the construct to the other stack:
/**
* Stack that defines the key
*/
class KeyStack extends cdk.Stack {
public readonly key: kms.EncryptionKey;
constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
super(scope, id, props);
this.key = new kms.EncryptionKey(this, 'MyKey', { retain: false });
}
}
interface UseStackProps extends cdk.StackProps {
key: kms.IEncryptionKey; // Use IEncryptionKey here
}
/**
* Stack that uses the key
*/
class UseStack extends cdk.Stack {
constructor(scope: cdk.App, id: string, props: UseStackProps) {
super(scope, id, props);
// Use the IEncryptionKey object here.
props.key.addAlias('alias/foo');
}
}
const keyStack = new KeyStack(app, 'KeyStack');
new UseStack(app, 'UseStack', { key: keyStack.key });
Importing existing keys
To use a KMS key that is not defined in this CDK app, but is created through other means, use
EncryptionKey.import(parent, name, ref)
:
const myKeyImported = EncryptionKey.import(this, 'MyImportedKey', {
keyArn: 'arn:aws:...'
});
// you can do stuff with this imported key.
key.addAlias('alias/foo');
Note that a call to .addToPolicy(statement)
on myKeyImported
will not have
an affect on the key's policy because it is not owned by your stack. The call
will be a no-op.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
aws-cdk.aws-kms-0.30.0.tar.gz
(51.3 kB
view hashes)
Built Distribution
Close
Hashes for aws_cdk.aws_kms-0.30.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ceb317fc90277e6681c7ab15c030b20edab304f0b74eeff0ed3d6f68b5b34777 |
|
MD5 | 86ef98c4cbf7d2e0db2484018bcbf403 |
|
BLAKE2b-256 | 419728ef1fb118b843bdbc6c29a4e1b9074105cfe088a216dce6597efe41780d |