InstanceMaintenanceEvent¶

class oci.core.models.InstanceMaintenanceEvent(**kwargs)¶

Bases: object

It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.

Attributes

`ALTERNATIVE_RESOLUTION_ACTIONS_REBOOT_MIGRATION`	A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEvent.
`ALTERNATIVE_RESOLUTION_ACTIONS_TERMINATE`	A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEvent.
`CREATED_BY_CUSTOMER`	A constant which can be used with the created_by property of a InstanceMaintenanceEvent.
`CREATED_BY_SYSTEM`	A constant which can be used with the created_by property of a InstanceMaintenanceEvent.
`INSTANCE_ACTION_NONE`	A constant which can be used with the instance_action property of a InstanceMaintenanceEvent.
`INSTANCE_ACTION_REBOOT_MIGRATION`	A constant which can be used with the instance_action property of a InstanceMaintenanceEvent.
`INSTANCE_ACTION_STOP`	A constant which can be used with the instance_action property of a InstanceMaintenanceEvent.
`INSTANCE_ACTION_TERMINATE`	A constant which can be used with the instance_action property of a InstanceMaintenanceEvent.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent.
`LIFECYCLE_STATE_PROCESSING`	A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent.
`LIFECYCLE_STATE_SCHEDULED`	A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent.
`LIFECYCLE_STATE_STARTED`	A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent.
`MAINTENANCE_CATEGORY_EMERGENCY`	A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent.
`MAINTENANCE_CATEGORY_FLEXIBLE`	A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent.
`MAINTENANCE_CATEGORY_MANDATORY`	A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent.
`MAINTENANCE_CATEGORY_NOTIFICATION`	A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent.
`MAINTENANCE_CATEGORY_OPTIONAL`	A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent.
`MAINTENANCE_REASON_DECOMMISSION`	A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent.
`MAINTENANCE_REASON_ENVIRONMENTAL_FACTORS`	A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent.
`MAINTENANCE_REASON_EVACUATION`	A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent.
`MAINTENANCE_REASON_FIRMWARE_UPDATE`	A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent.
`MAINTENANCE_REASON_HARDWARE_REPLACEMENT`	A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent.
`MAINTENANCE_REASON_SECURITY_UPDATE`	A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent.
`additional_details`	Gets the additional_details of this InstanceMaintenanceEvent.
`alternative_resolution_actions`	[Required] Gets the alternative_resolution_actions of this InstanceMaintenanceEvent.
`can_delete_local_storage`	Gets the can_delete_local_storage of this InstanceMaintenanceEvent.
`can_reschedule`	[Required] Gets the can_reschedule of this InstanceMaintenanceEvent.
`compartment_id`	[Required] Gets the compartment_id of this InstanceMaintenanceEvent.
`correlation_token`	Gets the correlation_token of this InstanceMaintenanceEvent.
`created_by`	[Required] Gets the created_by of this InstanceMaintenanceEvent.
`defined_tags`	Gets the defined_tags of this InstanceMaintenanceEvent.
`description`	Gets the description of this InstanceMaintenanceEvent.
`display_name`	Gets the display_name of this InstanceMaintenanceEvent.
`estimated_duration`	Gets the estimated_duration of this InstanceMaintenanceEvent.
`freeform_tags`	Gets the freeform_tags of this InstanceMaintenanceEvent.
`id`	[Required] Gets the id of this InstanceMaintenanceEvent.
`instance_action`	[Required] Gets the instance_action of this InstanceMaintenanceEvent.
`instance_id`	[Required] Gets the instance_id of this InstanceMaintenanceEvent.
`lifecycle_details`	Gets the lifecycle_details of this InstanceMaintenanceEvent.
`lifecycle_state`	[Required] Gets the lifecycle_state of this InstanceMaintenanceEvent.
`maintenance_category`	[Required] Gets the maintenance_category of this InstanceMaintenanceEvent.
`maintenance_reason`	[Required] Gets the maintenance_reason of this InstanceMaintenanceEvent.
`start_window_duration`	Gets the start_window_duration of this InstanceMaintenanceEvent.
`time_created`	[Required] Gets the time_created of this InstanceMaintenanceEvent.
`time_finished`	Gets the time_finished of this InstanceMaintenanceEvent.
`time_hard_due_date`	Gets the time_hard_due_date of this InstanceMaintenanceEvent.
`time_started`	Gets the time_started of this InstanceMaintenanceEvent.
`time_window_start`	[Required] Gets the time_window_start of this InstanceMaintenanceEvent.

Methods

__init__(**kwargs) Initializes a new InstanceMaintenanceEvent object with values from keyword arguments.

ALTERNATIVE_RESOLUTION_ACTIONS_REBOOT_MIGRATION = 'REBOOT_MIGRATION'¶: A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEvent. This constant has a value of “REBOOT_MIGRATION”

ALTERNATIVE_RESOLUTION_ACTIONS_TERMINATE = 'TERMINATE'¶: A constant which can be used with the alternative_resolution_actions property of a InstanceMaintenanceEvent. This constant has a value of “TERMINATE”

CREATED_BY_CUSTOMER = 'CUSTOMER'¶: A constant which can be used with the created_by property of a InstanceMaintenanceEvent. This constant has a value of “CUSTOMER”

CREATED_BY_SYSTEM = 'SYSTEM'¶: A constant which can be used with the created_by property of a InstanceMaintenanceEvent. This constant has a value of “SYSTEM”

INSTANCE_ACTION_NONE = 'NONE'¶: A constant which can be used with the instance_action property of a InstanceMaintenanceEvent. This constant has a value of “NONE”

INSTANCE_ACTION_REBOOT_MIGRATION = 'REBOOT_MIGRATION'¶: A constant which can be used with the instance_action property of a InstanceMaintenanceEvent. This constant has a value of “REBOOT_MIGRATION”

INSTANCE_ACTION_STOP = 'STOP'¶: A constant which can be used with the instance_action property of a InstanceMaintenanceEvent. This constant has a value of “STOP”

INSTANCE_ACTION_TERMINATE = 'TERMINATE'¶: A constant which can be used with the instance_action property of a InstanceMaintenanceEvent. This constant has a value of “TERMINATE”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent. This constant has a value of “CANCELED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent. This constant has a value of “FAILED”

LIFECYCLE_STATE_PROCESSING = 'PROCESSING'¶: A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent. This constant has a value of “PROCESSING”

LIFECYCLE_STATE_SCHEDULED = 'SCHEDULED'¶: A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent. This constant has a value of “SCHEDULED”

LIFECYCLE_STATE_STARTED = 'STARTED'¶: A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent. This constant has a value of “STARTED”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a InstanceMaintenanceEvent. This constant has a value of “SUCCEEDED”

MAINTENANCE_CATEGORY_EMERGENCY = 'EMERGENCY'¶: A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent. This constant has a value of “EMERGENCY”

MAINTENANCE_CATEGORY_FLEXIBLE = 'FLEXIBLE'¶: A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent. This constant has a value of “FLEXIBLE”

MAINTENANCE_CATEGORY_MANDATORY = 'MANDATORY'¶: A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent. This constant has a value of “MANDATORY”

MAINTENANCE_CATEGORY_NOTIFICATION = 'NOTIFICATION'¶: A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent. This constant has a value of “NOTIFICATION”

MAINTENANCE_CATEGORY_OPTIONAL = 'OPTIONAL'¶: A constant which can be used with the maintenance_category property of a InstanceMaintenanceEvent. This constant has a value of “OPTIONAL”

MAINTENANCE_REASON_DECOMMISSION = 'DECOMMISSION'¶: A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent. This constant has a value of “DECOMMISSION”

MAINTENANCE_REASON_ENVIRONMENTAL_FACTORS = 'ENVIRONMENTAL_FACTORS'¶: A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent. This constant has a value of “ENVIRONMENTAL_FACTORS”

MAINTENANCE_REASON_EVACUATION = 'EVACUATION'¶: A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent. This constant has a value of “EVACUATION”

MAINTENANCE_REASON_FIRMWARE_UPDATE = 'FIRMWARE_UPDATE'¶: A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent. This constant has a value of “FIRMWARE_UPDATE”

MAINTENANCE_REASON_HARDWARE_REPLACEMENT = 'HARDWARE_REPLACEMENT'¶: A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent. This constant has a value of “HARDWARE_REPLACEMENT”

