NAME

Paws::KMS::KeyMetadata

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::KMS::KeyMetadata object:

  $service_obj->Method(Att1 => { Arn => $value, ..., ValidTo => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::KMS::KeyMetadata object:

  $result = $service_obj->Method(...);
  $result->Att1->Arn

DESCRIPTION

Contains metadata about a customer master key (CMK).

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

ATTRIBUTES

Arn => Str

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms) in the Example ARNs section of the AWS General Reference.

AWSAccountId => Str

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

CloudHsmClusterId => Str

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

CreationDate => Str

The date and time when the CMK was created.

CustomerMasterKeySpec => Str

Describes the type of key material in the CMK.

CustomKeyStoreId => Str

A unique identifier for the custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) that contains the CMK. This value is present only when the CMK is created in a custom key store.

DeletionDate => Str

The date and time after which AWS KMS deletes this CMK. This value is present only when the CMK 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.

Description => Str

The description of the CMK.

Enabled => Bool

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

EncryptionAlgorithms => ArrayRef[Str|Undef]

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

This value is present only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

ExpirationModel => Str

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

REQUIRED KeyId => Str

The globally unique identifier for the CMK.

KeyManager => Str

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) in the AWS Key Management Service Developer Guide.

KeyState => Str

The current status of the CMK.

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

KeyUsage => Str

The cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the CMK.

MultiRegion => Bool

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

For more information about multi-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the AWS Key Management Service Developer Guide.

MultiRegionConfiguration => Paws::KMS::MultiRegionConfiguration

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

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

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

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

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

Origin => Str

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. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

PendingDeletionWindowInDays => Int

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 CMK is PendingReplicaDeletion. That indicates that the CMK is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a regional CMK or a replica key in a multi-Region 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.

SigningAlgorithms => ArrayRef[Str|Undef]

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

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

ValidTo => Str

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::KMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws