InstancePoolSummary¶

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

Bases: object

Summary information for an instance pool.

Attributes

`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_RUNNING`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_SCALING`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_STARTING`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a InstancePoolSummary.
`availability_domains`	[Required] Gets the availability_domains of this InstancePoolSummary.
`compartment_id`	[Required] Gets the compartment_id of this InstancePoolSummary.
`defined_tags`	Gets the defined_tags of this InstancePoolSummary.
`display_name`	Gets the display_name of this InstancePoolSummary.
`freeform_tags`	Gets the freeform_tags of this InstancePoolSummary.
`id`	[Required] Gets the id of this InstancePoolSummary.
`instance_configuration_id`	[Required] Gets the instance_configuration_id of this InstancePoolSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this InstancePoolSummary.
`size`	[Required] Gets the size of this InstancePoolSummary.
`time_created`	[Required] Gets the time_created of this InstancePoolSummary.

Methods

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_RUNNING = 'RUNNING'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “RUNNING”

LIFECYCLE_STATE_SCALING = 'SCALING'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “SCALING”

LIFECYCLE_STATE_STARTING = 'STARTING'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “STARTING”

LIFECYCLE_STATE_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “STOPPING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a InstancePoolSummary. This constant has a value of “TERMINATING”

__init__(**kwargs)¶

Initializes a new InstancePoolSummary 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 InstancePoolSummary.
compartment_id (str) – The value to assign to the compartment_id property of this InstancePoolSummary.
display_name (str) – The value to assign to the display_name property of this InstancePoolSummary.
instance_configuration_id (str) – The value to assign to the instance_configuration_id property of this InstancePoolSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this InstancePoolSummary. 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’.
availability_domains (list[str]) – The value to assign to the availability_domains property of this InstancePoolSummary.
size (int) – The value to assign to the size property of this InstancePoolSummary.
time_created (datetime) – The value to assign to the time_created property of this InstancePoolSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this InstancePoolSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this InstancePoolSummary.

availability_domains¶

[Required] Gets the availability_domains of this InstancePoolSummary. The availability domains for the instance pool.

Returns:	The availability_domains of this InstancePoolSummary.
Return type:	list[str]

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

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

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

instance_configuration_id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this InstancePoolSummary. 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 InstancePoolSummary.
Return type:	str

size¶

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

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

time_created¶

[Required] Gets the time_created of this InstancePoolSummary. 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 InstancePoolSummary.
Return type:	datetime