/** *

Contains metadata about a customer master key (CMK).

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

*/ export interface _KeyMetadata { /** *

The twelve-digit account ID of the AWS account that owns the CMK.

*/ AWSAccountId?: string; /** *

The globally unique identifier for the CMK.

*/ KeyId: string; /** *

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

*/ Arn?: string; /** *

The date and time when the CMK was created.

*/ CreationDate?: Date | string | number; /** *

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

*/ Enabled?: boolean; /** *

The description of the CMK.

*/ Description?: string; /** *

The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.

*/ KeyUsage?: 'ENCRYPT_DECRYPT' | string; /** *

The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

*/ KeyState?: 'Enabled' | 'Disabled' | 'PendingDeletion' | 'PendingImport' | string; /** *

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.

*/ DeletionDate?: Date | string | number; /** *

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

*/ ValidTo?: Date | string | number; /** *

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

*/ Origin?: 'AWS_KMS' | 'EXTERNAL' | string; /** *

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

*/ ExpirationModel?: 'KEY_MATERIAL_EXPIRES' | 'KEY_MATERIAL_DOES_NOT_EXPIRE' | string; /** *

The CMK's manager. CMKs are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

*/ KeyManager?: 'AWS' | 'CUSTOMER' | string; } export interface _UnmarshalledKeyMetadata extends _KeyMetadata { /** *

The date and time when the CMK was created.

*/ CreationDate?: Date; /** *

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.

*/ DeletionDate?: Date; /** *

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

*/ ValidTo?: Date; }