You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SecretsManager::Types::SecretListEntry

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the secret.

For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the secret.

#created_date ⇒ Time

The date and time when a secret was created.

Returns:

  • (Time) —

    The date and time when a secret was created.

#deleted_date ⇒ Time

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.

Returns:

  • (Time) —

    The date and time the deletion of the secret occurred.

#description ⇒ String

The user-provided description of the secret.

Returns:

  • (String) —

    The user-provided description of the secret.

#kms_key_id ⇒ String

The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don\'t provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager, for this account.

Returns:

  • (String) —

    The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString and SecretBinary fields in each version of the secret.

#last_accessed_date ⇒ Time

The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

Returns:

  • (Time) —

    The last date that this secret was accessed.

#last_changed_date ⇒ Time

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

Returns:

  • (Time) —

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

#last_rotated_date ⇒ Time

The last date and time that the rotation process for this secret was invoked.

Returns:

  • (Time) —

    The last date and time that the rotation process for this secret was invoked.

#name ⇒ String

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.

Returns:

  • (String) —

    The friendly name of the secret.

#owning_service ⇒ String

Returns the name of the service that created the secret.

Returns:

  • (String) —

    Returns the name of the service that created the secret.

#rotation_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#rotation_lambda_arn ⇒ String

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

Returns:

  • (String) —

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

#rotation_rules ⇒ Types::RotationRulesType

A structure that defines the rotation configuration for the secret.

Returns:

#secret_versions_to_stages ⇒ Hash<String,Array<String>>

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.

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

Returns:

  • (Hash<String,Array<String>>) —

    A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    The list of user-defined tags associated with the secret.