UpdateNodePoolDetails¶

class oci.container_engine.models.UpdateNodePoolDetails(**kwargs)¶

Bases: object

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

Methods

__init__(**kwargs) Initializes a new UpdateNodePoolDetails object with values from keyword arguments.

Attributes

`defined_tags`	Gets the defined_tags of this UpdateNodePoolDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateNodePoolDetails.
`initial_node_labels`	Gets the initial_node_labels of this UpdateNodePoolDetails.
`kubernetes_version`	Gets the kubernetes_version of this UpdateNodePoolDetails.
`name`	Gets the name of this UpdateNodePoolDetails.
`node_config_details`	Gets the node_config_details of this UpdateNodePoolDetails.
`node_eviction_node_pool_settings`	Gets the node_eviction_node_pool_settings of this UpdateNodePoolDetails.
`node_metadata`	Gets the node_metadata of this UpdateNodePoolDetails.
`node_pool_cycling_details`	Gets the node_pool_cycling_details of this UpdateNodePoolDetails.
`node_shape`	Gets the node_shape of this UpdateNodePoolDetails.
`node_shape_config`	Gets the node_shape_config of this UpdateNodePoolDetails.
`node_source_details`	Gets the node_source_details of this UpdateNodePoolDetails.
`quantity_per_subnet`	Gets the quantity_per_subnet of this UpdateNodePoolDetails.
`ssh_public_key`	Gets the ssh_public_key of this UpdateNodePoolDetails.
`subnet_ids`	Gets the subnet_ids of this UpdateNodePoolDetails.

__init__(**kwargs)¶

Initializes a new UpdateNodePoolDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this UpdateNodePoolDetails.
kubernetes_version (str) – The value to assign to the kubernetes_version property of this UpdateNodePoolDetails.
initial_node_labels (list[oci.container_engine.models.KeyValue]) – The value to assign to the initial_node_labels property of this UpdateNodePoolDetails.
quantity_per_subnet (int) – The value to assign to the quantity_per_subnet property of this UpdateNodePoolDetails.
subnet_ids (list[str]) – The value to assign to the subnet_ids property of this UpdateNodePoolDetails.
node_config_details (oci.container_engine.models.UpdateNodePoolNodeConfigDetails) – The value to assign to the node_config_details property of this UpdateNodePoolDetails.
node_metadata (dict(str, str)) – The value to assign to the node_metadata property of this UpdateNodePoolDetails.
node_source_details (oci.container_engine.models.NodeSourceDetails) – The value to assign to the node_source_details property of this UpdateNodePoolDetails.
ssh_public_key (str) – The value to assign to the ssh_public_key property of this UpdateNodePoolDetails.
node_shape (str) – The value to assign to the node_shape property of this UpdateNodePoolDetails.
node_shape_config (oci.container_engine.models.UpdateNodeShapeConfigDetails) – The value to assign to the node_shape_config property of this UpdateNodePoolDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateNodePoolDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateNodePoolDetails.
node_eviction_node_pool_settings (oci.container_engine.models.NodeEvictionNodePoolSettings) – The value to assign to the node_eviction_node_pool_settings property of this UpdateNodePoolDetails.
node_pool_cycling_details (oci.container_engine.models.NodePoolCyclingDetails) – The value to assign to the node_pool_cycling_details property of this UpdateNodePoolDetails.

defined_tags¶

Gets the defined_tags of this UpdateNodePoolDetails. 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 UpdateNodePoolDetails.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this UpdateNodePoolDetails. 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 UpdateNodePoolDetails.
Return type:	dict(str, str)

initial_node_labels¶

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

Returns:	The initial_node_labels of this UpdateNodePoolDetails.
Return type:	list[oci.container_engine.models.KeyValue]

kubernetes_version¶

Gets the kubernetes_version of this UpdateNodePoolDetails. The version of Kubernetes to which the nodes in the node pool should be upgraded.

Returns:	The kubernetes_version of this UpdateNodePoolDetails.
Return type:	str

name¶

Gets the name of this UpdateNodePoolDetails. The new name for the cluster. Avoid entering confidential information.

Returns:	The name of this UpdateNodePoolDetails.
Return type:	str

node_config_details¶

Gets the node_config_details of this UpdateNodePoolDetails. The configuration of nodes in the node pool. Only one of the subnetIds or nodeConfigDetails properties should be specified. If the current value of quantityPerSubnet is greater than 0, the node pool may still be scaled using quantityPerSubnet. Before you can use nodeConfigDetails, you must first scale the node pool to 0 nodes using quantityPerSubnet.

Returns:	The node_config_details of this UpdateNodePoolDetails.
Return type:	oci.container_engine.models.UpdateNodePoolNodeConfigDetails

node_eviction_node_pool_settings¶

Gets the node_eviction_node_pool_settings of this UpdateNodePoolDetails.

Returns:	The node_eviction_node_pool_settings of this UpdateNodePoolDetails.
Return type:	oci.container_engine.models.NodeEvictionNodePoolSettings

node_metadata¶

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

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

node_pool_cycling_details¶

Gets the node_pool_cycling_details of this UpdateNodePoolDetails.

Returns:	The node_pool_cycling_details of this UpdateNodePoolDetails.
Return type:	oci.container_engine.models.NodePoolCyclingDetails

node_shape¶

Gets the node_shape of this UpdateNodePoolDetails. The name of the node shape of the nodes in the node pool used on launch.

Returns:	The node_shape of this UpdateNodePoolDetails.
Return type:	str

node_shape_config¶

Gets the node_shape_config of this UpdateNodePoolDetails. Specify the configuration of the shape to launch nodes in the node pool.

Returns:	The node_shape_config of this UpdateNodePoolDetails.
Return type:	oci.container_engine.models.UpdateNodeShapeConfigDetails

node_source_details¶

Gets the node_source_details of this UpdateNodePoolDetails. Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

Returns:	The node_source_details of this UpdateNodePoolDetails.
Return type:	oci.container_engine.models.NodeSourceDetails

quantity_per_subnet¶

Gets the quantity_per_subnet of this UpdateNodePoolDetails. The number of nodes to have in each subnet specified in the subnetIds property. This property is deprecated, use nodeConfigDetails instead. If the current value of quantityPerSubnet is greater than 0, you can only use quantityPerSubnet to scale the node pool. If the current value of quantityPerSubnet is equal to 0 and the current value of size in nodeConfigDetails is greater than 0, before you can use quantityPerSubnet, you must first scale the node pool to 0 nodes using nodeConfigDetails.

Returns:	The quantity_per_subnet of this UpdateNodePoolDetails.
Return type:	int

ssh_public_key¶

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

Returns:	The ssh_public_key of this UpdateNodePoolDetails.
Return type:	str

subnet_ids¶

Gets the subnet_ids of this UpdateNodePoolDetails. The OCIDs of the subnets in which to place nodes for this node pool. This property is deprecated, use nodeConfigDetails instead. Only one of the subnetIds or nodeConfigDetails properties can be specified.

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