The CDK Construct Library for AWS::SecretsManager
Project description
AWS Secrets Manager Construct Library
---# Example may have issues. See https://github.com/aws/jsii/issues/826
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:
# Example may have issues. See https://github.com/aws/jsii/issues/826
# Default secret
secret = secretsmanager.Secret(self, "Secret")
secret.grant_read(role)
iam.User(self, "User",
password=secret.secret_value
)
# Templated secret
templated_secret = secretsmanager.Secret(self, "TemplatedSecret",
generate_secret_string={
"secret_string_template": JSON.stringify(username="user"),
"generate_string_key": "password"
}
)
iam.User(self, "OtherUser",
user_name=templated_secret.secret_value_from_json("username").to_string(),
password=templated_secret.secret_value_from_json("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.fromSecretArn
or Secret.fromSecretAttributes
method to make it available in your CDK Application:
# Example may have issues. See https://github.com/aws/jsii/issues/826
secret = secretsmanager.Secret.from_secret_attributes(scope, "ImportedSecret",
secret_arn="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:
encryption_key=encryption_key
)
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:
# Example may have issues. See https://github.com/aws/jsii/issues/826
fn = lambda.Function(...)
secret = secretsmanager.Secret(self, "Secret")
secret.add_rotation_schedule("RotationSchedule",
rotation_lambda=fn,
automatically_after=Duration.days(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-1.16.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd2e2ea7ec0a34545145e847caa2fd970bafd19c635cf7785027165d99b00006 |
|
MD5 | d1b2950b3fcc0cc9286630e040afa80b |
|
BLAKE2b-256 | 05d8593c3240cd685c424bd29ef7c28367b411e9a308832107a8836da304893d |
Hashes for aws_cdk.aws_secretsmanager-1.16.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edd79ba0e4ddaf7a141c833c4c42848fd1ac6e05839023abd46dd2f5a054e68c |
|
MD5 | 8dd5648aa116cb7a8b138b811610de78 |
|
BLAKE2b-256 | 473331342c884fe1fb109c85ba00c6dc21ef9d06183e8d99d20ef54361066bd6 |