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

Inherits:

Struct

• Object
• Struct
• Aws::SecretsManager::Types::SecretListEntry

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the secret.

• #created_date ⇒ Time

  The date and time when a secret was created.

• #deleted_date ⇒ Time

  The date and time the deletion of the secret occurred.

• #description ⇒ String

  The user-provided description of the secret.

• #kms_key_id ⇒ String

  The ARN of the KMS key that Secrets Manager uses to encrypt the secret value.

• #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 most recent date and time that the Secrets Manager rotation process was successfully completed.

• #name ⇒ String

  The friendly name of the secret.

• #owning_service ⇒ String

  Returns the name of the service that created the secret.

• #primary_region ⇒ String

  The Region where Secrets Manager originated the secret.

• #rotation_enabled ⇒ Boolean

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

• #rotation_lambda_arn ⇒ String

  The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

• #rotation_rules ⇒ Types::RotationRulesType

  A structure that defines the rotation configuration for the secret.

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

  A list of all of the currently assigned ‘SecretVersionStage` staging labels and the `SecretVersionId` attached to each one.

• #tags ⇒ Array<Types::Tag>

  The list of user-defined tags associated with the secret.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the secret.

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#created_date ⇒ Time

The date and time when a secret was created.

Returns:

• (Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#deleted_date ⇒ Time

The date and time the deletion of the secret occurred. 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)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#description ⇒ String

The user-provided description of the secret.

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#kms_key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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,
  :created_date,
  :primary_region)
  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.

Returns:

• (Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#last_changed_date ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#last_rotated_date ⇒ Time

The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn’t ever rotated.

Returns:

• (Time)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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,
  :created_date,
  :primary_region)
  SENSITIVE = []
  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)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#owning_service ⇒ String

Returns the name of the service that created the secret.

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#primary_region ⇒ String

The Region where Secrets Manager originated the secret.

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#rotation_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#rotation_lambda_arn ⇒ String

The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

Returns:

• (String)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#rotation_rules ⇒ Types::RotationRulesType

A structure that defines the rotation configuration for the secret.

Returns:

• (Types::RotationRulesType)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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,
  :created_date,
  :primary_region)
  SENSITIVE = []
  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` attached to each one. 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>>)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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

#tags ⇒ Array<Types::Tag>

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-secretsmanager/types.rb', line 1844

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