SecretListEntry

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

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use GetSecretValue .

interface SecretListEntry {

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;

RotationEnabled?: boolean | null;

RotationLambdaARN?: string | null;

RotationRules?: RotationRulesType | null;

SecretVersionsToStages?: {

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

} | null;

Tags?: Tag[] | null;

}

§Properties

ARN?: string | null

[src]

The Amazon Resource Name (ARN) of the secret.

CreatedDate?: Date | number | null

[src]

The date and time when a secret was created.

DeletedDate?: Date | number | null

[src]

The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

Description?: string | null

[src]

The user-provided description of the secret.

KmsKeyId?: string | null

[src]

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

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 most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.

Name?: string | null

[src]

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

NextRotationDate?: Date | number | null

[src]

The next date and time that Secrets Manager will attempt to rotate the secret, rounded to the nearest hour. This value is null if the secret is not set up for rotation.

OwningService?: string | null

[src]

Returns the name of the service that created the secret.

PrimaryRegion?: string | null

[src]

The Region where Secrets Manager originated the secret.

RotationEnabled?: boolean | null

[src]

Indicates whether automatic, scheduled rotation is enabled for this secret.

RotationLambdaARN?: string | null

[src]

The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

RotationRules?: RotationRulesType | null

[src]

A structure that defines the rotation configuration for the secret.

SecretVersionsToStages?: {

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

} | null

[src]

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

Note: A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

Tags?: Tag[] | null

[src]

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.