MAINTENANCE_REASON_SECURITY_UPDATE = 'SECURITY_UPDATE'¶: A constant which can be used with the maintenance_reason property of a InstanceMaintenanceEvent. This constant has a value of “SECURITY_UPDATE”

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this InstanceMaintenanceEvent.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this InstanceMaintenanceEvent.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this InstanceMaintenanceEvent.
id (str) – The value to assign to the id property of this InstanceMaintenanceEvent.
instance_id (str) – The value to assign to the instance_id property of this InstanceMaintenanceEvent.
compartment_id (str) – The value to assign to the compartment_id property of this InstanceMaintenanceEvent.
maintenance_category (str) – The value to assign to the maintenance_category property of this InstanceMaintenanceEvent. Allowed values for this property are: “EMERGENCY”, “MANDATORY”, “FLEXIBLE”, “OPTIONAL”, “NOTIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
maintenance_reason (str) – The value to assign to the maintenance_reason property of this InstanceMaintenanceEvent. Allowed values for this property are: “EVACUATION”, “ENVIRONMENTAL_FACTORS”, “DECOMMISSION”, “HARDWARE_REPLACEMENT”, “FIRMWARE_UPDATE”, “SECURITY_UPDATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
instance_action (str) – The value to assign to the instance_action property of this InstanceMaintenanceEvent. Allowed values for this property are: “REBOOT_MIGRATION”, “TERMINATE”, “STOP”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
alternative_resolution_actions (list[str]) – The value to assign to the alternative_resolution_actions property of this InstanceMaintenanceEvent. Allowed values for items in this list are: “REBOOT_MIGRATION”, “TERMINATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_started (datetime) – The value to assign to the time_started property of this InstanceMaintenanceEvent.
time_finished (datetime) – The value to assign to the time_finished property of this InstanceMaintenanceEvent.
time_window_start (datetime) – The value to assign to the time_window_start property of this InstanceMaintenanceEvent.
start_window_duration (str) – The value to assign to the start_window_duration property of this InstanceMaintenanceEvent.
estimated_duration (str) – The value to assign to the estimated_duration property of this InstanceMaintenanceEvent.
time_hard_due_date (datetime) – The value to assign to the time_hard_due_date property of this InstanceMaintenanceEvent.
can_reschedule (bool) – The value to assign to the can_reschedule property of this InstanceMaintenanceEvent.
time_created (datetime) – The value to assign to the time_created property of this InstanceMaintenanceEvent.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this InstanceMaintenanceEvent. Allowed values for this property are: “SCHEDULED”, “STARTED”, “PROCESSING”, “SUCCEEDED”, “FAILED”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this InstanceMaintenanceEvent.
created_by (str) – The value to assign to the created_by property of this InstanceMaintenanceEvent. Allowed values for this property are: “CUSTOMER”, “SYSTEM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this InstanceMaintenanceEvent.
correlation_token (str) – The value to assign to the correlation_token property of this InstanceMaintenanceEvent.
can_delete_local_storage (bool) – The value to assign to the can_delete_local_storage property of this InstanceMaintenanceEvent.
additional_details (dict(str, str)) – The value to assign to the additional_details property of this InstanceMaintenanceEvent.

additional_details¶

Gets the additional_details of this InstanceMaintenanceEvent. Additional details of the maintenance in the form of json.

Returns:	The additional_details of this InstanceMaintenanceEvent.
Return type:	dict(str, str)

alternative_resolution_actions¶

[Required] Gets the alternative_resolution_actions of this InstanceMaintenanceEvent. These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.

Allowed values for items in this list are: “REBOOT_MIGRATION”, “TERMINATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The alternative_resolution_actions of this InstanceMaintenanceEvent.
Return type:	list[str]

can_delete_local_storage¶

Gets the can_delete_local_storage of this InstanceMaintenanceEvent. For Instances that have local storage, this field is set to true when local storage will be deleted as a result of the Maintenance.

Returns:	The can_delete_local_storage of this InstanceMaintenanceEvent.
Return type:	bool

can_reschedule¶

[Required] Gets the can_reschedule of this InstanceMaintenanceEvent. Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.

Returns:	The can_reschedule of this InstanceMaintenanceEvent.
Return type:	bool

compartment_id¶

[Required] Gets the compartment_id of this InstanceMaintenanceEvent. The OCID of the compartment that contains the instance.

Returns:	The compartment_id of this InstanceMaintenanceEvent.
Return type:	str

correlation_token¶

