DescribeSecretResponse

import type { DescribeSecretResponse } from "https://aws-api.deno.dev/v0.4/services/secretsmanager.ts?docs=full";

interface DescribeSecretResponse {

ARN?: string | null;

CreatedDate?: Date | number | null;

DeletedDate?: Date | number | null;

Description?: string | null;

KmsKeyId?: string | null;

LastAccessedDate?: Date | number | null;

LastChangedDate?: Date | number | null;

LastRotatedDate?: Date | number | null;

Name?: string | null;

NextRotationDate?: Date | number | null;

OwningService?: string | null;

PrimaryRegion?: string | null;

ReplicationStatus?: ReplicationStatusType[] | null;

RotationEnabled?: boolean | null;

RotationLambdaARN?: string | null;

RotationRules?: RotationRulesType | null;

Tags?: Tag[] | null;

VersionIdsToStages?: {

[key: string]: string[] | null | undefined;

} | null;

}

§Properties

ARN?: string | null

[src]

The ARN of the secret.

CreatedDate?: Date | number | null

[src]

The date the secret was created.

DeletedDate?: Date | number | null

[src]

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".

Description?: string | null

[src]

The description of the secret.

KmsKeyId?: string | null

[src]

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.

LastAccessedDate?: Date | number | null

[src]

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.

LastChangedDate?: Date | number | null

[src]

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

LastRotatedDate?: Date | number | null

[src]

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

Name?: string | null

[src]

The name of the secret.

NextRotationDate?: Date | number | null

[src]

The next date and time that Secrets Manager will rotate the secret, rounded to the nearest hour. If the secret isn't configured for rotation, Secrets Manager returns null.

OwningService?: string | null

[src]

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

PrimaryRegion?: string | null

[src]

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

ReplicationStatus?: ReplicationStatusType[] | null

[src]

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

Failed, which indicates that the replica was not created.
InProgress, which indicates that Secrets Manager is in the process of creating the replica.
InSync, which indicates that the replica was created.

RotationEnabled?: boolean | null

[src]

Specifies whether automatic rotation is turned on for this secret.

To turn on rotation, use "RotateSecret". To turn off rotation, use "CancelRotateSecret".

RotationLambdaARN?: string | null

[src]

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

RotationRules?: RotationRulesType | null

[src]

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.

Tags?: Tag[] | null

[src]

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

VersionIdsToStages?: {

[key: string]: string[] | null | undefined;

} | null

[src]

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.