CfnSecret
- class aws_cdk.aws_secretsmanager.CfnSecret(scope, id, *, description=None, generate_secret_string=None, kms_key_id=None, name=None, replica_regions=None, secret_string=None, tags=None)
Bases:
CfnResource
A CloudFormation
AWS::SecretsManager::Secret
.Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .
To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an AWS CloudFormation resource .
A common scenario is to first create a secret with
GenerateSecretString
, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. Follow these steps, as shown in the examples below:Define the secret without referencing the service or database. You can’t reference the service or database because it doesn’t exist yet. The secret must contain a username and password.
Next, define the service or database. Include the reference to the secret to use stored credentials to define the database admin user and password.
Finally, define a
SecretTargetAttachment
resource type to finish configuring the secret with the required database engine type and the connection details of the service or database. The rotation function requires the details, if you attach one later by defining a AWS::SecretsManager::RotationSchedule resource type.
For information about creating a secret in the console, see Create a secret . For information about creating a secret using the CLI or SDK, see CreateSecret .
For information about retrieving a secret in code, see Retrieve secrets from Secrets Manager . .. epigraph:
Do not create a dynamic reference using a backslash ``(\)`` as the final value. AWS CloudFormation cannot resolve those references, which causes a resource failure.
- CloudformationResource:
AWS::SecretsManager::Secret
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_secretsmanager as secretsmanager cfn_secret = secretsmanager.CfnSecret(self, "MyCfnSecret", description="description", generate_secret_string=secretsmanager.CfnSecret.GenerateSecretStringProperty( exclude_characters="excludeCharacters", exclude_lowercase=False, exclude_numbers=False, exclude_punctuation=False, exclude_uppercase=False, generate_string_key="generateStringKey", include_space=False, password_length=123, require_each_included_type=False, secret_string_template="secretStringTemplate" ), kms_key_id="kmsKeyId", name="name", replica_regions=[secretsmanager.CfnSecret.ReplicaRegionProperty( region="region", # the properties below are optional kms_key_id="kmsKeyId" )], secret_string="secretString", tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::SecretsManager::Secret
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
description (
Optional
[str
]) – The description of the secret.generate_secret_string (
Union
[IResolvable
,GenerateSecretStringProperty
,Dict
[str
,Any
],None
]) – A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, useSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.kms_key_id (
Optional
[str
]) – The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed byalias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases . To use a AWS KMS key in a different account, use the key ARN or the alias ARN. If you don’t specify this value, then Secrets Manager uses the keyaws/secretsmanager
. If that key doesn’t yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can’t useaws/secretsmanager
to encrypt the secret, and you must create and use a customer managed AWS KMS key.name (
Optional
[str
]) – The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.replica_regions (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ReplicaRegionProperty
,Dict
[str
,Any
]]],None
]) – A custom type that specifies aRegion
and theKmsKeyId
for a replica secret.secret_string (
Optional
[str
]) – The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, useGenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key “ABC” is a different tag from one with key “abc”. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns anAccess Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets’ tags . For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters . If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: - Maximum number of tags per secret: 50 - Maximum key length: 127 Unicode characters in UTF-8 - Maximum value length: 255 Unicode characters in UTF-8 - Tag keys and values are case sensitive. - Do not use theaws:
prefix in your tag names or values because AWS reserves it for AWS use. You can’t edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. - If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::SecretsManager::Secret'
- attr_id
The ARN of the secret.
- CloudformationAttribute:
Id
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- description
The description of the secret.
- generate_secret_string
A structure that specifies how to generate a password to encrypt and store in the secret.
To include a specific string in the secret, use
SecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created.We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
- kms_key_id
The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret.
An alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases .To use a AWS KMS key in a different account, use the key ARN or the alias ARN.
If you don’t specify this value, then Secrets Manager uses the key
aws/secretsmanager
. If that key doesn’t yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.If the secret is in a different AWS account from the credentials calling the API, then you can’t use
aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed AWS KMS key.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- replica_regions
A custom type that specifies a
Region
and theKmsKeyId
for a replica secret.
- secret_string
The text to encrypt and store in the secret.
We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use
GenerateSecretString
instead. If you omit bothGenerateSecretString
andSecretString
, you create an empty secret. When you make a change to this property, a new secret version is created.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
A list of tags to attach to the secret.
Each tag is a key and value pair of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key “ABC” is a different tag from one with key “abc”.
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an
Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets’ tags .For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters . If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the
aws:
prefix in your tag names or values because AWS reserves it for AWS use. You can’t edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
GenerateSecretStringProperty
- class CfnSecret.GenerateSecretStringProperty(*, exclude_characters=None, exclude_lowercase=None, exclude_numbers=None, exclude_punctuation=None, exclude_uppercase=None, generate_string_key=None, include_space=None, password_length=None, require_each_included_type=None, secret_string_template=None)
Bases:
object
Generates a random password.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Required permissions:
secretsmanager:GetRandomPassword
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager .- Parameters:
exclude_characters (
Optional
[str
]) – A string of the characters that you don’t want in the password.exclude_lowercase (
Union
[bool
,IResolvable
,None
]) – Specifies whether to exclude lowercase letters from the password. If you don’t include this switch, the password can contain lowercase letters.exclude_numbers (
Union
[bool
,IResolvable
,None
]) – Specifies whether to exclude numbers from the password. If you don’t include this switch, the password can contain numbers.exclude_punctuation (
Union
[bool
,IResolvable
,None
]) – Specifies whether to exclude the following punctuation characters from the password: ! ” # $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ ] ^ _ ` { | } ~`` . If you don’t include this switch, the password can contain punctuation.exclude_uppercase (
Union
[bool
,IResolvable
,None
]) – Specifies whether to exclude uppercase letters from the password. If you don’t include this switch, the password can contain uppercase letters.generate_string_key (
Optional
[str
]) – The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by theSecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
.include_space (
Union
[bool
,IResolvable
,None
]) – Specifies whether to include the space character. If you include this switch, the password can contain space characters.password_length (
Union
[int
,float
,None
]) – The length of the password. If you don’t include this parameter, the default length is 32 characters.require_each_included_type (
Union
[bool
,IResolvable
,None
]) – Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don’t include this switch, the password contains at least one of every character type.secret_string_template (
Optional
[str
]) – A template that the generated string must match. When you make a change to this property, a new secret version is created.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_secretsmanager as secretsmanager generate_secret_string_property = secretsmanager.CfnSecret.GenerateSecretStringProperty( exclude_characters="excludeCharacters", exclude_lowercase=False, exclude_numbers=False, exclude_punctuation=False, exclude_uppercase=False, generate_string_key="generateStringKey", include_space=False, password_length=123, require_each_included_type=False, secret_string_template="secretStringTemplate" )
Attributes
- exclude_characters
A string of the characters that you don’t want in the password.
- exclude_lowercase
Specifies whether to exclude lowercase letters from the password.
If you don’t include this switch, the password can contain lowercase letters.
- exclude_numbers
Specifies whether to exclude numbers from the password.
If you don’t include this switch, the password can contain numbers.
- exclude_punctuation
`!
” # $ % & ‘ ( ) * + , - . / : ; < = > ? @ [ ] ^ _ `` { | } ~`` . If you don’t include this switch, the password can contain punctuation.
- Link:
- Type:
Specifies whether to exclude the following punctuation characters from the password
- exclude_uppercase
Specifies whether to exclude uppercase letters from the password.
If you don’t include this switch, the password can contain uppercase letters.
- generate_string_key
The JSON key name for the key/value pair, where the value is the generated password.
This pair is added to the JSON structure specified by the
SecretStringTemplate
parameter. If you specify this parameter, then you must also specifySecretStringTemplate
.
- include_space
Specifies whether to include the space character.
If you include this switch, the password can contain space characters.
- password_length
The length of the password.
If you don’t include this parameter, the default length is 32 characters.
- require_each_included_type
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
If you don’t include this switch, the password contains at least one of every character type.
- secret_string_template
A template that the generated string must match.
When you make a change to this property, a new secret version is created.
ReplicaRegionProperty
- class CfnSecret.ReplicaRegionProperty(*, region, kms_key_id=None)
Bases:
object
Specifies a
Region
and theKmsKeyId
for a replica secret.- Parameters:
region (
str
) – (Optional) A string that represents aRegion
, for example “us-east-1”.kms_key_id (
Optional
[str
]) – The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don’t include this field, Secrets Manager usesaws/secretsmanager
.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_secretsmanager as secretsmanager replica_region_property = secretsmanager.CfnSecret.ReplicaRegionProperty( region="region", # the properties below are optional kms_key_id="kmsKeyId" )
Attributes
- kms_key_id
The ARN, key ID, or alias of the KMS key to encrypt the secret.
If you don’t include this field, Secrets Manager uses
aws/secretsmanager
.
- region
(Optional) A string that represents a
Region
, for example “us-east-1”.