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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_id ⇒ String

  The unique identifier of the KMS key 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 KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Returns:

• (String)

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

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

#pending_window_in_days ⇒ Integer

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, 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. You can use the [ ‘kms:ScheduleKeyDeletionPendingWindowInDays` ][1] condition key to further constrain the values that principals can specify in the `PendingWindowInDays` parameter.

[1]: docs.aws.amazon.com/kms/latest/developerguide/conditions-kms.html#conditions-kms-schedule-key-deletion-pending-window-in-days

Returns:

• (Integer)

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

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