You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/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

Instance Attribute Details

#key_idString

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

To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

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

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

To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

Returns:

  • (String)


2104
2105
2106
2107
2108
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2104

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

#pending_window_in_daysInteger

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.

Returns:

  • (Integer)


2104
2105
2106
2107
2108
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 2104

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