Gets the correlation_token of this InstanceMaintenanceEvent. A unique identifier that will group Instances that have a relationship with one another and must be scheduled together for the Maintenance to proceed. Any Instances that have a relationship with one another from a Maintenance perspective will have a matching correlationToken.

Returns:	The correlation_token of this InstanceMaintenanceEvent.
Return type:	str

created_by¶

[Required] Gets the created_by of this InstanceMaintenanceEvent. The creator of the maintenance event.

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

Returns:	The created_by of this InstanceMaintenanceEvent.
Return type:	str

defined_tags¶

Gets the defined_tags of this InstanceMaintenanceEvent. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this InstanceMaintenanceEvent.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this InstanceMaintenanceEvent. It is the descriptive information about the maintenance taking place on the customer instance.

Returns:	The description of this InstanceMaintenanceEvent.
Return type:	str

display_name¶

Gets the display_name of this InstanceMaintenanceEvent. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this InstanceMaintenanceEvent.
Return type:	str

estimated_duration¶

Gets the estimated_duration of this InstanceMaintenanceEvent. This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.

Returns:	The estimated_duration of this InstanceMaintenanceEvent.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this InstanceMaintenanceEvent. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this InstanceMaintenanceEvent.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this InstanceMaintenanceEvent. The OCID of the maintenance event.

Returns:	The id of this InstanceMaintenanceEvent.
Return type:	str

instance_action¶

[Required] Gets the instance_action of this InstanceMaintenanceEvent. This is the action that will be performed on the Instance by OCI when the Maintenance begins.

Allowed values for this property are: “REBOOT_MIGRATION”, “TERMINATE”, “STOP”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The instance_action of this InstanceMaintenanceEvent.
Return type:	str

instance_id¶

[Required] Gets the instance_id of this InstanceMaintenanceEvent. The OCID of the instance.

Returns:	The instance_id of this InstanceMaintenanceEvent.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this InstanceMaintenanceEvent. Provides more details about the state of the maintenance event.

Returns:	The lifecycle_details of this InstanceMaintenanceEvent.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this InstanceMaintenanceEvent. The current state of the maintenance event.

Allowed values for this property are: “SCHEDULED”, “STARTED”, “PROCESSING”, “SUCCEEDED”, “FAILED”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this InstanceMaintenanceEvent.
Return type:	str

maintenance_category¶

[Required] Gets the maintenance_category of this InstanceMaintenanceEvent. This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the Instance Maintenance documentation for details.

Allowed values for this property are: “EMERGENCY”, “MANDATORY”, “FLEXIBLE”, “OPTIONAL”, “NOTIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The maintenance_category of this InstanceMaintenanceEvent.
Return type:	str

maintenance_reason¶

[Required] Gets the maintenance_reason of this InstanceMaintenanceEvent. This is the reason that Maintenance is being performed. See Instance Maintenance documentation for details.

Allowed values for this property are: “EVACUATION”, “ENVIRONMENTAL_FACTORS”, “DECOMMISSION”, “HARDWARE_REPLACEMENT”, “FIRMWARE_UPDATE”, “SECURITY_UPDATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The maintenance_reason of this InstanceMaintenanceEvent.
Return type:	str

start_window_duration¶

Gets the start_window_duration of this InstanceMaintenanceEvent. The duration of the time window Maintenance is scheduled to begin within.

Returns:	The start_window_duration of this InstanceMaintenanceEvent.
Return type:	str

time_created¶

[Required] Gets the time_created of this InstanceMaintenanceEvent. The date and time the maintenance event was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this InstanceMaintenanceEvent.
Return type:	datetime

time_finished¶

Gets the time_finished of this InstanceMaintenanceEvent. The time at which the Maintenance actually finished.

Returns:	The time_finished of this InstanceMaintenanceEvent.
Return type:	datetime

time_hard_due_date¶

Gets the time_hard_due_date of this InstanceMaintenanceEvent. It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.

Returns:	The time_hard_due_date of this InstanceMaintenanceEvent.
Return type:	datetime

time_started¶

Gets the time_started of this InstanceMaintenanceEvent. The time at which the Maintenance actually started.

Returns:	The time_started of this InstanceMaintenanceEvent.
Return type:	datetime

time_window_start¶

[Required] Gets the time_window_start of this InstanceMaintenanceEvent. The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.

Returns:	The time_window_start of this InstanceMaintenanceEvent.
Return type:	datetime