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

Class: Aws::SecretsManager::Types::DescribeSecretResponse

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

Overview

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the secret.

Returns:

  • (String)

    The ARN of the secret.

#deleted_dateTime

This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.

Returns:

  • (Time)

    This value exists if the secret is scheduled for deletion.

#descriptionString

The user-provided description of the secret.

Returns:

  • (String)

    The user-provided description of the secret.

#kms_key_idString

The ARN or alias of the AWS KMS customer master key (CMK) that\'s used to encrypt the SecretString or 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 AWS KMS CMK (the one named awssecretsmanager) for this account.

Returns:

  • (String)

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

#last_accessed_dateTime

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_dateTime

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_dateTime

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.

Returns:

  • (Time)

    The most recent date and time that the Secrets Manager rotation process was successfully completed.

#nameString

The user-provided friendly name of the secret.

Returns:

  • (String)

    The user-provided friendly name of the secret.

#owning_serviceString

Returns:

  • (String)

#rotation_enabledBoolean

Specifies whether automatic rotation is enabled for this secret.

To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. To disable rotation, use CancelRotateSecret.

Returns:

  • (Boolean)

    Specifies whether automatic rotation is enabled for this secret.

#rotation_lambda_arnString

The ARN of a Lambda function that\'s invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret.

Returns:

  • (String)

    The ARN of a Lambda function that\'s invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret.

#rotation_rulesTypes::RotationRulesType

A structure that contains the rotation configuration for this secret.

Returns:

#tagsArray<Types::Tag>

The list of user-defined tags that are 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 that are associated with the secret.

#version_ids_to_stagesHash<String,Array<String>>

A list of all of the currently assigned VersionStage staging labels and the VersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any staging labels attached 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 VersionStage staging labels and the VersionId that each is attached to.