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

Inherits:

Struct

Object
Struct
Aws::SecretsManager::Types::DescribeSecretResponse

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-secretsmanager/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The ARN of the secret.
#created_date ⇒ Time

The date the secret was created.
#deleted_date ⇒ Time

The date the secret is scheduled for deletion.
#description ⇒ String

The description of the secret.
#kms_key_id ⇒ String

The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the secret value.
#last_accessed_date ⇒ Time

The date that the secret was last accessed in the Region.
#last_changed_date ⇒ Time

The last date and time that this secret was modified in any way.
#last_rotated_date ⇒ Time

The last date and time that Secrets Manager rotated the secret.
#name ⇒ String

The name of the secret.
#next_rotation_date ⇒ Time

The next rotation is scheduled to occur on or before this date.
#owning_service ⇒ String

The ID of the service that created this secret.
#primary_region ⇒ String

The Region the secret is in.
#replication_status ⇒ Array<Types::ReplicationStatusType>

A list of the replicas of this secret and their status:.
#rotation_enabled ⇒ Boolean

Specifies whether automatic rotation is turned on for this secret.
#rotation_lambda_arn ⇒ String

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
#rotation_rules ⇒ Types::RotationRulesType

The rotation schedule and Lambda function for this secret.
#tags ⇒ Array<Types::Tag>

The list of tags attached to the secret.
#version_ids_to_stages ⇒ Hash<String,Array<String>>

A list of the versions of the secret that have staging labels attached.

Instance Attribute Details

#arn ⇒ `String`

The ARN of the secret.

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ `Time`

The date the secret was created.

Returns:

(Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#deleted_date ⇒ `Time`

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.

Returns:

(Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the secret.

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_accessed_date ⇒ `Time`

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.

Returns:

(Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_changed_date ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_rotated_date ⇒ `Time`

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.

Returns:

(Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the secret.

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#next_rotation_date ⇒ `Time`

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.

This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.

Returns:

(Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#owning_service ⇒ `String`

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

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#primary_region ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#replication_status ⇒ `Array<Types::ReplicationStatusType>`

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.

Returns:

(Array<Types::ReplicationStatusType>)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_enabled ⇒ `Boolean`

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

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

Returns:

(Boolean)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_lambda_arn ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_rules ⇒ `Types::RotationRulesType`

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.

Returns:

(Types::RotationRulesType)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

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

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#version_ids_to_stages ⇒ `Hash<String,Array<String>>`

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

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html

Returns:

(Hash<String,Array<String>>)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 667

class DescribeSecretResponse < Struct.new(
  :arn,
  :name,
  :description,
  :kms_key_id,
  :rotation_enabled,
  :rotation_lambda_arn,
  :rotation_rules,
  :last_rotated_date,
  :last_changed_date,
  :last_accessed_date,
  :deleted_date,
  :next_rotation_date,
  :tags,
  :version_ids_to_stages,
  :owning_service,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#created_date ⇒ Time

#deleted_date ⇒ Time

#description ⇒ String

#kms_key_id ⇒ String

#last_accessed_date ⇒ Time

#last_changed_date ⇒ Time

#last_rotated_date ⇒ Time

#name ⇒ String

#next_rotation_date ⇒ Time

#owning_service ⇒ String

#primary_region ⇒ String

#replication_status ⇒ Array<Types::ReplicationStatusType>

#rotation_enabled ⇒ Boolean

#rotation_lambda_arn ⇒ String

#rotation_rules ⇒ Types::RotationRulesType

#tags ⇒ Array<Types::Tag>

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

#arn ⇒ `String`

#created_date ⇒ `Time`

#deleted_date ⇒ `Time`

#description ⇒ `String`

#kms_key_id ⇒ `String`

#last_accessed_date ⇒ `Time`

#last_changed_date ⇒ `Time`

#last_rotated_date ⇒ `Time`

#name ⇒ `String`

#next_rotation_date ⇒ `Time`

#owning_service ⇒ `String`

#primary_region ⇒ `String`

#replication_status ⇒ `Array<Types::ReplicationStatusType>`

#rotation_enabled ⇒ `Boolean`

#rotation_lambda_arn ⇒ `String`

#rotation_rules ⇒ `Types::RotationRulesType`

#tags ⇒ `Array<Types::Tag>`

#version_ids_to_stages ⇒ `Hash<String,Array<String>>`