« blib/lib/Paws/KMS/GetKeyRotationStatusResponse.pm
↑ Summary
blib/lib/Paws/KMS/GetParametersForImportResponse.pm »
| 1 | |||
| 2 | package Paws::KMS::GetParametersForImport; | ||
| 3 | use Moose; | ||
| 4 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has WrappingAlgorithm => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has WrappingKeySpec => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetParametersForImport'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::GetParametersForImportResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::KMS::GetParametersForImport - Arguments for method GetParametersForImport on L<Paws::KMS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetParametersForImport on the | ||
| 24 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 25 | as arguments to method GetParametersForImport. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetParametersForImport. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kms = Paws->service('KMS'); | ||
| 32 | # To retrieve the public key and import token for a customer master key (CMK) | ||
| 33 | # The following example retrieves the public key and import token for the | ||
| 34 | # specified CMK. | ||
| 35 | my $GetParametersForImportResponse = $kms->GetParametersForImport( | ||
| 36 | 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', | ||
| 37 | 'WrappingAlgorithm' => 'RSAES_OAEP_SHA_1', | ||
| 38 | 'WrappingKeySpec' => 'RSA_2048' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $ImportToken = $GetParametersForImportResponse->ImportToken; | ||
| 43 | my $KeyId = $GetParametersForImportResponse->KeyId; | ||
| 44 | my $ParametersValidTo = $GetParametersForImportResponse->ParametersValidTo; | ||
| 45 | my $PublicKey = $GetParametersForImportResponse->PublicKey; | ||
| 46 | |||
| 47 | # Returns a L<Paws::KMS::GetParametersForImportResponse> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/GetParametersForImport> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> KeyId => Str | ||
| 56 | |||
| 57 | The identifier of the symmetric CMK into which you will import key | ||
| 58 | material. The C<Origin> of the CMK must be C<EXTERNAL>. | ||
| 59 | |||
| 60 | Specify the key ID or key ARN of the CMK. | ||
| 61 | |||
| 62 | For example: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | Key ARN: | ||
| 73 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 74 | |||
| 75 | =back | ||
| 76 | |||
| 77 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> WrappingAlgorithm => Str | ||
| 82 | |||
| 83 | The algorithm you will use to encrypt the key material before importing | ||
| 84 | it with ImportKeyMaterial. For more information, see Encrypt the Key | ||
| 85 | Material | ||
| 86 | (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html) | ||
| 87 | in the I<AWS Key Management Service Developer Guide>. | ||
| 88 | |||
| 89 | Valid values are: C<"RSAES_PKCS1_V1_5">, C<"RSAES_OAEP_SHA_1">, C<"RSAES_OAEP_SHA_256"> | ||
| 90 | |||
| 91 | =head2 B<REQUIRED> WrappingKeySpec => Str | ||
| 92 | |||
| 93 | The type of wrapping key (public key) to return in the response. Only | ||
| 94 | 2048-bit RSA public keys are supported. | ||
| 95 | |||
| 96 | Valid values are: C<"RSA_2048"> | ||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method GetParametersForImport in L<Paws::KMS> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |