InstancePool

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

Bases: object

An instance pool is a group of instances within the same region that are created based off of the same instance configuration. For more information about instance pools and instance configurations, see Managing Compute Instances.

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "PROVISIONING"

LIFECYCLE_STATE_RUNNING = 'RUNNING'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "RUNNING"

LIFECYCLE_STATE_SCALING = 'SCALING'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "SCALING"

LIFECYCLE_STATE_STARTING = 'STARTING'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "STARTING"

LIFECYCLE_STATE_STOPPED = 'STOPPED'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "STOPPED"

LIFECYCLE_STATE_STOPPING = 'STOPPING'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "STOPPING"

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "TERMINATED"

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a InstancePool. This constant has a value of "TERMINATING"

__init__(**kwargs)

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

Parameters:
  • id (str) -- The value to assign to the id property of this InstancePool.
  • compartment_id (str) -- The value to assign to the compartment_id property of this InstancePool.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this InstancePool.
  • display_name (str) -- The value to assign to the display_name property of this InstancePool.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this InstancePool.
  • instance_configuration_id (str) -- The value to assign to the instance_configuration_id property of this InstancePool.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this InstancePool. Allowed values for this property are: "PROVISIONING", "SCALING", "STARTING", "STOPPING", "TERMINATING", "STOPPED", "TERMINATED", "RUNNING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • placement_configurations (list[InstancePoolPlacementConfiguration]) -- The value to assign to the placement_configurations property of this InstancePool.
  • size (int) -- The value to assign to the size property of this InstancePool.
  • time_created (datetime) -- The value to assign to the time_created property of this InstancePool.
  • load_balancers (list[InstancePoolLoadBalancerAttachment]) -- The value to assign to the load_balancers property of this InstancePool.
compartment_id

[Required] Gets the compartment_id of this InstancePool. The OCID of the compartment containing the instance pool.

Returns:The compartment_id of this InstancePool.
Return type:str
defined_tags

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

Gets the display_name of this InstancePool. The user-friendly name. Does not have to be unique.

Returns:The display_name of this InstancePool.
Return type:str
freeform_tags

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

[Required] Gets the id of this InstancePool. The OCID of the instance pool.

Returns:The id of this InstancePool.
Return type:str
instance_configuration_id

[Required] Gets the instance_configuration_id of this InstancePool. The OCID of the instance configuration associated with the instance pool.

Returns:The instance_configuration_id of this InstancePool.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this InstancePool. The current state of the instance pool.

Allowed values for this property are: "PROVISIONING", "SCALING", "STARTING", "STOPPING", "TERMINATING", "STOPPED", "TERMINATED", "RUNNING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this InstancePool.
Return type:str
load_balancers

Gets the load_balancers of this InstancePool. The load balancers attached to the instance pool.

Returns:The load_balancers of this InstancePool.
Return type:list[InstancePoolLoadBalancerAttachment]
placement_configurations

[Required] Gets the placement_configurations of this InstancePool. The placement configurations for the instance pool.

Returns:The placement_configurations of this InstancePool.
Return type:list[InstancePoolPlacementConfiguration]
size

[Required] Gets the size of this InstancePool. The number of instances that should be in the instance pool.

Returns:The size of this InstancePool.
Return type:int
time_created

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

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