| 1 | |||
| 2 | package Paws::KMS::ImportKeyMaterial; | ||
| 3 | use Moose; | ||
| 4 | has EncryptedKeyMaterial => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ExpirationModel => (is => 'ro', isa => 'Str'); | ||
| 6 | has ImportToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ValidTo => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ImportKeyMaterial'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::ImportKeyMaterialResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::KMS::ImportKeyMaterial - Arguments for method ImportKeyMaterial on L<Paws::KMS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ImportKeyMaterial on the | ||
| 26 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 27 | as arguments to method ImportKeyMaterial. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportKeyMaterial. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $kms = Paws->service('KMS'); | ||
| 34 | # To import key material into a customer master key (CMK) | ||
| 35 | # The following example imports key material into the specified CMK. | ||
| 36 | my $ImportKeyMaterialResponse = $kms->ImportKeyMaterial( | ||
| 37 | 'EncryptedKeyMaterial' => '<binary data>', | ||
| 38 | 'ExpirationModel' => 'KEY_MATERIAL_DOES_NOT_EXPIRE', | ||
| 39 | 'ImportToken' => '<binary data>', | ||
| 40 | 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' | ||
| 41 | ); | ||
| 42 | |||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/ImportKeyMaterial> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> EncryptedKeyMaterial => Str | ||
| 51 | |||
| 52 | The encrypted key material to import. The key material must be | ||
| 53 | encrypted with the public wrapping key that GetParametersForImport | ||
| 54 | returned, using the wrapping algorithm that you specified in the same | ||
| 55 | C<GetParametersForImport> request. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 ExpirationModel => Str | ||
| 60 | |||
| 61 | Specifies whether the key material expires. The default is | ||
| 62 | C<KEY_MATERIAL_EXPIRES>, in which case you must include the C<ValidTo> | ||
| 63 | parameter. When this parameter is set to | ||
| 64 | C<KEY_MATERIAL_DOES_NOT_EXPIRE>, you must omit the C<ValidTo> | ||
| 65 | parameter. | ||
| 66 | |||
| 67 | Valid values are: C<"KEY_MATERIAL_EXPIRES">, C<"KEY_MATERIAL_DOES_NOT_EXPIRE"> | ||
| 68 | |||
| 69 | =head2 B<REQUIRED> ImportToken => Str | ||
| 70 | |||
| 71 | The import token that you received in the response to a previous | ||
| 72 | GetParametersForImport request. It must be from the same response that | ||
| 73 | contained the public key that you used to encrypt the key material. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> KeyId => Str | ||
| 78 | |||
| 79 | The identifier of the symmetric CMK that receives the imported key | ||
| 80 | material. The CMK's C<Origin> must be C<EXTERNAL>. This must be the | ||
| 81 | same CMK specified in the C<KeyID> parameter of the corresponding | ||
| 82 | GetParametersForImport request. | ||
| 83 | |||
| 84 | Specify the key ID or key ARN of the CMK. | ||
| 85 | |||
| 86 | For example: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | Key ARN: | ||
| 97 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 ValidTo => Str | ||
| 106 | |||
| 107 | The time at which the imported key material expires. When the key | ||
| 108 | material expires, AWS KMS deletes the key material and the CMK becomes | ||
| 109 | unusable. You must omit this parameter when the C<ExpirationModel> | ||
| 110 | parameter is set to C<KEY_MATERIAL_DOES_NOT_EXPIRE>. Otherwise it is | ||
| 111 | required. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method ImportKeyMaterial in L<Paws::KMS> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |