blib/lib/Paws/KMS/KeyMetadata.pm untested

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 25 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::KMS::KeyMetadata;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str');
5 has AWSAccountId => (is => 'ro', isa => 'Str');
6 has CloudHsmClusterId => (is => 'ro', isa => 'Str');
7 has CreationDate => (is => 'ro', isa => 'Str');
8 has CustomerMasterKeySpec => (is => 'ro', isa => 'Str');
9 has CustomKeyStoreId => (is => 'ro', isa => 'Str');
10 has DeletionDate => (is => 'ro', isa => 'Str');
11 has Description => (is => 'ro', isa => 'Str');
12 has Enabled => (is => 'ro', isa => 'Bool');
13 has EncryptionAlgorithms => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14 has ExpirationModel => (is => 'ro', isa => 'Str');
15 has KeyId => (is => 'ro', isa => 'Str', required => 1);
16 has KeyManager => (is => 'ro', isa => 'Str');
17 has KeyState => (is => 'ro', isa => 'Str');
18 has KeyUsage => (is => 'ro', isa => 'Str');
19 has MultiRegion => (is => 'ro', isa => 'Bool');
20 has MultiRegionConfiguration => (is => 'ro', isa => 'Paws::KMS::MultiRegionConfiguration');
21 has Origin => (is => 'ro', isa => 'Str');
22 has PendingDeletionWindowInDays => (is => 'ro', isa => 'Int');
23 has SigningAlgorithms => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
24 has ValidTo => (is => 'ro', isa => 'Str');
25  
26 1;
27  
28 ### main pod documentation begin ###
29  
30 =head1 NAME
31  
32 Paws::KMS::KeyMetadata
33  
34 =head1 USAGE
35  
36 This class represents one of two things:
37  
38 =head3 Arguments in a call to a service
39  
40 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
41 Each attribute should be used as a named argument in the calls that expect this type of object.
42  
43 As an example, if Att1 is expected to be a Paws::KMS::KeyMetadata object:
44  
45 $service_obj->Method(Att1 => { Arn => $value, ..., ValidTo => $value });
46  
47 =head3 Results returned from an API call
48  
49 Use accessors for each attribute. If Att1 is expected to be an Paws::KMS::KeyMetadata object:
50  
51 $result = $service_obj->Method(...);
52 $result->Att1->Arn
53  
54 =head1 DESCRIPTION
55  
56 Contains metadata about a customer master key (CMK).
57  
58 This data type is used as a response element for the CreateKey and
59 DescribeKey operations.
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 Arn => Str
65  
66 The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key
67 Management Service (AWS KMS)
68 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms)
69 in the Example ARNs section of the I<AWS General Reference>.
70  
71  
72 =head2 AWSAccountId => Str
73  
74 The twelve-digit account ID of the AWS account that owns the CMK.
75  
76  
77 =head2 CloudHsmClusterId => Str
78  
79 The cluster ID of the AWS CloudHSM cluster that contains the key
80 material for the CMK. When you create a CMK in a custom key store
81 (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),
82 AWS KMS creates the key material for the CMK in the associated AWS
83 CloudHSM cluster. This value is present only when the CMK is created in
84 a custom key store.
85  
86  
87 =head2 CreationDate => Str
88  
89 The date and time when the CMK was created.
90  
91  
92 =head2 CustomerMasterKeySpec => Str
93  
94 Describes the type of key material in the CMK.
95  
96  
97 =head2 CustomKeyStoreId => Str
98  
99 A unique identifier for the custom key store
100 (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
101 that contains the CMK. This value is present only when the CMK is
102 created in a custom key store.
103  
104  
105 =head2 DeletionDate => Str
106  
107 The date and time after which AWS KMS deletes this CMK. This value is
108 present only when the CMK is scheduled for deletion, that is, when its
109 C<KeyState> is C<PendingDeletion>.
110  
111 When the primary key in a multi-Region key is scheduled for deletion
112 but still has replica keys, its key state is C<PendingReplicaDeletion>
113 and the length of its waiting period is displayed in the
114 C<PendingDeletionWindowInDays> field.
115  
116  
117 =head2 Description => Str
118  
119 The description of the CMK.
120  
121  
122 =head2 Enabled => Bool
123  
124 Specifies whether the CMK is enabled. When C<KeyState> is C<Enabled>
125 this value is true, otherwise it is false.
126  
127  
128 =head2 EncryptionAlgorithms => ArrayRef[Str|Undef]
129  
130 The encryption algorithms that the CMK supports. You cannot use the CMK
131 with other encryption algorithms within AWS KMS.
132  
133 This value is present only when the C<KeyUsage> of the CMK is
134 C<ENCRYPT_DECRYPT>.
135  
136  
137 =head2 ExpirationModel => Str
138  
139 Specifies whether the CMK's key material expires. This value is present
140 only when C<Origin> is C<EXTERNAL>, otherwise this value is omitted.
141  
142  
143 =head2 B<REQUIRED> KeyId => Str
144  
145 The globally unique identifier for the CMK.
146  
147  
148 =head2 KeyManager => Str
149  
150 The manager of the CMK. CMKs in your AWS account are either customer
151 managed or AWS managed. For more information about the difference, see
152 Customer Master Keys
153 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys)
154 in the I<AWS Key Management Service Developer Guide>.
155  
156  
157 =head2 KeyState => Str
158  
159 The current status of the CMK.
160  
161 For more information about how key state affects the use of a CMK, see
162 Key state: Effect on your CMK
163 (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
164 in the I<AWS Key Management Service Developer Guide>.
165  
166  
167 =head2 KeyUsage => Str
168  
169 The cryptographic operations
170 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
171 for which you can use the CMK.
172  
173  
174 =head2 MultiRegion => Bool
175  
176 Indicates whether the CMK is a multi-Region (C<True>) or regional
177 (C<False>) key. This value is C<True> for multi-Region primary and
178 replica CMKs and C<False> for regional CMKs.
179  
180 For more information about multi-Region keys, see Using multi-Region
181 keys
182 (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)
183 in the I<AWS Key Management Service Developer Guide>.
184  
185  
186 =head2 MultiRegionConfiguration => L<Paws::KMS::MultiRegionConfiguration>
187  
188 Lists the primary and replica CMKs in same multi-Region CMK. This field
189 is present only when the value of the C<MultiRegion> field is C<True>.
190  
191 For more information about any listed CMK, use the DescribeKey
192 operation.
193  
194 =over
195  
196 =item *
197  
198 C<MultiRegionKeyType> indicates whether the CMK is a C<PRIMARY> or
199 C<REPLICA> key.
200  
201 =item *
202  
203 C<PrimaryKey> displays the key ARN and Region of the primary key. This
204 field displays the current CMK if it is the primary key.
205  
206 =item *
207  
208 C<ReplicaKeys> displays the key ARNs and Regions of all replica keys.
209 This field includes the current CMK if it is a replica key.
210  
211 =back
212  
213  
214  
215 =head2 Origin => Str
216  
217 The source of the CMK's key material. When this value is C<AWS_KMS>,
218 AWS KMS created the key material. When this value is C<EXTERNAL>, the
219 key material was imported from your existing key management
220 infrastructure or the CMK lacks key material. When this value is
221 C<AWS_CLOUDHSM>, the key material was created in the AWS CloudHSM
222 cluster associated with a custom key store.
223  
224  
225 =head2 PendingDeletionWindowInDays => Int
226  
227 The waiting period before the primary key in a multi-Region key is
228 deleted. This waiting period begins when the last of its replica keys
229 is deleted. This value is present only when the C<KeyState> of the CMK
230 is C<PendingReplicaDeletion>. That indicates that the CMK is the
231 primary key in a multi-Region key, it is scheduled for deletion, and it
232 still has existing replica keys.
233  
234 When a regional CMK or a replica key in a multi-Region key is scheduled
235 for deletion, its deletion date is displayed in the C<DeletionDate>
236 field. However, when the primary key in a multi-Region key is scheduled
237 for deletion, its waiting period doesn't begin until all of its replica
238 keys are deleted. This value displays that waiting period. When the
239 last replica key in the multi-Region key is deleted, the C<KeyState> of
240 the scheduled primary key changes from C<PendingReplicaDeletion> to
241 C<PendingDeletion> and the deletion date appears in the C<DeletionDate>
242 field.
243  
244  
245 =head2 SigningAlgorithms => ArrayRef[Str|Undef]
246  
247 The signing algorithms that the CMK supports. You cannot use the CMK
248 with other signing algorithms within AWS KMS.
249  
250 This field appears only when the C<KeyUsage> of the CMK is
251 C<SIGN_VERIFY>.
252  
253  
254 =head2 ValidTo => Str
255  
256 The time at which the imported key material expires. When the key
257 material expires, AWS KMS deletes the key material and the CMK becomes
258 unusable. This value is present only for CMKs whose C<Origin> is
259 C<EXTERNAL> and whose C<ExpirationModel> is C<KEY_MATERIAL_EXPIRES>,
260 otherwise this value is omitted.
261  
262  
263  
264 =head1 SEE ALSO
265  
266 This class forms part of L<Paws>, describing an object used in L<Paws::KMS>
267  
268 =head1 BUGS and CONTRIBUTIONS
269  
270 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
271  
272 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
273  
274 =cut
275