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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The ARN of the secret.

Returns:

  • (String)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#created_dateTime

The date the secret was created.

Returns:

  • (Time)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#deleted_dateTime

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)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the secret.

Returns:

  • (String)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_accessed_dateTime

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)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_changed_dateTime

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

Returns:

  • (Time)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_rotated_dateTime

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.

Returns:

  • (Time)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the secret.

Returns:

  • (String)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#owning_serviceString

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)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#primary_regionString

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

Returns:

  • (String)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

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


618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_enabledBoolean

Specifies whether automatic rotation is turned on for this secret.

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

Returns:

  • (Boolean)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_lambda_arnString

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

Returns:

  • (String)

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

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


618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:


618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end

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

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
# File 'lib/aws-sdk-secretsmanager/types.rb', line 618

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,
  :created_date,
  :primary_region,
  :replication_status)
  SENSITIVE = []
  include Aws::Structure
end