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.28.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbd5231c7889daa0e3379d9bfe2ef114187700bff5c5c929aa1f11417f727176 |
|
MD5 | ad9fadbbd713a6cbe6527baf0193d20c |
|
BLAKE2b-256 | 9f69403b0e3fc3ff82d1c983d653849ab1a3a5e3a9c09c45052f654d1f555d91 |
Hashes for aws_cdk.aws_secretsmanager-0.28.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31198f7ffabd2f3518976a6674c81fdea6db7741dc2f8cb2f173cabde8eaf38a |
|
MD5 | 4ba74a91a097eb6ada96fe4118fc30a7 |
|
BLAKE2b-256 | b02444a5525e2bcd767fae210c0df818e6d8491ea6527e52b7138c703cf3e338 |