Skip to content

ClusterMasterUserSecret

Source code in docs_src/capo_docdb/types/cluster_master_user_secret.py 
13
14
15
16
17
18
19
class ClusterMasterUserSecret(TypedDict, closed=True):
    secret_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the secret.</p>"""
    secret_status: NotRequired["capo_docdb.types.string.String"]
    """<p>The status of the secret.</p> <p>The possible status values include the following:</p> <ul> <li> <p>creating - The secret is being created.</p> </li> <li> <p>active - The secret is available for normal use and rotation.</p> </li> <li> <p>rotating - The secret is being rotated.</p> </li> <li> <p>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.</p> <p>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.</p> </li> </ul>"""
    kms_key_id: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Web Services KMS key identifier that is used to encrypt the secret.</p>"""

kms_key_id instance-attribute 

kms_key_id: NotRequired[String]

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

secret_arn instance-attribute 

secret_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the secret.

secret_status instance-attribute 

secret_status: NotRequired[String]

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.