class Amazonite::SecretsManager::DescribeSecretResponse

Included Modules

Defined in:

secrets_manager/describe_secret_response.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, version_ids_to_stages : Hash(String, Array(String)) | Nil = nil, owning_service : String | Nil = nil, created_date : Time | Nil = nil, primary_region : String | Nil = nil, replication_status : Array(ReplicationStatusType) | Nil = nil) #

[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 ARN of the secret.


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

The ARN of the secret.


[View source]
def created_date : Time | Nil #

The date the secret was created.


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

The date the secret was created.


[View source]
def deleted_date : Time | Nil #

The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.


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

The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.

If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.


[View source]
def description : String | Nil #

The description of the secret.


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

The 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 Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.


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

The Amazon Resource Name (ARN) of the role that allows Secrets Manager to rotate a secret held by a third-party partner. For more information, see Security and permissions.


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

See Object#hash(hasher)


def kms_key_id : String | Nil #

The key ID or alias 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. Secrets created using the console use an KMS key ID.


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

The key ID or alias 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. Secrets created using the console use an KMS key ID.


[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 last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.


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

The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation or rotation has been disabled, Secrets Manager returns null.


[View source]
def name : String | Nil #

The name of the secret.


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

The 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. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.

This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.


[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. If rotation fails, Secrets Manager retries the entire rotation process multiple times. If rotation is unsuccessful, this date may be in the past.

This date represents the latest date that rotation will occur, but it is not an approximate rotation date. In some cases, for example if you turn off automatic rotation and then turn it back on, the next rotation may occur much sooner than this date.


[View source]
def owning_service : String | Nil #

The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.


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

The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.


[View source]
def primary_region : String | Nil #

The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.


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

The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.


[View source]
def replication_status : Array(ReplicationStatusType) | Nil #

A list of the replicas of this secret and their status:

  • Failed, which indicates that the replica was not created.

  • InProgress, which indicates that Secrets Manager is in the process of creating the replica.

  • InSync, which indicates that the replica was created.


[View source]
def replication_status=(replication_status : Array(ReplicationStatusType) | Nil) #

A list of the replicas of this secret and their status:

  • Failed, which indicates that the replica was not created.

  • InProgress, which indicates that Secrets Manager is in the process of creating the replica.

  • InSync, which indicates that the replica was created.


[View source]
def rotation_enabled : Bool | Nil #

Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.

To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.


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

Specifies whether automatic rotation is turned on for this secret. If the secret has never been configured for rotation, Secrets Manager returns null.

To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.


[View source]
def rotation_lambda_arn : String | Nil #

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.


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

The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.


[View source]
def rotation_rules : RotationRulesType | Nil #

The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.


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

The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.


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

The list of tags attached to 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 tags attached to 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 partner that holds the external secret. For more information, see Using Secrets Manager managed external secrets.


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

The exact string that identifies the partner that holds the external secret. For more information, see Using Secrets Manager managed external secrets.


[View source]
def validate! : Nil #

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

A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

  • AWSCURRENT, which indicates the current version of the secret.

  • AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

  • AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

For more information about rotation and staging labels, see How rotation works.


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

A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.

Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:

  • AWSCURRENT, which indicates the current version of the secret.

  • AWSPENDING, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.

During rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.

  • AWSPREVIOUS, which indicates the previous current version of the secret. You can use this as the last known good version.

For more information about rotation and staging labels, see How rotation works.


[View source]