Class: Aws::KMS::Types::ScheduleKeyDeletionRequest

Inherits:

Struct

Object
Struct
Aws::KMS::Types::ScheduleKeyDeletionRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-kms/types.rb

Overview

Note:

When making an API call, you may pass ScheduleKeyDeletionRequest data as a hash:

{
  key_id: "KeyIdType", # required
  pending_window_in_days: 1,
}

Instance Attribute Summary collapse

#key_id ⇒ String

The unique identifier of the customer master key (CMK) to delete.
#pending_window_in_days ⇒ Integer

The waiting period, specified in number of days.

Instance Attribute Details

#key_id ⇒ `String`

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

Specify the key ID or the Amazon Resource Name (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.

Returns:

(String)

# File 'lib/aws-sdk-kms/types.rb', line 2620

class ScheduleKeyDeletionRequest < Struct.new(
  :key_id,
  :pending_window_in_days)
  include Aws::Structure
end

#pending_window_in_days ⇒ `Integer`

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

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.