InstanceSummary¶
- class oci.core.models.InstanceSummary(**kwargs)¶
Bases:
objectCondensed instance data when listing instances in an instance pool.
Methods:
__init__(**kwargs)Initializes a new InstanceSummary object with values from keyword arguments.
Attributes:
[Required] Gets the availability_domain of this InstanceSummary.
[Required] Gets the compartment_id of this InstanceSummary.
Gets the display_name of this InstanceSummary.
Gets the fault_domain of this InstanceSummary.
[Required] Gets the id of this InstanceSummary.
[Required] Gets the instance_configuration_id of this InstanceSummary.
Gets the load_balancer_backends of this InstanceSummary.
[Required] Gets the region of this InstanceSummary.
Gets the shape of this InstanceSummary.
[Required] Gets the state of this InstanceSummary.
[Required] Gets the time_created of this InstanceSummary.
- __init__(**kwargs)¶
Initializes a new InstanceSummary 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 InstanceSummary.
availability_domain (str) – The value to assign to the availability_domain property of this InstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this InstanceSummary.
display_name (str) – The value to assign to the display_name property of this InstanceSummary.
fault_domain (str) – The value to assign to the fault_domain property of this InstanceSummary.
instance_configuration_id (str) – The value to assign to the instance_configuration_id property of this InstanceSummary.
region (str) – The value to assign to the region property of this InstanceSummary.
shape (str) – The value to assign to the shape property of this InstanceSummary.
state (str) – The value to assign to the state property of this InstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this InstanceSummary.
load_balancer_backends (list[oci.core.models.InstancePoolInstanceLoadBalancerBackend]) – The value to assign to the load_balancer_backends property of this InstanceSummary.
- property availability_domain¶
[Required] Gets the availability_domain of this InstanceSummary. The availability domain the instance is running in.
- Returns
The availability_domain of this InstanceSummary.
- Return type
str
- property compartment_id¶
[Required] Gets the compartment_id of this InstanceSummary. The OCID of the compartment that contains the instance.
- Returns
The compartment_id of this InstanceSummary.
- Return type
str
- property display_name¶
Gets the display_name of this InstanceSummary. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this InstanceSummary.
- Return type
str
- property fault_domain¶
Gets the fault_domain of this InstanceSummary. The fault domain the instance is running in.
- Returns
The fault_domain of this InstanceSummary.
- Return type
str
- property id¶
[Required] Gets the id of this InstanceSummary. The OCID of the instance.
- Returns
The id of this InstanceSummary.
- Return type
str
- property instance_configuration_id¶
[Required] Gets the instance_configuration_id of this InstanceSummary. The OCID of the instance confgiuration used to create the instance.
- Returns
The instance_configuration_id of this InstanceSummary.
- Return type
str
- property load_balancer_backends¶
Gets the load_balancer_backends of this InstanceSummary. The load balancer backends that are configured for the instance pool instance.
- Returns
The load_balancer_backends of this InstanceSummary.
- Return type
list[oci.core.models.InstancePoolInstanceLoadBalancerBackend]
- property region¶
[Required] Gets the region of this InstanceSummary. The region that contains the availability domain the instance is running in.
- Returns
The region of this InstanceSummary.
- Return type
str
- property shape¶
Gets the shape of this InstanceSummary. The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.
You can enumerate all available shapes by calling
list_shapes().- Returns
The shape of this InstanceSummary.
- Return type
str
- property state¶
[Required] Gets the state of this InstanceSummary. The current state of the instance pool instance.
- Returns
The state of this InstanceSummary.
- Return type
str