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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::ScheduleKeyDeletionResponse

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #deletion_date ⇒ Time

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

• #key_id ⇒ String

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

• #key_state ⇒ String

  The current status of the KMS key.

• #pending_window_in_days ⇒ Integer

  The waiting period before the KMS key is deleted.

Instance Attribute Details

#deletion_date ⇒ Time

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.

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

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

#key_id ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN

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

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

#key_state ⇒ String

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see [Key states of KMS keys] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/key-state.html

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

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

#pending_window_in_days ⇒ Integer

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.

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

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