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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (Time) 


4937
4938
4939
4940
4941
4942
4943
4944
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4937

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.

Returns:

  • (String) 


4937
4938
4939
4940
4941
4942
4943
4944
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4937

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.

Returns:

  • (String) 


4937
4938
4939
4940
4941
4942
4943
4944
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4937

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.

Returns:

  • (Integer) 


4937
4938
4939
4940
4941
4942
4943
4944
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 4937

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