From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

JROBINSON / Paws-0.46 / lib / Paws / KMS / EnableKeyRotation.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
—
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

              
package Paws::KMS::EnableKeyRotation;
  use Moose;
  has KeyId => (is => 'ro', isa => 'Str', required => 1);
  use MooseX::ClassAttribute;
  class_has _api_call => (isa => 'Str', is => 'ro', default => 'EnableKeyRotation');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
  class_has _result_key => (isa => 'Str', is => 'ro');
1;
### main pod documentation begin ###
=head1 NAME
Paws::KMS::EnableKeyRotation - Arguments for method EnableKeyRotation on L<Paws::KMS>
=head1 DESCRIPTION
This class represents the parameters used for calling the method EnableKeyRotation on the
L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class
as arguments to method EnableKeyRotation.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to EnableKeyRotation.
=head1 SYNOPSIS
    my $kms = Paws->service('KMS');
   # To enable automatic rotation of key material
   # The following example enables automatic annual rotation of the key material
   # for the specified CMK.
    $kms->EnableKeyRotation(
      'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' );
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.
For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/EnableKeyRotation>
=head1 ATTRIBUTES
=head2 B<REQUIRED> KeyId => Str
Identifies a symmetric customer master key (CMK). You cannot enable
automatic rotation of asymmetric CMKs
(https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks),
CMKs with imported key material
(https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html),
or CMKs in a custom key store
(https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
To enable or disable automatic rotation of a set of related
multi-Region keys
(https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-replica-key),
set the property on the primary key.
Specify the key ID or key ARN of the CMK.
For example:
=over
=item *
Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab>
=item *
Key ARN:
C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>
=back
To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
=head1 SEE ALSO
This class forms part of L<Paws>, documenting arguments for method EnableKeyRotation in L<Paws::KMS>
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
=cut