| 1 | |||
| 2 | package Paws::KMS::ScheduleKeyDeletion; | ||
| 3 | use Moose; | ||
| 4 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has PendingWindowInDays => (is => 'ro', isa => 'Int'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::KMS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method ScheduleKeyDeletion on the | ||
| 23 | L<AWS Key Management Service|Paws::KMS> 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 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $kms = Paws->service('KMS'); | ||
| 31 | # To schedule a customer master key (CMK) for deletion | ||
| 32 | # The following example schedules the specified CMK for deletion. | ||
| 33 | my $ScheduleKeyDeletionResponse = $kms->ScheduleKeyDeletion( | ||
| 34 | 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', | ||
| 35 | 'PendingWindowInDays' => 7 | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $DeletionDate = $ScheduleKeyDeletionResponse->DeletionDate; | ||
| 40 | my $KeyId = $ScheduleKeyDeletionResponse->KeyId; | ||
| 41 | |||
| 42 | # Returns a L<Paws::KMS::ScheduleKeyDeletionResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/ScheduleKeyDeletion> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> KeyId => Str | ||
| 51 | |||
| 52 | The unique identifier of the customer master key (CMK) to delete. | ||
| 53 | |||
| 54 | Specify the key ID or key ARN of the CMK. | ||
| 55 | |||
| 56 | For example: | ||
| 57 | |||
| 58 | =over | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | Key ARN: | ||
| 67 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 PendingWindowInDays => Int | ||
| 76 | |||
| 77 | The waiting period, specified in number of days. After the waiting | ||
| 78 | period ends, AWS KMS deletes the customer master key (CMK). | ||
| 79 | |||
| 80 | If the CMK is a multi-Region primary key with replicas, the waiting | ||
| 81 | period begins when the last of its replica keys is deleted. Otherwise, | ||
| 82 | the waiting period begins immediately. | ||
| 83 | |||
| 84 | This value is optional. If you include a value, it must be between 7 | ||
| 85 | and 30, inclusive. If you do not include a value, it defaults to 30. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method ScheduleKeyDeletion in L<Paws::KMS> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |