InstancePoolInstance

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

Bases: object

Information about an instance that belongs to an instance pool.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a InstancePoolInstance.

LIFECYCLE_STATE_ATTACHING

A constant which can be used with the lifecycle_state property of a InstancePoolInstance.

LIFECYCLE_STATE_DETACHING

A constant which can be used with the lifecycle_state property of a InstancePoolInstance.

LIFECYCLE_STATE_TERMINATION_AWAIT

A constant which can be used with the lifecycle_state property of a InstancePoolInstance.

LIFECYCLE_STATE_TERMINATION_PROCEED

A constant which can be used with the lifecycle_state property of a InstancePoolInstance.

availability_domain

[Required] Gets the availability_domain of this InstancePoolInstance.

compartment_id

[Required] Gets the compartment_id of this InstancePoolInstance.

display_name

Gets the display_name of this InstancePoolInstance.

fault_domain

Gets the fault_domain of this InstancePoolInstance.

id

[Required] Gets the id of this InstancePoolInstance.

instance_configuration_id

[Required] Gets the instance_configuration_id of this InstancePoolInstance.

instance_pool_id

[Required] Gets the instance_pool_id of this InstancePoolInstance.

lifecycle_state

[Required] Gets the lifecycle_state of this InstancePoolInstance.

load_balancer_backends

Gets the load_balancer_backends of this InstancePoolInstance.

region

[Required] Gets the region of this InstancePoolInstance.

shape

[Required] Gets the shape of this InstancePoolInstance.

state

[Required] Gets the state of this InstancePoolInstance.

time_created

[Required] Gets the time_created of this InstancePoolInstance.

Methods:

__init__(**kwargs)

Initializes a new InstancePoolInstance object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a InstancePoolInstance. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_ATTACHING = 'ATTACHING'

A constant which can be used with the lifecycle_state property of a InstancePoolInstance. This constant has a value of “ATTACHING”

LIFECYCLE_STATE_DETACHING = 'DETACHING'

A constant which can be used with the lifecycle_state property of a InstancePoolInstance. This constant has a value of “DETACHING”

LIFECYCLE_STATE_TERMINATION_AWAIT = 'TERMINATION_AWAIT'

A constant which can be used with the lifecycle_state property of a InstancePoolInstance. This constant has a value of “TERMINATION_AWAIT”

LIFECYCLE_STATE_TERMINATION_PROCEED = 'TERMINATION_PROCEED'

A constant which can be used with the lifecycle_state property of a InstancePoolInstance. This constant has a value of “TERMINATION_PROCEED”

__init__(**kwargs)

Initializes a new InstancePoolInstance 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 InstancePoolInstance.

  • instance_pool_id (str) – The value to assign to the instance_pool_id property of this InstancePoolInstance.

  • availability_domain (str) – The value to assign to the availability_domain property of this InstancePoolInstance.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this InstancePoolInstance. Allowed values for this property are: “ATTACHING”, “ACTIVE”, “DETACHING”, “TERMINATION_AWAIT”, “TERMINATION_PROCEED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • compartment_id (str) – The value to assign to the compartment_id property of this InstancePoolInstance.

  • display_name (str) – The value to assign to the display_name property of this InstancePoolInstance.

  • fault_domain (str) – The value to assign to the fault_domain property of this InstancePoolInstance.

  • instance_configuration_id (str) – The value to assign to the instance_configuration_id property of this InstancePoolInstance.

  • region (str) – The value to assign to the region property of this InstancePoolInstance.

  • shape (str) – The value to assign to the shape property of this InstancePoolInstance.

  • state (str) – The value to assign to the state property of this InstancePoolInstance.

  • time_created (datetime) – The value to assign to the time_created property of this InstancePoolInstance.

  • load_balancer_backends (list[oci.core.models.InstancePoolInstanceLoadBalancerBackend]) – The value to assign to the load_balancer_backends property of this InstancePoolInstance.

property availability_domain

[Required] Gets the availability_domain of this InstancePoolInstance. The availability domain the instance is running in.

Returns

The availability_domain of this InstancePoolInstance.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this InstancePoolInstance. The OCID of the compartment that contains the instance.

Returns

The compartment_id of this InstancePoolInstance.

Return type

str

property display_name

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

Returns

The display_name of this InstancePoolInstance.

Return type

str

property fault_domain

Gets the fault_domain of this InstancePoolInstance. The fault domain the instance is running in.

Returns

The fault_domain of this InstancePoolInstance.

Return type

str

property id

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

Returns

The id of this InstancePoolInstance.

Return type

str

property instance_configuration_id

[Required] Gets the instance_configuration_id of this InstancePoolInstance. The OCID of the instance configuration used to create the instance.

Returns

The instance_configuration_id of this InstancePoolInstance.

Return type

str

property instance_pool_id

[Required] Gets the instance_pool_id of this InstancePoolInstance. The OCID of the instance pool.

Returns

The instance_pool_id of this InstancePoolInstance.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this InstancePoolInstance. The attachment state of the instance in relation to the instance pool.

Allowed values for this property are: “ATTACHING”, “ACTIVE”, “DETACHING”, “TERMINATION_AWAIT”, “TERMINATION_PROCEED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this InstancePoolInstance.

Return type

str

property load_balancer_backends

Gets the load_balancer_backends of this InstancePoolInstance. The load balancer backends that are configured for the instance.

Returns

The load_balancer_backends of this InstancePoolInstance.

Return type

list[oci.core.models.InstancePoolInstanceLoadBalancerBackend]

property region

[Required] Gets the region of this InstancePoolInstance. The region that contains the availability domain the instance is running in.

Returns

The region of this InstancePoolInstance.

Return type

str

property shape

[Required] Gets the shape of this InstancePoolInstance. The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.

Returns

The shape of this InstancePoolInstance.

Return type

str

property state

[Required] Gets the state of this InstancePoolInstance. The lifecycle state of the instance. Refer to lifecycleState in the Instance resource.

Returns

The state of this InstancePoolInstance.

Return type

str

property time_created

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

Returns

The time_created of this InstancePoolInstance.

Return type

datetime