NodePoolSummary¶
-
class
oci.container_engine.models.
NodePoolSummary
(**kwargs)¶ Bases:
object
The properties that define a node pool summary.
Methods
__init__
(**kwargs)Initializes a new NodePoolSummary object with values from keyword arguments. Attributes
cluster_id
Gets the cluster_id of this NodePoolSummary. compartment_id
Gets the compartment_id of this NodePoolSummary. id
Gets the id of this NodePoolSummary. initial_node_labels
Gets the initial_node_labels of this NodePoolSummary. kubernetes_version
Gets the kubernetes_version of this NodePoolSummary. name
Gets the name of this NodePoolSummary. node_config_details
Gets the node_config_details of this NodePoolSummary. node_image_id
Gets the node_image_id of this NodePoolSummary. node_image_name
Gets the node_image_name of this NodePoolSummary. node_shape
Gets the node_shape of this NodePoolSummary. node_shape_config
Gets the node_shape_config of this NodePoolSummary. node_source
Gets the node_source of this NodePoolSummary. node_source_details
Gets the node_source_details of this NodePoolSummary. quantity_per_subnet
Gets the quantity_per_subnet of this NodePoolSummary. ssh_public_key
Gets the ssh_public_key of this NodePoolSummary. subnet_ids
Gets the subnet_ids of this NodePoolSummary. -
__init__
(**kwargs)¶ Initializes a new NodePoolSummary 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 NodePoolSummary.
- compartment_id (str) – The value to assign to the compartment_id property of this NodePoolSummary.
- cluster_id (str) – The value to assign to the cluster_id property of this NodePoolSummary.
- name (str) – The value to assign to the name property of this NodePoolSummary.
- kubernetes_version (str) – The value to assign to the kubernetes_version property of this NodePoolSummary.
- node_image_id (str) – The value to assign to the node_image_id property of this NodePoolSummary.
- node_image_name (str) – The value to assign to the node_image_name property of this NodePoolSummary.
- node_shape_config (oci.container_engine.models.NodeShapeConfig) – The value to assign to the node_shape_config property of this NodePoolSummary.
- node_source (oci.container_engine.models.NodeSourceOption) – The value to assign to the node_source property of this NodePoolSummary.
- node_source_details (oci.container_engine.models.NodeSourceDetails) – The value to assign to the node_source_details property of this NodePoolSummary.
- node_shape (str) – The value to assign to the node_shape property of this NodePoolSummary.
- initial_node_labels (list[oci.container_engine.models.KeyValue]) – The value to assign to the initial_node_labels property of this NodePoolSummary.
- ssh_public_key (str) – The value to assign to the ssh_public_key property of this NodePoolSummary.
- quantity_per_subnet (int) – The value to assign to the quantity_per_subnet property of this NodePoolSummary.
- subnet_ids (list[str]) – The value to assign to the subnet_ids property of this NodePoolSummary.
- node_config_details (oci.container_engine.models.NodePoolNodeConfigDetails) – The value to assign to the node_config_details property of this NodePoolSummary.
-
cluster_id
¶ Gets the cluster_id of this NodePoolSummary. The OCID of the cluster to which this node pool is attached.
Returns: The cluster_id of this NodePoolSummary. Return type: str
-
compartment_id
¶ Gets the compartment_id of this NodePoolSummary. The OCID of the compartment in which the node pool exists.
Returns: The compartment_id of this NodePoolSummary. Return type: str
-
id
¶ Gets the id of this NodePoolSummary. The OCID of the node pool.
Returns: The id of this NodePoolSummary. Return type: str
-
initial_node_labels
¶ Gets the initial_node_labels of this NodePoolSummary. A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
Returns: The initial_node_labels of this NodePoolSummary. Return type: list[oci.container_engine.models.KeyValue]
-
kubernetes_version
¶ Gets the kubernetes_version of this NodePoolSummary. The version of Kubernetes running on the nodes in the node pool.
Returns: The kubernetes_version of this NodePoolSummary. Return type: str
-
name
¶ Gets the name of this NodePoolSummary. The name of the node pool.
Returns: The name of this NodePoolSummary. Return type: str
-
node_config_details
¶ Gets the node_config_details of this NodePoolSummary. The configuration of nodes in the node pool.
Returns: The node_config_details of this NodePoolSummary. Return type: oci.container_engine.models.NodePoolNodeConfigDetails
-
node_image_id
¶ Gets the node_image_id of this NodePoolSummary. Deprecated. see nodeSource. The OCID of the image running on the nodes in the node pool.
Returns: The node_image_id of this NodePoolSummary. Return type: str
-
node_image_name
¶ Gets the node_image_name of this NodePoolSummary. Deprecated. see nodeSource. The name of the image running on the nodes in the node pool.
Returns: The node_image_name of this NodePoolSummary. Return type: str
-
node_shape
¶ Gets the node_shape of this NodePoolSummary. The name of the node shape of the nodes in the node pool.
Returns: The node_shape of this NodePoolSummary. Return type: str
-
node_shape_config
¶ Gets the node_shape_config of this NodePoolSummary. The shape configuration of the nodes.
Returns: The node_shape_config of this NodePoolSummary. Return type: oci.container_engine.models.NodeShapeConfig
-
node_source
¶ Gets the node_source of this NodePoolSummary. Deprecated. see nodeSourceDetails. Source running on the nodes in the node pool.
Returns: The node_source of this NodePoolSummary. Return type: oci.container_engine.models.NodeSourceOption
-
node_source_details
¶ Gets the node_source_details of this NodePoolSummary. Source running on the nodes in the node pool.
Returns: The node_source_details of this NodePoolSummary. Return type: oci.container_engine.models.NodeSourceDetails
-
quantity_per_subnet
¶ Gets the quantity_per_subnet of this NodePoolSummary. The number of nodes in each subnet.
Returns: The quantity_per_subnet of this NodePoolSummary. Return type: int
-
ssh_public_key
¶ Gets the ssh_public_key of this NodePoolSummary. The SSH public key on each node in the node pool on launch.
Returns: The ssh_public_key of this NodePoolSummary. Return type: str
-
subnet_ids
¶ Gets the subnet_ids of this NodePoolSummary. The OCIDs of the subnets in which to place nodes for this node pool.
Returns: The subnet_ids of this NodePoolSummary. Return type: list[str]
-