class Amazonite::Kms::KeyMetadata

Overview

Contains metadata about a KMS key.

This data type is used as a response element for the CreateKey, DescribeKey, and ReplicateKey operations.

Included Modules

Defined in:

kms/key_metadata.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(key_id : String, aws_account_id : String | Nil = nil, arn : String | Nil = nil, creation_date : Time | Nil = nil, enabled : Bool | Nil = nil, description : String | Nil = nil, key_usage : KeyUsageType | Nil = nil, key_state : KeyState | Nil = nil, deletion_date : Time | Nil = nil, valid_to : Time | Nil = nil, origin : OriginType | Nil = nil, custom_key_store_id : String | Nil = nil, cloud_hsm_cluster_id : String | Nil = nil, expiration_model : ExpirationModelType | Nil = nil, key_manager : KeyManagerType | Nil = nil, customer_master_key_spec : CustomerMasterKeySpec | Nil = nil, key_spec : KeySpec | Nil = nil, encryption_algorithms : Array(EncryptionAlgorithmSpec) | Nil = nil, signing_algorithms : Array(SigningAlgorithmSpec) | Nil = nil, key_agreement_algorithms : Array(KeyAgreementAlgorithmSpec) | Nil = nil, multi_region : Bool | Nil = nil, multi_region_configuration : MultiRegionConfiguration | Nil = nil, pending_deletion_window_in_days : Int32 | Nil = nil, mac_algorithms : Array(MacAlgorithmSpec) | Nil = nil, xks_key_configuration : XksKeyConfigurationType | Nil = nil, current_key_material_id : String | 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 Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.


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

The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.


[View source]
def aws_account_id : String | Nil #

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.


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

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.


[View source]
def cloud_hsm_cluster_id : String | Nil #

The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.


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

The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.


[View source]
def creation_date : Time | Nil #

The date and time when the KMS key was created.


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

The date and time when the KMS key was created.


[View source]
def current_key_material_id : String | Nil #

Identifies the current key material. This value is present for symmetric encryption keys with AWS_KMS or EXTERNAL origin. These KMS keys support automatic or on-demand key rotation and can have multiple key materials associated with them. KMS uses the current key material for both encryption and decryption, and the non-current key material for decryption operations only.


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

Identifies the current key material. This value is present for symmetric encryption keys with AWS_KMS or EXTERNAL origin. These KMS keys support automatic or on-demand key rotation and can have multiple key materials associated with them. KMS uses the current key material for both encryption and decryption, and the non-current key material for decryption operations only.


[View source]
def custom_key_store_id : String | Nil #

A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.


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

A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.


[View source]
def customer_master_key_spec : CustomerMasterKeySpec | Nil #

Instead, use the KeySpec field.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.


[View source]
def customer_master_key_spec=(customer_master_key_spec : CustomerMasterKeySpec | Nil) #

Instead, use the KeySpec field.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.


[View source]
def deletion_date : Time | Nil #

The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.


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

The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.


[View source]
def description : String | Nil #

The description of the KMS key.


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

The description of the KMS key.


[View source]
def enabled : Bool | Nil #

Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.


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

Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true, otherwise it is false.


[View source]
def encryption_algorithms : Array(EncryptionAlgorithmSpec) | Nil #

The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.


[View source]
def encryption_algorithms=(encryption_algorithms : Array(EncryptionAlgorithmSpec) | Nil) #

The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.


[View source]
def expiration_model : ExpirationModelType | Nil #

Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.


[View source]
def expiration_model=(expiration_model : ExpirationModelType | Nil) #

Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.


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

See Object#hash(hasher)


def key_agreement_algorithms : Array(KeyAgreementAlgorithmSpec) | Nil #

The key agreement algorithm used to derive a shared secret.


[View source]
def key_agreement_algorithms=(key_agreement_algorithms : Array(KeyAgreementAlgorithmSpec) | Nil) #

The key agreement algorithm used to derive a shared secret.


[View source]
def key_id : String #

The globally unique identifier for the KMS key.


[View source]
def key_id=(key_id : String) #

The globally unique identifier for the KMS key.


[View source]
def key_manager : KeyManagerType | Nil #

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.


[View source]
def key_manager=(key_manager : KeyManagerType | Nil) #

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.


[View source]
def key_spec : KeySpec | Nil #

Describes the type of key material in the KMS key.


[View source]
def key_spec=(key_spec : KeySpec | Nil) #

Describes the type of key material in the KMS key.


[View source]
def key_state : KeyState | Nil #

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.


[View source]
def key_state=(key_state : KeyState | Nil) #

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.


[View source]
def key_usage : KeyUsageType | Nil #

The cryptographic operations for which you can use the KMS key.


[View source]
def key_usage=(key_usage : KeyUsageType | Nil) #

The cryptographic operations for which you can use the KMS key.


[View source]
def mac_algorithms : Array(MacAlgorithmSpec) | Nil #

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.


[View source]
def mac_algorithms=(mac_algorithms : Array(MacAlgorithmSpec) | Nil) #

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.


[View source]
def multi_region : Bool | Nil #

Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.


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

Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.


[View source]
def multi_region_configuration : MultiRegionConfiguration | Nil #

Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

For more information about any listed KMS key, use the DescribeKey operation.

  • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

  • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

  • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.


[View source]
def multi_region_configuration=(multi_region_configuration : MultiRegionConfiguration | Nil) #

Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

For more information about any listed KMS key, use the DescribeKey operation.

  • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

  • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

  • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.


[View source]
def origin : OriginType | Nil #

The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.


[View source]
def origin=(origin : OriginType | Nil) #

The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.


[View source]
def pending_deletion_window_in_days : Int32 | Nil #

The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.


[View source]
def pending_deletion_window_in_days=(pending_deletion_window_in_days : Int32 | Nil) #

The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.


[View source]
def signing_algorithms : Array(SigningAlgorithmSpec) | Nil #

The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.


[View source]
def signing_algorithms=(signing_algorithms : Array(SigningAlgorithmSpec) | Nil) #

The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.


[View source]
def valid_to : Time | Nil #

The earliest time at which any imported key material permanently associated with this KMS key expires. When a key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and the ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.


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

The earliest time at which any imported key material permanently associated with this KMS key expires. When a key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and the ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.


[View source]
def validate! : Nil #

[View source]
def xks_key_configuration : XksKeyConfigurationType | Nil #

Information about the external key that is associated with a KMS key in an external key store.

For more information, see External key in the Key Management Service Developer Guide.


[View source]
def xks_key_configuration=(xks_key_configuration : XksKeyConfigurationType | Nil) #

Information about the external key that is associated with a KMS key in an external key store.

For more information, see External key in the Key Management Service Developer Guide.


[View source]