CreateInstancePoolDetails¶
- class oci.core.models.CreateInstancePoolDetails(**kwargs)¶
Bases:
objectThe data to create an instance pool. For a GMC-enabled resource pool, the referenced instance configuration must be a GMC configuration and the placement configuration must identify the availability domain and compute cluster for the pool. Optionally include overridePolicy to define availability domain-scoped launch overrides for future launches. Existing pool members are not modified.
Methods:
__init__(**kwargs)Initializes a new CreateInstancePoolDetails object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this CreateInstancePoolDetails.
Gets the defined_tags of this CreateInstancePoolDetails.
Gets the display_name of this CreateInstancePoolDetails.
Gets the freeform_tags of this CreateInstancePoolDetails.
[Required] Gets the instance_configuration_id of this CreateInstancePoolDetails.
Gets the instance_display_name_formatter of this CreateInstancePoolDetails.
Gets the instance_hostname_formatter of this CreateInstancePoolDetails.
Gets the lifecycle_management of this CreateInstancePoolDetails.
Gets the load_balancers of this CreateInstancePoolDetails.
Gets the override_policy of this CreateInstancePoolDetails.
[Required] Gets the placement_configurations of this CreateInstancePoolDetails.
[Required] Gets the size of this CreateInstancePoolDetails.
- __init__(**kwargs)¶
Initializes a new CreateInstancePoolDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this CreateInstancePoolDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateInstancePoolDetails.
display_name (str) – The value to assign to the display_name property of this CreateInstancePoolDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateInstancePoolDetails.
instance_configuration_id (str) – The value to assign to the instance_configuration_id property of this CreateInstancePoolDetails.
placement_configurations (list[oci.core.models.CreateInstancePoolPlacementConfigurationDetails]) – The value to assign to the placement_configurations property of this CreateInstancePoolDetails.
size (int) – The value to assign to the size property of this CreateInstancePoolDetails.
load_balancers (list[oci.core.models.AttachLoadBalancerDetails]) – The value to assign to the load_balancers property of this CreateInstancePoolDetails.
override_policy (oci.core.models.InstancePoolLaunchOverridePolicy) – The value to assign to the override_policy property of this CreateInstancePoolDetails.
instance_display_name_formatter (str) – The value to assign to the instance_display_name_formatter property of this CreateInstancePoolDetails.
instance_hostname_formatter (str) – The value to assign to the instance_hostname_formatter property of this CreateInstancePoolDetails.
lifecycle_management (oci.core.models.InstancePoolLifecycleManagementDetails) – The value to assign to the lifecycle_management property of this CreateInstancePoolDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateInstancePoolDetails. The OCID of the compartment containing the instance pool.
- Returns
The compartment_id of this CreateInstancePoolDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateInstancePoolDetails. 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 CreateInstancePoolDetails.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this CreateInstancePoolDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this CreateInstancePoolDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateInstancePoolDetails. 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 CreateInstancePoolDetails.
- Return type
dict(str, str)
- property instance_configuration_id¶
[Required] Gets the instance_configuration_id of this CreateInstancePoolDetails. The OCID of the instance configuration associated with the instance pool.
- Returns
The instance_configuration_id of this CreateInstancePoolDetails.
- Return type
str
- property instance_display_name_formatter¶
Gets the instance_display_name_formatter of this CreateInstancePoolDetails. 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 CreateInstancePoolDetails.
- Return type
str
- property instance_hostname_formatter¶
Gets the instance_hostname_formatter of this CreateInstancePoolDetails. 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 CreateInstancePoolDetails.
- Return type
str
- property lifecycle_management¶
Gets the lifecycle_management of this CreateInstancePoolDetails.
- Returns
The lifecycle_management of this CreateInstancePoolDetails.
- Return type
- property load_balancers¶
Gets the load_balancers of this CreateInstancePoolDetails. The load balancers to attach to the instance pool.
- Returns
The load_balancers of this CreateInstancePoolDetails.
- Return type
- property override_policy¶
Gets the override_policy of this CreateInstancePoolDetails.
- Returns
The override_policy of this CreateInstancePoolDetails.
- Return type
- property placement_configurations¶
[Required] Gets the placement_configurations of this CreateInstancePoolDetails. 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. To use compute cluster with instance pool, provide a single placement configuration.
- Returns
The placement_configurations of this CreateInstancePoolDetails.
- Return type
list[oci.core.models.CreateInstancePoolPlacementConfigurationDetails]
- property size¶
[Required] Gets the size of this CreateInstancePoolDetails. The number of instances that should be in the instance pool. For a GMC-enabled resource pool, this is the number of GMC resources that should be in the pool.
- Returns
The size of this CreateInstancePoolDetails.
- Return type
int