Class: Aws::KMS::Types::RotationsListEntry

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::RotationsListEntry

Defined in:

gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb

Overview

Each entry contains information about one of the key materials associated with a KMS key.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #expiration_model ⇒ String

  Indicates if the key material is configured to automatically expire.

• #import_state ⇒ String

  Indicates if the key material is currently imported into KMS.

• #key_id ⇒ String

  Unique identifier of the key.

• #key_material_description ⇒ String

  User-specified description of the key material.

• #key_material_id ⇒ String

  Unique identifier of the key material.

• #key_material_state ⇒ String

  There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION.

• #rotation_date ⇒ Time

  Date and time that the key material rotation completed.

• #rotation_type ⇒ String

  Identifies whether the key material rotation was a scheduled [automatic rotation][1] or an [on-demand rotation][2].

• #valid_to ⇒ Time

  Date and time at which the key material expires.

Instance Attribute Details

#expiration_model ⇒ String

Indicates if the key material is configured to automatically expire. There are two possible values for this field: KEY_MATERIAL_EXPIRES and KEY_MATERIAL_DOES_NOT_EXPIRE. For any key material that expires, the expiration date and time is indicated in ValidTo. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#import_state ⇒ String

Indicates if the key material is currently imported into KMS. It has two possible values: IMPORTED or PENDING_IMPORT. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ String

Unique identifier of the key.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#key_material_description ⇒ String

User-specified description of the key material. This field is only present for symmetric encryption KMS keys with EXTERNAL origin.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#key_material_id ⇒ String

Unique identifier of the key material.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#key_material_state ⇒ String

There are four possible values for this field: CURRENT, NON_CURRENT, PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION. KMS uses CURRENT key material for both encryption and decryption and NON_CURRENT key material only for decryption. PENDING_ROTATION identifies key material that has been imported for on-demand key rotation but the rotation hasn't completed. The key material state PENDING_MULTI_REGION_IMPORT_AND_ROTATION is unique to multi-region, symmetric encryption keys with imported key material. It indicates key material that has been imported into the primary Region key but not all of the replica Region keys. When this key material is imported in to all of the replica Region keys, the key material state will change to PENDING_ROTATION. Key material in PENDING_MULTI_REGION_IMPORT_AND_ROTATION or PENDING_ROTATION state is not permanently associated with the KMS key. You can delete this key material and import different key material in its place. The PENDING_MULTI_REGION_IMPORT_AND_ROTATION and PENDING_ROTATION values are only used in symmetric encryption keys with imported key material. The other values, CURRENT and NON_CURRENT, are used for all KMS keys that support automatic or on-demand key rotation.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_date ⇒ Time

Date and time that the key material rotation completed. Formatted as Unix time. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Returns:

• (Time)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_type ⇒ String

Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation. This field is not present for the first key material or an imported key material in PENDING_ROTATION state.

Returns:

• (String)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end

#valid_to ⇒ Time

Date and time at which the key material expires. This field is only present for symmetric encryption KMS keys with EXTERNAL origin in rotation list entries with an ExpirationModel value of KEY_MATERIAL_EXPIRES.

Returns:

• (Time)

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

class RotationsListEntry < Struct.new(
  :key_id,
  :key_material_id,
  :key_material_description,
  :import_state,
  :key_material_state,
  :expiration_model,
  :valid_to,
  :rotation_date,
  :rotation_type)
  SENSITIVE = []
  include Aws::Structure
end