The CDK Construct Library for AWS::SecretsManager
Project description
AWS SecretsManager Construct Library
const secretsmanager = require('@aws-cdk/aws-secretsmanager');
Create a new Secret in a Stack
In order to have SecretsManager generate a new secret value automatically, you can get started with the following:
// Default secret
const secret = new secretsManager.Secret(this, 'Secret');
secret.grantRead(role);
new iam.User(this, 'User', {
password: secret.secretValue
});
// Templated secret
const templatedSecret = new secretsManager.Secret(this, 'TemplatedSecret', {
generateSecretString: {
secretStringTemplate: JSON.stringify({ username: 'user' }),
generateStringKey: 'password'
}
});
new iam.User(this, 'OtherUser', {
userName: templatedSecret.secretJsonValue('username').toString(),
password: templatedSecret.secretJsonValue('password')
});
The Secret
construct does not allow specifying the SecretString
property
of the AWS::SecretsManager::Secret
resource (as this will almost always
lead to the secret being surfaced in plain text and possibly committed to
your source control).
If you need to use a pre-existing secret, the recommended way is to manually
provision the secret in AWS SecretsManager and use the Secret.import
method to make it available in your CDK Application:
const secret = Secret.import(scope, 'ImportedSecret', {
secretArn: 'arn:aws:secretsmanager:<region>:<account-id-number>:secret:<secret-name>-<random-6-characters>',
// If the secret is encrypted using a KMS-hosted CMK, either import or reference that key:
encryptionKey,
});
SecretsManager secret values can only be used in select set of properties. For the list of properties, see the CloudFormation Dynamic References documentation.
Rotating a Secret
A rotation schedule can be added to a Secret:
const fn = new lambda.Function(...);
const secret = new secretsManager.Secret(this, 'Secret');
secret.addRotationSchedule('RotationSchedule', {
rotationLambda: fn,
automaticallyAfterDays: 15
});
See Overview of the Lambda Rotation Function on how to implement a Lambda Rotation Function.
For RDS credentials rotation, see aws-rds.
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-secretsmanager-0.33.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0db352c76a90f26347557990020e7c0716f24f64e0c09697043b596b4f4078a8 |
|
MD5 | 4cda84376cbebeaf3c2fb5bc46846c3b |
|
BLAKE2b-256 | 03399d0a67c464b720376bbef16c1636ca109bc9d8f58bf5a4d238c9f563e968 |
Hashes for aws_cdk.aws_secretsmanager-0.33.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9b2902d522b2f3169562374f0674618950bc2f0d3f13860862efaa7c481452a |
|
MD5 | c01045cf209d45f44e9403ff796a6245 |
|
BLAKE2b-256 | d2ceaae57e3b072f8f9eafd6f00048485288dc97371534be28582e97308930c5 |