AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-secretsmanager/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the secret.

For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.

Returns:

  • (String)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_dateTime

The date and time when a secret was created.

Returns:

  • (Time)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_dateTime

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)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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

#descriptionString

The user-provided description of the secret.

Returns:

  • (String)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_idString

The ARN or alias of the Amazon Web Services KMS customer master key (CMK) 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 key named awssecretsmanager, for this account.

Returns:

  • (String)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_dateTime

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

Returns:

  • (Time)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_dateTime

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)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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

#nameString

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)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_serviceString

Returns the name of the service that created the secret.

Returns:

  • (String)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_regionString

The Region where Secrets Manager originated the secret.

Returns:

  • (String)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_enabledBoolean

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

Returns:

  • (Boolean)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_arnString

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)


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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_rulesTypes::RotationRulesType

A structure that defines the rotation configuration for the secret.



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

Returns:

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


1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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

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



1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-secretsmanager/lib/aws-sdk-secretsmanager/types.rb', line 1943

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