UpdateInstanceDetails

class oci.core.models.UpdateInstanceDetails(**kwargs)

Bases: object

UpdateInstanceDetails model.

Attributes

UPDATE_OPERATION_CONSTRAINT_ALLOW_DOWNTIME A constant which can be used with the update_operation_constraint property of a UpdateInstanceDetails.
UPDATE_OPERATION_CONSTRAINT_AVOID_DOWNTIME A constant which can be used with the update_operation_constraint property of a UpdateInstanceDetails.
agent_config Gets the agent_config of this UpdateInstanceDetails.
availability_config Gets the availability_config of this UpdateInstanceDetails.
capacity_reservation_id Gets the capacity_reservation_id of this UpdateInstanceDetails.
dedicated_vm_host_id Gets the dedicated_vm_host_id of this UpdateInstanceDetails.
defined_tags Gets the defined_tags of this UpdateInstanceDetails.
display_name Gets the display_name of this UpdateInstanceDetails.
extended_metadata Gets the extended_metadata of this UpdateInstanceDetails.
fault_domain Gets the fault_domain of this UpdateInstanceDetails.
freeform_tags Gets the freeform_tags of this UpdateInstanceDetails.
instance_options Gets the instance_options of this UpdateInstanceDetails.
launch_options Gets the launch_options of this UpdateInstanceDetails.
metadata Gets the metadata of this UpdateInstanceDetails.
platform_config Gets the platform_config of this UpdateInstanceDetails.
shape Gets the shape of this UpdateInstanceDetails.
shape_config Gets the shape_config of this UpdateInstanceDetails.
time_maintenance_reboot_due Gets the time_maintenance_reboot_due of this UpdateInstanceDetails.
update_operation_constraint Gets the update_operation_constraint of this UpdateInstanceDetails.

Methods

__init__(**kwargs) Initializes a new UpdateInstanceDetails object with values from keyword arguments.
UPDATE_OPERATION_CONSTRAINT_ALLOW_DOWNTIME = 'ALLOW_DOWNTIME'

A constant which can be used with the update_operation_constraint property of a UpdateInstanceDetails. This constant has a value of “ALLOW_DOWNTIME”

UPDATE_OPERATION_CONSTRAINT_AVOID_DOWNTIME = 'AVOID_DOWNTIME'

A constant which can be used with the update_operation_constraint property of a UpdateInstanceDetails. This constant has a value of “AVOID_DOWNTIME”

__init__(**kwargs)

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

Parameters:
  • capacity_reservation_id (str) – The value to assign to the capacity_reservation_id property of this UpdateInstanceDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateInstanceDetails.
  • display_name (str) – The value to assign to the display_name property of this UpdateInstanceDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateInstanceDetails.
  • agent_config (oci.core.models.UpdateInstanceAgentConfigDetails) – The value to assign to the agent_config property of this UpdateInstanceDetails.
  • metadata (dict(str, str)) – The value to assign to the metadata property of this UpdateInstanceDetails.
  • extended_metadata (dict(str, object)) – The value to assign to the extended_metadata property of this UpdateInstanceDetails.
  • shape (str) – The value to assign to the shape property of this UpdateInstanceDetails.
  • shape_config (oci.core.models.UpdateInstanceShapeConfigDetails) – The value to assign to the shape_config property of this UpdateInstanceDetails.
  • update_operation_constraint (str) – The value to assign to the update_operation_constraint property of this UpdateInstanceDetails. Allowed values for this property are: “ALLOW_DOWNTIME”, “AVOID_DOWNTIME”
  • instance_options (oci.core.models.InstanceOptions) – The value to assign to the instance_options property of this UpdateInstanceDetails.
  • fault_domain (str) – The value to assign to the fault_domain property of this UpdateInstanceDetails.
  • launch_options (oci.core.models.UpdateLaunchOptions) – The value to assign to the launch_options property of this UpdateInstanceDetails.
  • availability_config (oci.core.models.UpdateInstanceAvailabilityConfigDetails) – The value to assign to the availability_config property of this UpdateInstanceDetails.
  • time_maintenance_reboot_due (datetime) – The value to assign to the time_maintenance_reboot_due property of this UpdateInstanceDetails.
  • dedicated_vm_host_id (str) – The value to assign to the dedicated_vm_host_id property of this UpdateInstanceDetails.
  • platform_config (oci.core.models.UpdateInstancePlatformConfig) – The value to assign to the platform_config property of this UpdateInstanceDetails.
agent_config

Gets the agent_config of this UpdateInstanceDetails.

Returns:The agent_config of this UpdateInstanceDetails.
Return type:oci.core.models.UpdateInstanceAgentConfigDetails
availability_config

Gets the availability_config of this UpdateInstanceDetails.

Returns:The availability_config of this UpdateInstanceDetails.
Return type:oci.core.models.UpdateInstanceAvailabilityConfigDetails
capacity_reservation_id

Gets the capacity_reservation_id of this UpdateInstanceDetails. The OCID of the compute capacity reservation this instance is launched under. You can remove the instance from a reservation by specifying an empty string as input for this field. For more information, see Capacity Reservations.

