Class: Aws::SecretsManager::Types::SecretListEntry

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

Overview

A structure that contains the details about a secret. It does not include the encrypted ‘SecretString` and `SecretBinary` values. To get those values, use the GetSecretValue operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the secret.

For more information about ARNs in Secrets Manager, see [Policy Resources] in the *AWS Secrets Manager User Guide*.

[1]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#iam-resources

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#deleted_date ⇒ Time

The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the ‘RecoveryWindowInDays` parameter of the DeleteSecret operation.

Returns:

  • (Time) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#description ⇒ String

The user-provided description of the secret.

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#kms_key_id ⇒ String

The ARN or alias of the AWS KMS customer master key (CMK) that’s used to encrypt the ‘SecretString` and `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 KMS CMK (the one named ‘awssecretsmanager`) for this account.

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  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.

Returns:

  • (Time) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#last_changed_date ⇒ Time

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

Returns:

  • (Time) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#last_rotated_date ⇒ Time

The last date and time that the rotation process for this secret was invoked.

Returns:

  • (Time) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#name ⇒ String

The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, ‘/prod/databases/dbserver1` could represent the secret for a server named `dbserver1` in the folder `databases` in the folder `prod`.

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#owning_service ⇒ String

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#rotation_enabled ⇒ Boolean

Indicated whether automatic, scheduled rotation is enabled for this secret.

Returns:

  • (Boolean) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#rotation_lambda_arn ⇒ String

The ARN of an AWS Lambda function that’s invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

Returns:

  • (String) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

#rotation_rules ⇒ Types::RotationRulesType

A structure that defines the rotation configuration for the secret.

Returns:



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end

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

A list of all of the currently assigned ‘SecretVersionStage` staging labels and the `SecretVersionId` 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 ‘SecretVersionStage` is considered deprecated and subject to deletion. Such versions are not included in this list.

</note>

Returns:

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


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  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.

Returns:



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'lib/aws-sdk-secretsmanager/types.rb', line 1758

class SecretListEntry < 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,
  :secret_versions_to_stages,
  :owning_service)
  include Aws::Structure
end