File Coverage

blib/lib/Paws/KMS/KeyMetadata.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::KMS::KeyMetadata;
2 1     1   590 use Moose;
  1         5  
  1         13  
3             has Arn => (is => 'ro', isa => 'Str');
4             has AWSAccountId => (is => 'ro', isa => 'Str');
5             has CreationDate => (is => 'ro', isa => 'Str');
6             has DeletionDate => (is => 'ro', isa => 'Str');
7             has Description => (is => 'ro', isa => 'Str');
8             has Enabled => (is => 'ro', isa => 'Bool');
9             has ExpirationModel => (is => 'ro', isa => 'Str');
10             has KeyId => (is => 'ro', isa => 'Str', required => 1);
11             has KeyManager => (is => 'ro', isa => 'Str');
12             has KeyState => (is => 'ro', isa => 'Str');
13             has KeyUsage => (is => 'ro', isa => 'Str');
14             has Origin => (is => 'ro', isa => 'Str');
15             has ValidTo => (is => 'ro', isa => 'Str');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::KMS::KeyMetadata
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::KMS::KeyMetadata object:
34              
35             $service_obj->Method(Att1 => { Arn => $value, ..., ValidTo => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::KMS::KeyMetadata object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->Arn
43              
44             =head1 DESCRIPTION
45              
46             Contains metadata about a customer master key (CMK).
47              
48             This data type is used as a response element for the CreateKey and
49             DescribeKey operations.
50              
51             =head1 ATTRIBUTES
52              
53              
54             =head2 Arn => Str
55              
56             The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key
57             Management Service (AWS KMS) in the Example ARNs section of the I<AWS
58             General Reference>.
59              
60              
61             =head2 AWSAccountId => Str
62              
63             The twelve-digit account ID of the AWS account that owns the CMK.
64              
65              
66             =head2 CreationDate => Str
67              
68             The date and time when the CMK was created.
69              
70              
71             =head2 DeletionDate => Str
72              
73             The date and time after which AWS KMS deletes the CMK. This value is
74             present only when C<KeyState> is C<PendingDeletion>, otherwise this
75             value is omitted.
76              
77              
78             =head2 Description => Str
79              
80             The description of the CMK.
81              
82              
83             =head2 Enabled => Bool
84              
85             Specifies whether the CMK is enabled. When C<KeyState> is C<Enabled>
86             this value is true, otherwise it is false.
87              
88              
89             =head2 ExpirationModel => Str
90              
91             Specifies whether the CMK's key material expires. This value is present
92             only when C<Origin> is C<EXTERNAL>, otherwise this value is omitted.
93              
94              
95             =head2 B<REQUIRED> KeyId => Str
96              
97             The globally unique identifier for the CMK.
98              
99              
100             =head2 KeyManager => Str
101              
102             The CMK's manager. CMKs are either customer-managed or AWS-managed. For
103             more information about the difference, see Customer Master Keys in the
104             I<AWS Key Management Service Developer Guide>.
105              
106              
107             =head2 KeyState => Str
108              
109             The state of the CMK.
110              
111             For more information about how key state affects the use of a CMK, see
112             How Key State Affects the Use of a Customer Master Key in the I<AWS Key
113             Management Service Developer Guide>.
114              
115              
116             =head2 KeyUsage => Str
117              
118             The cryptographic operations for which you can use the CMK. Currently
119             the only allowed value is C<ENCRYPT_DECRYPT>, which means you can use
120             the CMK for the Encrypt and Decrypt operations.
121              
122              
123             =head2 Origin => Str
124              
125             The source of the CMK's key material. When this value is C<AWS_KMS>,
126             AWS KMS created the key material. When this value is C<EXTERNAL>, the
127             key material was imported from your existing key management
128             infrastructure or the CMK lacks key material.
129              
130              
131             =head2 ValidTo => Str
132              
133             The time at which the imported key material expires. When the key
134             material expires, AWS KMS deletes the key material and the CMK becomes
135             unusable. This value is present only for CMKs whose C<Origin> is
136             C<EXTERNAL> and whose C<ExpirationModel> is C<KEY_MATERIAL_EXPIRES>,
137             otherwise this value is omitted.
138              
139              
140              
141             =head1 SEE ALSO
142              
143             This class forms part of L<Paws>, describing an object used in L<Paws::KMS>
144              
145             =head1 BUGS and CONTRIBUTIONS
146              
147             The source code is located here: https://github.com/pplu/aws-sdk-perl
148              
149             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
150              
151             =cut
152