File Coverage

blib/lib/Paws/KMS/ImportKeyMaterial.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::KMS::ImportKeyMaterial;
3 1     1   291 use Moose;
  1         3  
  1         6  
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 1     1   5795 use MooseX::ClassAttribute;
  1         3  
  1         8  
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 Paws::KMS
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ImportKeyMaterial on the
26             AWS Key Management Service 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             As an example:
32              
33             $service_obj->ImportKeyMaterial(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> EncryptedKeyMaterial => Str
41              
42             The encrypted key material to import. It must be encrypted with the
43             public key that you received in the response to a previous
44             GetParametersForImport request, using the wrapping algorithm that you
45             specified in that request.
46              
47              
48              
49             =head2 ExpirationModel => Str
50              
51             Specifies whether the key material expires. The default is
52             C<KEY_MATERIAL_EXPIRES>, in which case you must include the C<ValidTo>
53             parameter. When this parameter is set to
54             C<KEY_MATERIAL_DOES_NOT_EXPIRE>, you must omit the C<ValidTo>
55             parameter.
56              
57             Valid values are: C<"KEY_MATERIAL_EXPIRES">, C<"KEY_MATERIAL_DOES_NOT_EXPIRE">
58              
59             =head2 B<REQUIRED> ImportToken => Str
60              
61             The import token that you received in the response to a previous
62             GetParametersForImport request. It must be from the same response that
63             contained the public key that you used to encrypt the key material.
64              
65              
66              
67             =head2 B<REQUIRED> KeyId => Str
68              
69             The identifier of the CMK to import the key material into. The CMK's
70             C<Origin> must be C<EXTERNAL>.
71              
72             A valid identifier is the unique key ID or the Amazon Resource Name
73             (ARN) of the CMK. Examples:
74              
75             =over
76              
77             =item *
78              
79             Unique key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab>
80              
81             =item *
82              
83             Key ARN:
84             C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>
85              
86             =back
87              
88              
89              
90              
91             =head2 ValidTo => Str
92              
93             The time at which the imported key material expires. When the key
94             material expires, AWS KMS deletes the key material and the CMK becomes
95             unusable. You must omit this parameter when the C<ExpirationModel>
96             parameter is set to C<KEY_MATERIAL_DOES_NOT_EXPIRE>. Otherwise it is
97             required.
98              
99              
100              
101              
102             =head1 SEE ALSO
103              
104             This class forms part of L<Paws>, documenting arguments for method ImportKeyMaterial in L<Paws::KMS>
105              
106             =head1 BUGS and CONTRIBUTIONS
107              
108             The source code is located here: https://github.com/pplu/aws-sdk-perl
109              
110             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
111              
112             =cut
113