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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the secret.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#descriptionString

The user-provided description of the secret.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#last_changed_dateTime

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

Returns:

  • (Time)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#nameString

The user-provided friendly name of the secret.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#owning_serviceString

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#rotation_rulesTypes::RotationRulesType

A structure that contains the rotation configuration for this secret.



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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:



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end

#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>>)


600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 600

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,
  :tags,
  :version_ids_to_stages,
  :owning_service)
  include Aws::Structure
end