AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::KMS::Types::ScheduleKeyDeletionResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deletion_dateTime

The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

Returns:

  • (Time)


4711
4712
4713
4714
4715
4716
4717
4718
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4711

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

#key_idString

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

Returns:

  • (String)


4711
4712
4713
4714
4715
4716
4717
4718
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4711

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

#key_stateString

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

Returns:

  • (String)


4711
4712
4713
4714
4715
4716
4717
4718
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4711

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

#pending_window_in_daysInteger

The waiting period before the KMS key is deleted.

If the KMS key 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.

Returns:

  • (Integer)


4711
4712
4713
4714
4715
4716
4717
4718
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4711

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