What's in a Secrets Manager secret?
In Secrets Manager, a secret consists of secret information, the secret value, plus metadata about the secret. A secret value can be a string or binary.
To store multiple string values in one secret, we recommend that you use a JSON text string with key/value pairs, for example:
{ "host" : "ProdServer-01.databases.example.com", "port" : "8888", "username" : "administrator", "password" : "EXAMPLE-PASSWORD", "dbname" : "MyDatabase", "engine" : "mysql" }
For database secrets, if you want to turn on automatic rotation, the secret must contain connection information for the database in the correct JSON structure. For more information, see JSON structure of Amazon Secrets Manager secrets .
Metadata
A secret's metadata includes:
-
An Amazon Resource Name (ARN) with the following format:
arn:aws-cn:secretsmanager:<Region>:<AccountId>:secret:SecretName-6RandomCharactersSecrets Manager includes six random characters at the end of the secret name to help ensure that the secret ARN is unique. If the original secret is deleted, and then a new secret is created with the same name, the two secrets have different ARNs because of these characters. Users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
-
The name of the secret, a description, a resource policy, and tags.
-
The ARN for an encryption key, an Amazon KMS key that Secrets Manager uses to encrypt and decrypt the secret value. Secrets Manager stores secret text in an encrypted form and encrypts the secret in transit. See Secret encryption and decryption in Amazon Secrets Manager.
-
Information about how to rotate the secret, if you set up rotation. See Rotate Amazon Secrets Manager secrets.
Secrets Manager uses IAM permission policies to make sure that only authorized users can access or modify a secret. See Authentication and access control for Amazon Secrets Manager.
A secret has versions which hold copies of the encrypted secret value. When you change the secret value, or the secret is rotated, Secrets Manager creates a new version. See Secret versions.
You can use a secret across multiple Amazon Web Services Regions by replicating it. When you replicate a secret, you create a copy of the original or primary secret called a replica secret. The replica secret remains linked to the primary secret. See Replicate Amazon Secrets Manager secrets across Regions.
See Create and manage secrets with Amazon Secrets Manager.
Secret versions
A secret has versions which hold copies of the encrypted secret value. When you change the secret value, or the secret is rotated, Secrets Manager creates a new version.
Secrets Manager doesn't store a linear history of secrets with versions. Instead, it keeps track of three specific versions by labelling them:
The current version -
AWSCURRENTThe previous version -
AWSPREVIOUSThe pending version (during rotation) -
AWSPENDING
A secret always has a version labeled AWSCURRENT, and Secrets Manager returns that version by default when you retrieve the secret value.
You can also label versions with your own labels by calling update-secret-version-stage in the Amazon CLI. You can attach up to 20 labels to versions in a secret. Two versions of a secret can't have the same staging label. Versions can have multiple labels.
Secrets Manager never removes labeled versions, but unlabeled versions are considered deprecated. Secrets Manager removes deprecated versions when there are more than 100. Secrets Manager doesn't remove versions created less than 24 hours ago.
The following figure shows a secret that has Amazon labeled versions and customer labeled versions. The versions without labels are considered deprecated and will be removed by Secrets Manager at some point in the future.
