CreateNodePoolDetails

class oci.container_engine.models.CreateNodePoolDetails(**kwargs)

Bases: object

The properties that define a request to create a node pool.

__init__(**kwargs)

Initializes a new CreateNodePoolDetails 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 CreateNodePoolDetails.
  • cluster_id (str) -- The value to assign to the cluster_id property of this CreateNodePoolDetails.
  • name (str) -- The value to assign to the name property of this CreateNodePoolDetails.
  • kubernetes_version (str) -- The value to assign to the kubernetes_version property of this CreateNodePoolDetails.
  • node_metadata (dict(str, str)) -- The value to assign to the node_metadata property of this CreateNodePoolDetails.
  • node_image_name (str) -- The value to assign to the node_image_name property of this CreateNodePoolDetails.
  • node_shape (str) -- The value to assign to the node_shape property of this CreateNodePoolDetails.
  • initial_node_labels (list[KeyValue]) -- The value to assign to the initial_node_labels property of this CreateNodePoolDetails.
  • ssh_public_key (str) -- The value to assign to the ssh_public_key property of this CreateNodePoolDetails.
  • quantity_per_subnet (int) -- The value to assign to the quantity_per_subnet property of this CreateNodePoolDetails.
  • subnet_ids (list[str]) -- The value to assign to the subnet_ids property of this CreateNodePoolDetails.
  • node_config_details (CreateNodePoolNodeConfigDetails) -- The value to assign to the node_config_details property of this CreateNodePoolDetails.
cluster_id

[Required] Gets the cluster_id of this CreateNodePoolDetails. The OCID of the cluster to which this node pool is attached.

Returns:The cluster_id of this CreateNodePoolDetails.
Return type:str
compartment_id

[Required] Gets the compartment_id of this CreateNodePoolDetails. The OCID of the compartment in which the node pool exists.

Returns:The compartment_id of this CreateNodePoolDetails.
Return type:str
initial_node_labels

Gets the initial_node_labels of this CreateNodePoolDetails. A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

Returns:The initial_node_labels of this CreateNodePoolDetails.
Return type:list[KeyValue]
kubernetes_version

[Required] Gets the kubernetes_version of this CreateNodePoolDetails. The version of Kubernetes to install on the nodes in the node pool.

Returns:The kubernetes_version of this CreateNodePoolDetails.
Return type:str
name

[Required] Gets the name of this CreateNodePoolDetails. The name of the node pool. Avoid entering confidential information.

Returns:The name of this CreateNodePoolDetails.
Return type:str
node_config_details

Gets the node_config_details of this CreateNodePoolDetails. The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

Returns:The node_config_details of this CreateNodePoolDetails.
Return type:CreateNodePoolNodeConfigDetails
node_image_name

[Required] Gets the node_image_name of this CreateNodePoolDetails. The name of the image running on the nodes in the node pool.

Returns:The node_image_name of this CreateNodePoolDetails.
Return type:str
node_metadata

Gets the node_metadata of this CreateNodePoolDetails. A list of key/value pairs to add to each underlying OCI instance in the node pool.

Returns:The node_metadata of this CreateNodePoolDetails.
Return type:dict(str, str)
node_shape

[Required] Gets the node_shape of this CreateNodePoolDetails. The name of the node shape of the nodes in the node pool.

Returns:The node_shape of this CreateNodePoolDetails.
Return type:str
quantity_per_subnet

Gets the quantity_per_subnet of this CreateNodePoolDetails. Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property. When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead.

Returns:The quantity_per_subnet of this CreateNodePoolDetails.
Return type:int
ssh_public_key

Gets the ssh_public_key of this CreateNodePoolDetails. The SSH public key to add to each node in the node pool.

Returns:The ssh_public_key of this CreateNodePoolDetails.
Return type:str
subnet_ids

Gets the subnet_ids of this CreateNodePoolDetails. The OCIDs of the subnets in which to place nodes for this node pool. When used, quantityPerSubnet can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

Returns:The subnet_ids of this CreateNodePoolDetails.
Return type:list[str]