File Coverage

blib/lib/Paws/KMS/ScheduleKeyDeletion.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::ScheduleKeyDeletion;
3 1     1   440 use Moose;
  1         3  
  1         6  
4             has KeyId => (is => 'ro', isa => 'Str', required => 1);
5             has PendingWindowInDays => (is => 'ro', isa => 'Int');
6              
7 1     1   5881 use MooseX::ClassAttribute;
  1         3  
  1         7  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ScheduleKeyDeletion');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::ScheduleKeyDeletionResponse');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::KMS::ScheduleKeyDeletion - Arguments for method ScheduleKeyDeletion on Paws::KMS
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method ScheduleKeyDeletion on the
23             AWS Key Management Service service. Use the attributes of this class
24             as arguments to method ScheduleKeyDeletion.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ScheduleKeyDeletion.
27              
28             As an example:
29              
30             $service_obj->ScheduleKeyDeletion(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 B<REQUIRED> KeyId => Str
38              
39             The unique identifier for the customer master key (CMK) to delete.
40              
41             To specify this value, use the unique key ID or the Amazon Resource
42             Name (ARN) of the CMK. Examples:
43              
44             =over
45              
46             =item *
47              
48             Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
49              
50             =item *
51              
52             Key ARN:
53             arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
54              
55             =back
56              
57             To obtain the unique key ID and key ARN for a given CMK, use ListKeys
58             or DescribeKey.
59              
60              
61              
62             =head2 PendingWindowInDays => Int
63              
64             The waiting period, specified in number of days. After the waiting
65             period ends, AWS KMS deletes the customer master key (CMK).
66              
67             This value is optional. If you include a value, it must be between 7
68             and 30, inclusive. If you do not include a value, it defaults to 30.
69              
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, documenting arguments for method ScheduleKeyDeletion in L<Paws::KMS>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84