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)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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 you created the secret.

Returns:

  • (Time)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

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)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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 user-provided description of the secret.

Returns:

  • (String)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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 ARN or alias of the Amazon Web Services 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 Amazon Web Services KMS CMK (the one named `awssecretsmanager`) for this account.

Returns:

  • (String)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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 the rotation process for this secret was invoked.

The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.

Returns:

  • (Time)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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 user-provided friendly name of the secret.

Returns:

  • (String)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

Returns the name of the service that created this secret.

Returns:

  • (String)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

Specifies the primary region for secret replication.

Returns:

  • (String)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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>

Describes a list of replication status objects as `InProgress`, `Failed` or `InSync`.`P`

Returns:


604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.


604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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 user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

Returns:


604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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

<note markdown=“1”> 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.

</note>

Returns:

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

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
# File 'lib/aws-sdk-secretsmanager/types.rb', line 604

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