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 RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret.
To retrieve a secret in a CFNshort template, use a dynamic reference. For more information, see Retrieve a secret in an 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. See the example Creating a Redshift cluster and a secret for the admin credentials.
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.
Create an AWS Secrets Manager secret
resource "awscc_secretsmanager_secret" "example" {
name = "example"
description = "this is a user-provided description of the secret"
}
Replicate an AWS Secrets Manager secret to other AWS Regions
resource "awscc_secretsmanager_secret" "example_replica" {
name = "example_replica"
replica_regions = [{
region = "ap-southeast-1"
},
{
region = "ap-southeast-2"
}]
}
description
(String) The description of the secret.generate_secret_string
(Attributes) 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 both GenerateSecretString
and SecretString
, 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. (see below for nested schema)kms_key_id
(String) The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by alias/
, for example alias/aws/secretsmanager
. For more information, see About aliases.
To use a 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 KMS key.name
(String) 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
(Attributes List) A custom type that specifies a Region
and the KmsKeyId
for a replica secret. (see below for nested schema)secret_string
(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 both GenerateSecretString
and SecretString
, you create an empty secret. When you make a change to this property, a new secret version is created.tags
(Attributes List) 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".
Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret.
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:
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.id
(String) Uniquely identifies the resource.secret_id
(String)generate_secret_string
Optional:
exclude_characters
(String) A string of the characters that you don't want in the password.exclude_lowercase
(Boolean) Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.exclude_numbers
(Boolean) Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.exclude_punctuation
(Boolean) 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
(Boolean) 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
(String) 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 specify SecretStringTemplate
.include_space
(Boolean) Specifies whether to include the space character. If you include this switch, the password can contain space characters.password_length
(Number) The length of the password. If you don't include this parameter, the default length is 32 characters.require_each_included_type
(Boolean) 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
(String) A template that the generated string must match. When you make a change to this property, a new secret version is created.replica_regions
Required:
region
(String) A string that represents a Region
, for example "us-east-1".Optional:
kms_key_id
(String) 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
.tags
Required:
key
(String) The key identifier, or name, of the tag.value
(String) The string value associated with the key of the tag.Import is supported using the following syntax:
$ terraform import awscc_secretsmanager_secret.example <resource ID>