ClusterMasterUserSecret
Contains the secret managed by Amazon DocumentDB in AWS Secrets Manager for the master user password.
Contents
Note
In the following list, the required parameters are described first.
- KmsKeyId
-
The AWS KMS key identifier that is used to encrypt the secret.
Type: String
Required: No
- SecretArn
-
The Amazon Resource Name (ARN) of the secret.
Type: String
Required: No
- SecretStatus
-
The status of the secret.
The possible status values include the following:
-
creating - The secret is being created.
-
active - The secret is available for normal use and rotation.
-
rotating - The secret is being rotated.
-
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret.
When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
Type: String
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
