/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KMS::ScheduleKeyDeletion

NAME

Paws::KMS::ScheduleKeyDeletion - Arguments for method ScheduleKeyDeletion on Paws::KMS

DESCRIPTION

This class represents the parameters used for calling the method ScheduleKeyDeletion on the AWS Key Management Service service. Use the attributes of this class as arguments to method ScheduleKeyDeletion.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ScheduleKeyDeletion.

SYNOPSIS

my $kms = Paws->service('KMS');
# To schedule a customer master key (CMK) for deletion
# The following example schedules the specified CMK for deletion.
my $ScheduleKeyDeletionResponse = $kms->ScheduleKeyDeletion(
  'KeyId'               => '1234abcd-12ab-34cd-56ef-1234567890ab',
  'PendingWindowInDays' => 7
);

# Results:
my $DeletionDate = $ScheduleKeyDeletionResponse->DeletionDate;
my $KeyId        = $ScheduleKeyDeletionResponse->KeyId;

# Returns a L<Paws::KMS::ScheduleKeyDeletionResponse> object.

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 https://docs.aws.amazon.com/goto/WebAPI/kms/ScheduleKeyDeletion

ATTRIBUTES

REQUIRED KeyId => Str

The unique identifier of the customer master key (CMK) to delete.

Specify the key ID or key ARN of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

PendingWindowInDays => Int

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

If the CMK is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

SEE ALSO

This class forms part of Paws, documenting arguments for method ScheduleKeyDeletion in Paws::KMS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues