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

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::GetKeyRotationStatusResponse

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

  Identifies the specified symmetric encryption KMS key.

• #key_rotation_enabled ⇒ Boolean

  A Boolean value that specifies whether key rotation is enabled.

• #next_rotation_date ⇒ Time

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

• #on_demand_rotation_start_date ⇒ Time

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

• #rotation_period_in_days ⇒ Integer

  The number of days between each automatic rotation.

Instance Attribute Details

#key_id ⇒ String

Identifies the specified symmetric encryption KMS key.

Returns:

• (String)

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

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)

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

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)

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

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.

[1]: docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html

Returns:

• (Time)

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

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)

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

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