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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

 my $kms = Paws->service('KMS');
# To retrieve the public key and import token for a customer master key (CMK)
# The following example retrieves the public key and import token for the
# specified CMK.
 my $GetParametersForImportResponse = $kms->GetParametersForImport(
   'KeyId'             => '1234abcd-12ab-34cd-56ef-1234567890ab',
   'WrappingAlgorithm' => 'RSAES_OAEP_SHA_1',
   'WrappingKeySpec'   => 'RSA_2048'
 );

 # Results:
 my $ImportToken       = $GetParametersForImportResponse->ImportToken;
 my $KeyId             = $GetParametersForImportResponse->KeyId;
 my $ParametersValidTo = $GetParametersForImportResponse->ParametersValidTo;
 my $PublicKey         = $GetParametersForImportResponse->PublicKey;

 # Returns a L<Paws::KMS::GetParametersForImportResponse> object.

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/GetParametersForImport

ATTRIBUTES

REQUIRED KeyId => Str

The identifier of the symmetric CMK into which you will import key material. The Origin of the CMK must be EXTERNAL.

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.

REQUIRED WrappingAlgorithm => Str

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html) in the AWS Key Management Service Developer Guide.

Valid values are: "RSAES_PKCS1_V1_5", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256"

REQUIRED WrappingKeySpec => Str

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

Valid values are: "RSA_2048"

SEE ALSO

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