AutoKeyRotationDetails

class oci.key_management.models.AutoKeyRotationDetails(**kwargs)

Bases: object

The details of auto rotation schedule for the Key being create updated or imported.

Attributes:

LAST_ROTATION_STATUS_FAILED

A constant which can be used with the last_rotation_status property of a AutoKeyRotationDetails.

LAST_ROTATION_STATUS_IN_PROGRESS

A constant which can be used with the last_rotation_status property of a AutoKeyRotationDetails.

LAST_ROTATION_STATUS_SUCCESS

A constant which can be used with the last_rotation_status property of a AutoKeyRotationDetails.

last_rotation_message

Gets the last_rotation_message of this AutoKeyRotationDetails.

last_rotation_status

Gets the last_rotation_status of this AutoKeyRotationDetails.

rotation_interval_in_days

Gets the rotation_interval_in_days of this AutoKeyRotationDetails.

time_of_last_rotation

Gets the time_of_last_rotation of this AutoKeyRotationDetails.

time_of_next_rotation

Gets the time_of_next_rotation of this AutoKeyRotationDetails.

time_of_schedule_start

Gets the time_of_schedule_start of this AutoKeyRotationDetails. A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

Methods:

__init__(**kwargs)

Initializes a new AutoKeyRotationDetails object with values from keyword arguments.

LAST_ROTATION_STATUS_FAILED = 'FAILED'

A constant which can be used with the last_rotation_status property of a AutoKeyRotationDetails. This constant has a value of “FAILED”

LAST_ROTATION_STATUS_IN_PROGRESS = 'IN_PROGRESS'

A constant which can be used with the last_rotation_status property of a AutoKeyRotationDetails. This constant has a value of “IN_PROGRESS”

LAST_ROTATION_STATUS_SUCCESS = 'SUCCESS'

A constant which can be used with the last_rotation_status property of a AutoKeyRotationDetails. This constant has a value of “SUCCESS”

__init__(**kwargs)

Initializes a new AutoKeyRotationDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • rotation_interval_in_days (int) – The value to assign to the rotation_interval_in_days property of this AutoKeyRotationDetails.

  • time_of_schedule_start (datetime) – The value to assign to the time_of_schedule_start property of this AutoKeyRotationDetails.

  • time_of_next_rotation (datetime) – The value to assign to the time_of_next_rotation property of this AutoKeyRotationDetails.

  • time_of_last_rotation (datetime) – The value to assign to the time_of_last_rotation property of this AutoKeyRotationDetails.

  • last_rotation_status (str) – The value to assign to the last_rotation_status property of this AutoKeyRotationDetails. Allowed values for this property are: “SUCCESS”, “FAILED”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • last_rotation_message (str) – The value to assign to the last_rotation_message property of this AutoKeyRotationDetails.

property last_rotation_message

Gets the last_rotation_message of this AutoKeyRotationDetails. The last execution status message of auto key rotation.

Returns

The last_rotation_message of this AutoKeyRotationDetails.

Return type

str

property last_rotation_status

Gets the last_rotation_status of this AutoKeyRotationDetails. The status of last execution of auto key rotation.

Allowed values for this property are: “SUCCESS”, “FAILED”, “IN_PROGRESS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The last_rotation_status of this AutoKeyRotationDetails.

Return type

str

property rotation_interval_in_days

Gets the rotation_interval_in_days of this AutoKeyRotationDetails. The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.

Returns

The rotation_interval_in_days of this AutoKeyRotationDetails.

Return type

int

property time_of_last_rotation

Gets the time_of_last_rotation of this AutoKeyRotationDetails. A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.

Returns

The time_of_last_rotation of this AutoKeyRotationDetails.

Return type

datetime

property time_of_next_rotation

Gets the time_of_next_rotation of this AutoKeyRotationDetails. A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.

Returns

The time_of_next_rotation of this AutoKeyRotationDetails.

Return type

datetime

property time_of_schedule_start

Gets the time_of_schedule_start of this AutoKeyRotationDetails. A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

Returns

The time_of_schedule_start of this AutoKeyRotationDetails.

Return type

datetime