Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateInstanceDetails

Properties

Optional agentConfig

agentConfig: model.UpdateInstanceAgentConfigDetails

Optional availabilityConfig

availabilityConfig: model.UpdateInstanceAvailabilityConfigDetails

Optional capacityReservationId

capacityReservationId: undefined | string

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.

Optional dedicatedVmHostId

dedicatedVmHostId: undefined | string

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.

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional extendedMetadata

extendedMetadata: undefined | object

Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the {@code metadata} object.

They are distinguished from {@code metadata} fields in that these can be nested JSON objects (whereas {@code 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 {@code metadata} and {@code extendedMetadata} objects can be a maximum of 32,000 bytes.

Optional faultDomain

faultDomain: undefined | string

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 {@link #listFaultDomains(ListFaultDomainsRequest) listFaultDomains} operation in the Identity and Access Management Service API.

Example: {@code FAULT-DOMAIN-1}

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

Optional instanceOptions

instanceOptions: model.InstanceOptions

Optional launchOptions

launchOptions: model.UpdateLaunchOptions

Optional metadata

metadata: undefined | object

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 {@code 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 {@code metadata} and {@code extendedMetadata} objects can be a maximum of 32,000 bytes.

Optional platformConfig

Optional shape

shape: undefined | string

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](https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm).

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 {@link #listShapes(ListShapesRequest) listShapes}.

To determine whether capacity is available for a specific shape before you change the shape of an instance, use the {@link #createComputeCapacityReport(CreateComputeCapacityReportRequest) createComputeCapacityReport} operation.

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

Example: {@code VM.Standard2.1}

Optional shapeConfig

shapeConfig: model.UpdateInstanceShapeConfigDetails

Optional sourceDetails

Optional timeMaintenanceRebootDue

timeMaintenanceRebootDue: Date

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 {@link #getInstanceMaintenanceReboot(GetInstanceMaintenanceRebootRequest) getInstanceMaintenanceReboot}.

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 {@link #instanceAction(InstanceActionRequest) instanceAction} operation.

For more information, see [Infrastructure Maintenance](https://docs.cloud.oracle.com/iaas/Content/Compute/References/infrastructure-maintenance.htm).

Example: {@code 2018-05-25T21:10:29.600Z}

Optional updateOperationConstraint

updateOperationConstraint: UpdateOperationConstraint

The parameter acts as a fail-safe to prevent unwanted downtime when updating a running instance. The default is ALLOW_DOWNTIME.

  • {@code ALLOW_DOWNTIME} - Compute might reboot the instance while updating the instance if a reboot is required.
  • {@code 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.
    

Functions

getDeserializedJsonObj

getJsonObj