UpdateInstancePoolDetails¶

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

Bases: object

The data to update an instance pool.

Methods

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

Attributes

`defined_tags`	Gets the defined_tags of this UpdateInstancePoolDetails.
`display_name`	Gets the display_name of this UpdateInstancePoolDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateInstancePoolDetails.
`instance_configuration_id`	Gets the instance_configuration_id of this UpdateInstancePoolDetails.
`instance_display_name_formatter`	Gets the instance_display_name_formatter of this UpdateInstancePoolDetails.
`instance_hostname_formatter`	Gets the instance_hostname_formatter of this UpdateInstancePoolDetails.
`placement_configurations`	Gets the placement_configurations of this UpdateInstancePoolDetails.
`size`	Gets the size of this UpdateInstancePoolDetails.

__init__(**kwargs)¶

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

Parameters:

defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateInstancePoolDetails.
display_name (str) – The value to assign to the display_name property of this UpdateInstancePoolDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateInstancePoolDetails.
instance_configuration_id (str) – The value to assign to the instance_configuration_id property of this UpdateInstancePoolDetails.
placement_configurations (list[oci.core.models.UpdateInstancePoolPlacementConfigurationDetails]) – The value to assign to the placement_configurations property of this UpdateInstancePoolDetails.
size (int) – The value to assign to the size property of this UpdateInstancePoolDetails.
instance_display_name_formatter (str) – The value to assign to the instance_display_name_formatter property of this UpdateInstancePoolDetails.
instance_hostname_formatter (str) – The value to assign to the instance_hostname_formatter property of this UpdateInstancePoolDetails.

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

instance_configuration_id¶

Gets the instance_configuration_id of this UpdateInstancePoolDetails. The OCID of the instance configuration associated with the instance pool.

Returns:	The instance_configuration_id of this UpdateInstancePoolDetails.
Return type:	str

instance_display_name_formatter¶

Gets the instance_display_name_formatter of this UpdateInstancePoolDetails. A user-friendly formatter for the instance pool’s instances. Instance displaynames follow the format. The formatter does not retroactively change instance’s displaynames, only instance displaynames in the future follow the format

Returns:	The instance_display_name_formatter of this UpdateInstancePoolDetails.
Return type:	str

instance_hostname_formatter¶

Gets the instance_hostname_formatter of this UpdateInstancePoolDetails. A user-friendly formatter for the instance pool’s instances. Instance hostnames follow the format. The formatter does not retroactively change instance’s hostnames, only instance hostnames in the future follow the format

Returns:	The instance_hostname_formatter of this UpdateInstancePoolDetails.
Return type:	str

placement_configurations¶

Gets the placement_configurations of this UpdateInstancePoolDetails. The placement configurations for the instance pool. Provide one placement configuration for each availability domain.

To use the instance pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.

Returns:	The placement_configurations of this UpdateInstancePoolDetails.
Return type:	list[oci.core.models.UpdateInstancePoolPlacementConfigurationDetails]

size¶

Gets the size of this UpdateInstancePoolDetails. The number of instances that should be in the instance pool.

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

Returns:	The size of this UpdateInstancePoolDetails.
Return type:	int