« blib/lib/Paws/KMS/DisconnectCustomKeyStoreResponse.pm
↑ Summary
blib/lib/Paws/KMS/EnableKeyRotation.pm »
| 1 | |||
| 2 | package Paws::KMS::EnableKey; | ||
| 3 | use Moose; | ||
| 4 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'EnableKey'); | ||
| 9 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 10 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::KMS::EnableKey - Arguments for method EnableKey on L<Paws::KMS> | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | This class represents the parameters used for calling the method EnableKey on the | ||
| 22 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 23 | as arguments to method EnableKey. | ||
| 24 | |||
| 25 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to EnableKey. | ||
| 26 | |||
| 27 | =head1 SYNOPSIS | ||
| 28 | |||
| 29 | my $kms = Paws->service('KMS'); | ||
| 30 | # To enable a customer master key (CMK) | ||
| 31 | # The following example enables the specified CMK. | ||
| 32 | $kms->EnableKey( 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' ); | ||
| 33 | |||
| 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 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/EnableKey> | ||
| 37 | |||
| 38 | =head1 ATTRIBUTES | ||
| 39 | |||
| 40 | |||
| 41 | =head2 B<REQUIRED> KeyId => Str | ||
| 42 | |||
| 43 | Identifies the customer master key (CMK) to enable. | ||
| 44 | |||
| 45 | Specify the key ID or key ARN of the CMK. | ||
| 46 | |||
| 47 | For example: | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Key ARN: | ||
| 58 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 59 | |||
| 60 | =back | ||
| 61 | |||
| 62 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, documenting arguments for method EnableKey in L<Paws::KMS> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |