CDK Constructs for AWS KMS
Project description
AWS Key Management Service Construct Library
---Define a KMS key:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_kms as kms
kms.Key(self, "MyKey",
enable_key_rotation=True
)
Add a couple of aliases:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
key = kms.Key(self, "MyKey")
key.add_alias("alias/foo")
key.add_alias("alias/bar")
Sharing keys between stacks
see Trust Account Identities for additional details
To use a KMS key in a different stack in the same CDK application, pass the construct to the other stack:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
#
# Stack that defines the key
#
class KeyStack(cdk.Stack):
def __init__(self, scope, id, *, description=None, env=None, stackName=None, tags=None):
super().__init__(scope, id, description=description, env=env, stackName=stackName, tags=tags)
self.key = kms.Key(self, "MyKey", removal_policy=cdk.RemovalPolicy.DESTROY)
#
# Stack that uses the key
#
class UseStack(cdk.Stack):
def __init__(self, scope, id, *, key, description=None, env=None, stackName=None, tags=None):
super().__init__(scope, id, key=key, description=description, env=env, stackName=stackName, tags=tags)
# Use the IKey object here.
kms.Alias(self, "Alias",
alias_name="alias/foo",
target_key=key
)
key_stack = KeyStack(app, "KeyStack")
UseStack(app, "UseStack", key=key_stack.key)
Importing existing keys
see Trust Account Identities for additional details
To use a KMS key that is not defined in this CDK app, but is created through other means, use
Key.fromKeyArn(parent, name, ref)
:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
my_key_imported = kms.Key.from_key_arn(self, "MyImportedKey", "arn:aws:...")
# you can do stuff with this imported key.
my_key_imported.add_alias("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.
Trust Account Identities
KMS keys can be created to trust IAM policies. This is the default behavior in the console and is described here. This same behavior can be enabled by:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
Key(stack, "MyKey", trust_account_identities=True)
Using trustAccountIdentities
solves many issues around cyclic dependencies
between stacks. The most common use case is creating an S3 Bucket with CMK
default encryption which is later accessed by IAM roles in other stacks.
stack-1 (bucket and key created)
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
# ... snip
my_kms_key = kms.Key(self, "MyKey", trust_account_identities=True)
bucket = Bucket(self, "MyEncryptedBucket",
bucket_name="myEncryptedBucket",
encryption=BucketEncryption.KMS,
encryption_key=my_kms_key
)
stack-2 (lambda that operates on bucket and key)
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
# ... snip
fn = lambda.Function(self, "MyFunction",
runtime=lambda.Runtime.NODEJS_10_X,
handler="index.handler",
code=lambda.Code.from_asset(path.join(__dirname, "lambda-handler"))
)
bucket = s3.Bucket.from_bucket_name(self, "BucketId", "myEncryptedBucket")
key = kms.Key.from_key_arn(self, "KeyId", "arn:aws:...")# key ARN passed via stack props
bucket.grant_read_write(fn)
key.grant_encrypt_decrypt(fn)
The challenge in this scenario is the KMS key policy behavior. The simple way to understand
this, is IAM policies for account entities can only grant the permissions granted to the
account root principle in the key policy. When trustAccountIdentities
is true,
the following policy statement is added:
{
"Sid": "Enable IAM User Permissions",
"Effect": "Allow",
"Principal": {"AWS": "arn:aws:iam::111122223333:root"},
"Action": "kms:*",
"Resource": "*"
}
As the name suggests this trusts IAM policies to control access to the key. If account root does not have permissions to the specific actions, then the key policy and the IAM policy for the entity (e.g. Lambda) both need to grant permission.
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
Built Distribution
Hashes for aws_cdk.aws_kms-1.36.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7683de8e2695b2fdc0c3bc97bca0763f29c864d8b683bd5224c1a6f689a0444 |
|
MD5 | 8512a6e5cbef44dbf2d105c7d81a2cf7 |
|
BLAKE2b-256 | 547267768575a4f0fa3a3ff2ae5a125e5696ce0a517b32c08785ca9f2e8ef9c8 |