RotationsListEntry¶
Structure Class¶
RotationsListEntry
dataclass
¶
Bases: _SerdeShape
Each entry contains information about one of the key materials associated with a KMS key.
Attributes¶
expiration_model
class-attribute
instance-attribute
¶
expiration_model: str | None = ...
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.
import_state
class-attribute
instance-attribute
¶
import_state: str | None = ...
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.
key_material_description
class-attribute
instance-attribute
¶
key_material_description: str | None = ...
User-specified description of the key material. This field is only
present for symmetric encryption KMS keys with EXTERNAL origin.
key_material_id
class-attribute
instance-attribute
¶
key_material_id: str | None = ...
Unique identifier of the key material.
key_material_state
class-attribute
instance-attribute
¶
key_material_state: str | None = ...
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.
rotation_date
class-attribute
instance-attribute
¶
rotation_date: datetime | None = ...
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.
rotation_type
class-attribute
instance-attribute
¶
rotation_type: str | None = ...
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.