Class: Aws::SecretsManager::Types::DescribeSecretResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::SecretsManager::Types::DescribeSecretResponse
- 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 you created the secret.
-
#deleted_date ⇒ Time
This value exists if the secret is scheduled for deletion.
-
#description ⇒ String
The user-provided description of the secret.
-
#kms_key_id ⇒ String
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.
-
#last_accessed_date ⇒ Time
The last date that this secret was accessed.
-
#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 the rotation process for this secret was invoked.
-
#name ⇒ String
The user-provided friendly name of the secret.
-
#owning_service ⇒ String
Returns the name of the service that created this secret.
-
#primary_region ⇒ String
Specifies the primary region for secret replication.
-
#replication_status ⇒ Array<Types::ReplicationStatusType>
Describes a list of replication status objects as ‘InProgress`, `Failed` or `InSync`.`P`.
-
#rotation_enabled ⇒ Boolean
Specifies whether automatic rotation is enabled for this secret.
-
#rotation_lambda_arn ⇒ 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_rules ⇒ Types::RotationRulesType
A structure with the rotation configuration for this secret.
-
#tags ⇒ Array<Types::Tag>
The list of user-defined tags that are associated with the secret.
-
#version_ids_to_stages ⇒ Hash<String,Array<String>>
A list of all of the currently assigned ‘VersionStage` staging labels and the `VersionId` that each is attached to.
Instance Attribute Details
#arn ⇒ String
The ARN of the secret.
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_date ⇒ Time
The date you created the secret.
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_date ⇒ Time
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.
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 |
#description ⇒ String
The user-provided description of the secret.
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_id ⇒ String
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.
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_date ⇒ Time
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.
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_date ⇒ Time
The last date and time that this secret was modified in any way.
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_date ⇒ Time
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.
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 |
#name ⇒ String
The user-provided friendly name of the secret.
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_service ⇒ String
Returns the name of the service that created this secret.
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_region ⇒ String
Specifies the primary region for secret replication.
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_status ⇒ Array<Types::ReplicationStatusType>
Describes a list of replication status objects as ‘InProgress`, `Failed` or `InSync`.`P`
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_enabled ⇒ Boolean
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.
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_arn ⇒ 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`.
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_rules ⇒ Types::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 |
#tags ⇒ Array<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.
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_stages ⇒ Hash<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>
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 |