class Amazonite::SecretsManager::SecretListEntry

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

Included Modules

Defined in:

secrets_manager/secret_list_entry.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(arn : String | Nil = nil, name : String | Nil = nil, type : String | Nil = nil, description : String | Nil = nil, kms_key_id : String | Nil = nil, rotation_enabled : Bool | Nil = nil, rotation_lambda_arn : String | Nil = nil, rotation_rules : RotationRulesType | Nil = nil, external_secret_rotation_metadata : Array(ExternalSecretRotationMetadataItem) | Nil = nil, external_secret_rotation_role_arn : String | Nil = nil, last_rotated_date : Time | Nil = nil, last_changed_date : Time | Nil = nil, last_accessed_date : Time | Nil = nil, deleted_date : Time | Nil = nil, next_rotation_date : Time | Nil = nil, tags : Array(Tag) | Nil = nil, secret_versions_to_stages : Hash(String, Array(String)) | Nil = nil, owning_service : String | Nil = nil, created_date : Time | Nil = nil, primary_region : String | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def arn : String | Nil #

The Amazon Resource Name (ARN) of the secret.


[View source]
def arn=(arn : String | Nil) #

The Amazon Resource Name (ARN) of the secret.


[View source]
def created_date : Time | Nil #

The date and time when a secret was created.


[View source]
def created_date=(created_date : Time | Nil) #

The date and time when a secret was created.


[View source]
def deleted_date : Time | Nil #

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.


[View source]
def deleted_date=(deleted_date : Time | Nil) #

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.


[View source]
def description : String | Nil #

The user-provided description of the secret.


[View source]
def description=(description : String | Nil) #

The user-provided description of the secret.


[View source]
def external_secret_rotation_metadata : Array(ExternalSecretRotationMetadataItem) | Nil #

The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.


[View source]
def external_secret_rotation_metadata=(external_secret_rotation_metadata : Array(ExternalSecretRotationMetadataItem) | Nil) #

The metadata needed to successfully rotate a managed external secret. A list of key value pairs in JSON format specified by the partner. For more information about the required information, see Managed external secrets partners.


[View source]
def external_secret_rotation_role_arn : String | Nil #

The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.


[View source]
def external_secret_rotation_role_arn=(external_secret_rotation_role_arn : String | Nil) #

The role that Secrets Manager assumes to call APIs required to perform the rotation. For more information about the required information, see Managed external secrets partners.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def kms_key_id : String | Nil #

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.


[View source]
def kms_key_id=(kms_key_id : String | Nil) #

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.


[View source]
def last_accessed_date : Time | Nil #

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.


[View source]
def last_accessed_date=(last_accessed_date : Time | Nil) #

The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.


[View source]
def last_changed_date : Time | Nil #

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


[View source]
def last_changed_date=(last_changed_date : Time | Nil) #

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


[View source]
def last_rotated_date : Time | Nil #

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.


[View source]
def last_rotated_date=(last_rotated_date : Time | Nil) #

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.


[View source]
def name : String | Nil #

The friendly name of the secret.


[View source]
def name=(name : String | Nil) #

The friendly name of the secret.


[View source]
def next_rotation_date : Time | Nil #

The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.


[View source]
def next_rotation_date=(next_rotation_date : Time | Nil) #

The next rotation is scheduled to occur on or before this date. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.


[View source]
def owning_service : String | Nil #

Returns the name of the service that created the secret.


[View source]
def owning_service=(owning_service : String | Nil) #

Returns the name of the service that created the secret.


[View source]
def primary_region : String | Nil #

The Region where Secrets Manager originated the secret.


[View source]
def primary_region=(primary_region : String | Nil) #

The Region where Secrets Manager originated the secret.


[View source]
def rotation_enabled : Bool | Nil #

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


[View source]
def rotation_enabled=(rotation_enabled : Bool | Nil) #

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


[View source]
def rotation_lambda_arn : String | Nil #

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 .


[View source]
def rotation_lambda_arn=(rotation_lambda_arn : String | Nil) #

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 .


[View source]
def rotation_rules : RotationRulesType | Nil #

A structure that defines the rotation configuration for the secret.


[View source]
def rotation_rules=(rotation_rules : RotationRulesType | Nil) #

A structure that defines the rotation configuration for the secret.


[View source]
def secret_versions_to_stages : Hash(String, Array(String)) | Nil #

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.


[View source]
def secret_versions_to_stages=(secret_versions_to_stages : Hash(String, Array(String)) | Nil) #

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.


[View source]
def tags : Array(Tag) | Nil #

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


[View source]
def tags=(tags : Array(Tag) | Nil) #

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


[View source]
def type : String | Nil #

The exact string that identifies the third-party partner that holds the external secret. For more information, see Managed external secret partners.


[View source]
def type=(type : String | Nil) #

The exact string that identifies the third-party partner that holds the external secret. For more information, see Managed external secret partners.


[View source]
def validate! : Nil #

[View source]