Builder

class Builder

Properties

Link copied to clipboard
var arn: String?

The ARN of the secret.

Link copied to clipboard

The date the secret was created.

Link copied to clipboard

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.

Link copied to clipboard

The description of the secret.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The last date and time that this secret was modified in any way.

Link copied to clipboard

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.

Link copied to clipboard
var name: String?

The name of the secret.

Link copied to clipboard

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.

Link copied to clipboard

The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.

Link copied to clipboard

The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.

Link copied to clipboard

A list of the replicas of this secret and their status:

Link copied to clipboard

Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.

Link copied to clipboard

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.

Link copied to clipboard

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.

Link copied to clipboard
var tags: List<Tag>?

The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

Link copied to clipboard

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.

Functions