/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KMS::ImportKeyMaterial

NAME

Paws::KMS::ImportKeyMaterial - Arguments for method ImportKeyMaterial on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method ImportKeyMaterial on the AWS Key Management Service service. Use the attributes of this class as arguments to method ImportKeyMaterial.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportKeyMaterial.

SYNOPSIS

my $kms = Paws->service('KMS');
# To import key material into a customer master key (CMK)
# The following example imports key material into the specified CMK.
my $ImportKeyMaterialResponse = $kms->ImportKeyMaterial(
  'EncryptedKeyMaterial' => '<binary data>',
  'ExpirationModel'      => 'KEY_MATERIAL_DOES_NOT_EXPIRE',
  'ImportToken'          => '<binary data>',
  'KeyId'                => '1234abcd-12ab-34cd-56ef-1234567890ab'
);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kms/ImportKeyMaterial

ATTRIBUTES

REQUIRED EncryptedKeyMaterial => Str

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

ExpirationModel => Str

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Valid values are: "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE"

REQUIRED ImportToken => Str

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

REQUIRED KeyId => Str

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

Specify the key ID or key ARN of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

SEE ALSO

This class forms part of Paws, documenting arguments for method ImportKeyMaterial 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