Returns:The capacity_reservation_id of this UpdateInstanceDetails.
Return type:str
dedicated_vm_host_id

Gets the dedicated_vm_host_id of this UpdateInstanceDetails. The OCID of the dedicated virtual machine host to place the instance on. Supported only if this VM instance was already placed on a dedicated virtual machine host - that is, you can’t move an instance from on-demand capacity to dedicated capacity, nor can you move an instance from dedicated capacity to on-demand capacity.

Returns:The dedicated_vm_host_id of this UpdateInstanceDetails.
Return type:str
defined_tags

Gets the defined_tags of this UpdateInstanceDetails. 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 UpdateInstanceDetails.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this UpdateInstanceDetails.
Return type:str
extended_metadata

Gets the extended_metadata of this UpdateInstanceDetails. Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the metadata object.

They are distinguished from metadata fields in that these can be nested JSON objects (whereas metadata fields are string/string maps only).

The “user_data” field and the “ssh_authorized_keys” field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for “user_data” and “ssh_authorized_keys” that already exist on the instance.

The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.

Returns:The extended_metadata of this UpdateInstanceDetails.
Return type:dict(str, object)
fault_domain

Gets the fault_domain of this UpdateInstanceDetails. A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.

To get a list of fault domains, use the list_fault_domains() operation in the Identity and Access Management Service API.

Example: FAULT-DOMAIN-1

Returns:The fault_domain of this UpdateInstanceDetails.
Return type:str
freeform_tags

Gets the freeform_tags of this UpdateInstanceDetails. 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 UpdateInstanceDetails.
Return type:dict(str, str)
instance_options

Gets the instance_options of this UpdateInstanceDetails.

Returns:The instance_options of this UpdateInstanceDetails.
Return type:oci.core.models.InstanceOptions
launch_options

Gets the launch_options of this UpdateInstanceDetails.

Returns:The launch_options of this UpdateInstanceDetails.
Return type:oci.core.models.UpdateLaunchOptions
metadata

Gets the metadata of this UpdateInstanceDetails. Custom metadata key/value string pairs that you provide. Any set of key/value pairs provided here will completely replace the current set of key/value pairs in the metadata field on the instance.

The “user_data” field and the “ssh_authorized_keys” field cannot be changed after an instance has launched. Any request that updates, removes, or adds either of these fields will be rejected. You must provide the same values for “user_data” and “ssh_authorized_keys” that already exist on the instance.

The combined size of the metadata and extendedMetadata objects can be a maximum of 32,000 bytes.

Returns:The metadata of this UpdateInstanceDetails.
Return type:dict(str, str)
platform_config

Gets the platform_config of this UpdateInstanceDetails.

Returns:The platform_config of this UpdateInstanceDetails.
Return type:oci.core.models.UpdateInstancePlatformConfig
shape

Gets the shape of this UpdateInstanceDetails. The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. For more information about how to change shapes, and a list of shapes that are supported, see Editing an Instance.

For details about the CPUs, memory, and other properties of each shape, see Compute Shapes.

The new shape must be compatible with the image that was used to launch the instance. You can enumerate all available shapes and determine image compatibility by calling list_shapes().

To determine whether capacity is available for a specific shape before you change the shape of an instance, use the create_compute_capacity_report() operation.

If the instance is running when you change the shape, the instance is rebooted.

Example: VM.Standard2.1

Returns:The shape of this UpdateInstanceDetails.
Return type:str
shape_config

Gets the shape_config of this UpdateInstanceDetails.

Returns:The shape_config of this UpdateInstanceDetails.
Return type:oci.core.models.UpdateInstanceShapeConfigDetails
time_maintenance_reboot_due

Gets the time_maintenance_reboot_due of this UpdateInstanceDetails. For a VM instance, resets the scheduled time that the instance will be reboot migrated for infrastructure maintenance, in the format defined by RFC3339. If the instance hasn’t been rebooted after this date, Oracle reboots the instance within 24 hours of the time and date that maintenance is due.

To get the maximum possible date that a maintenance reboot can be extended, use get_instance_maintenance_reboot().

Regardless of how the instance is stopped, this flag is reset to empty as soon as the instance reaches the Stopped state.

To reboot migrate a bare metal instance, use the instance_action() operation.

For more information, see Infrastructure Maintenance.

Example: 2018-05-25T21:10:29.600Z

Returns:The time_maintenance_reboot_due of this UpdateInstanceDetails.
Return type:datetime
update_operation_constraint

Gets the update_operation_constraint of this UpdateInstanceDetails. The parameter acts as a fail-safe to prevent unwanted downtime when updating a running instance. The default is ALLOW_DOWNTIME. * ALLOW_DOWNTIME - Compute might reboot the instance while updating the instance if a reboot is required. * AVOID_DOWNTIME - If the instance is in running state, Compute tries to update the instance without rebooting

it. If the instance requires a reboot to be updated, an error is returned and the instance is not updated. If the instance is stopped, it is updated and remains in the stopped state.

Allowed values for this property are: “ALLOW_DOWNTIME”, “AVOID_DOWNTIME”

Returns:The update_operation_constraint of this UpdateInstanceDetails.
Return type:str