The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret
is encrypted with the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
Secrets created using the console use an KMS key ID.
Parameters:
kmsKeyId - The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the
secret is encrypted with the Amazon Web Services managed key aws/secretsmanager, this
field is omitted. Secrets created using the console use an KMS key ID.
Returns:
Returns a reference to this object so that method calls can be chained together.
rotationEnabled - Specifies whether automatic rotation is turned on for this secret. If the secret has never been
configured for rotation, Secrets Manager returns null.
The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on,
but it is now turned off, this field shows the previous rotation schedule and rotation function. If the
secret never had rotation turned on, this field is omitted.
Parameters:
rotationRules - The rotation schedule and Lambda function for this secret. If the secret previously had rotation
turned on, but it is now turned off, this field shows the previous rotation schedule and rotation
function. If the secret never had rotation turned on, this field is omitted.
Returns:
Returns a reference to this object so that method calls can be chained together.
The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on,
but it is now turned off, this field shows the previous rotation schedule and rotation function. If the
secret never had rotation turned on, this field is omitted.
The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON
format specified by the partner. For more information about the required information, see Managed external secrets
partners.
Parameters:
externalSecretRotationMetadata - The metadata needed to successfully rotate a managed external secret. A list of key value pairs in
JSON format specified by the partner. For more information about the required information, see Managed external
secrets partners.
Returns:
Returns a reference to this object so that method calls can be chained together.
The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON
format specified by the partner. For more information about the required information, see Managed external secrets
partners.
Parameters:
externalSecretRotationMetadata - The metadata needed to successfully rotate a managed external secret. A list of key value pairs in
JSON format specified by the partner. For more information about the required information, see Managed external
secrets partners.
Returns:
Returns a reference to this object so that method calls can be chained together.
The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON
format specified by the partner. For more information about the required information, see Managed external secrets
partners.
The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a
third-party partner. For more information, see Security and
permissions.
Parameters:
externalSecretRotationRoleArn - The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a
third-party partner. For more information, see Security and
permissions.
Returns:
Returns a reference to this object so that method calls can be chained together.
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation
or rotation has been disabled, Secrets Manager returns null.
Parameters:
lastRotatedDate - The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for
rotation or rotation has been disabled, Secrets Manager returns null.
Returns:
Returns a reference to this object so that method calls can be chained together.
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been
retrieved in the Region.
Parameters:
lastAccessedDate - The date that the secret was last accessed in the Region. This field is omitted if the secret has
never been retrieved in the Region.
Returns:
Returns a reference to this object so that method calls can be chained together.
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted.
When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the
secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not
accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
Parameters:
deletedDate - The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is
omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days
before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret,
including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not
accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
Returns:
Returns a reference to this object so that method calls can be chained together.
The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation
or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets Manager retries the
entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In
some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may
occur much sooner than this date.
Parameters:
nextRotationDate - The next rotation is scheduled to occur on or before this date. If the secret isn't configured for
rotation or rotation has been disabled, Secrets Manager returns null. If rotation fails, Secrets
Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may
be in the past.
This date represents the latest date that rotation will occur, but it is not an approximate rotation
date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next
rotation may occur much sooner than this date.
Returns:
Returns a reference to this object so that method calls can be chained together.
A list of the versions of the secret that have staging labels attached. Versions that don't have staging
labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three
staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.
AWSPENDING, which indicates the version of the secret that contains new secret information that
will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret
version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the
last known good version.
For more information about rotation and staging labels, see How rotation
works.
Parameters:
versionIdsToStages - A list of the versions of the secret that have staging labels attached. Versions that don't have
staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The
three staging labels for rotation are:
AWSCURRENT, which indicates the current version of the secret.
AWSPENDING, which indicates the version of the secret that contains new secret
information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new
secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS, which indicates the previous current version of the secret. You can use this
as the last known good version.
For more information about rotation and staging labels, see How
rotation works.
Returns:
Returns a reference to this object so that method calls can be chained together.