Class: Aws::KMS::Types::GetKeyRotationStatusResponse

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

#key_id ⇒ String

Identifies the specified symmetric encryption KMS key.

Returns:

  • (String) 


3178
3179
3180
3181
3182
3183
3184
3185
3186
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3178

class GetKeyRotationStatusResponse < Struct.new(
  :key_rotation_enabled,
  :key_id,
  :rotation_period_in_days,
  :next_rotation_date,
  :on_demand_rotation_start_date)
  SENSITIVE = []
  include Aws::Structure
end

#key_rotation_enabled ⇒ Boolean

A Boolean value that specifies whether key rotation is enabled.

Returns:

  • (Boolean) 


3178
3179
3180
3181
3182
3183
3184
3185
3186
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3178

class GetKeyRotationStatusResponse < Struct.new(
  :key_rotation_enabled,
  :key_id,
  :rotation_period_in_days,
  :next_rotation_date,
  :on_demand_rotation_start_date)
  SENSITIVE = []
  include Aws::Structure
end

#next_rotation_date ⇒ Time

The next date that KMS will automatically rotate the key material.

Returns:

  • (Time) 


3178
3179
3180
3181
3182
3183
3184
3185
3186
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3178

class GetKeyRotationStatusResponse < Struct.new(
  :key_rotation_enabled,
  :key_id,
  :rotation_period_in_days,
  :next_rotation_date,
  :on_demand_rotation_start_date)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_rotation_start_date ⇒ Time

Identifies the date and time that an in progress on-demand rotation was initiated.

The KMS API follows an eventual consistency model due to the distributed nature of the system. As a result, there might be a slight delay between initiating on-demand key rotation and the rotation's completion. Once the on-demand rotation is complete, use ListKeyRotations to view the details of the on-demand rotation.

Returns:

  • (Time) 


3178
3179
3180
3181
3182
3183
3184
3185
3186
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3178

class GetKeyRotationStatusResponse < Struct.new(
  :key_rotation_enabled,
  :key_id,
  :rotation_period_in_days,
  :next_rotation_date,
  :on_demand_rotation_start_date)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_period_in_days ⇒ Integer

The number of days between each automatic rotation. The default value is 365 days.

Returns:

  • (Integer) 


3178
3179
3180
3181
3182
3183
3184
3185
3186
 
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 3178

class GetKeyRotationStatusResponse < Struct.new(
  :key_rotation_enabled,
  :key_id,
  :rotation_period_in_days,
  :next_rotation_date,
  :on_demand_rotation_start_date)
  SENSITIVE = []
  include Aws::Structure
end