Show / Hide Table of Contents

Class CreateNodePoolDetails

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

Inheritance
object
CreateNodePoolDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ContainerengineService.Models
Assembly: OCI.DotNetSDK.Containerengine.dll
Syntax
public class CreateNodePoolDetails

Properties

ClusterId

Declaration
[Required(ErrorMessage = "ClusterId is required.")]
[JsonProperty(PropertyName = "clusterId")]
public string ClusterId { get; set; }
Property Value
Type Description
string

The OCID of the cluster to which this node pool is attached.

Remarks

Required

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment in which the node pool exists.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

InitialNodeLabels

Declaration
[JsonProperty(PropertyName = "initialNodeLabels")]
public List<KeyValue> InitialNodeLabels { get; set; }
Property Value
Type Description
List<KeyValue>

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

KubernetesVersion

Declaration
[JsonProperty(PropertyName = "kubernetesVersion")]
public string KubernetesVersion { get; set; }
Property Value
Type Description
string

The version of Kubernetes to install on the nodes in the node pool.

Name

Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type Description
string

The name of the node pool. Avoid entering confidential information.

Remarks

Required

NodeConfigDetails

Declaration
[JsonProperty(PropertyName = "nodeConfigDetails")]
public CreateNodePoolNodeConfigDetails NodeConfigDetails { get; set; }
Property Value
Type Description
CreateNodePoolNodeConfigDetails

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

NodeEvictionNodePoolSettings

Declaration
[JsonProperty(PropertyName = "nodeEvictionNodePoolSettings")]
public NodeEvictionNodePoolSettings NodeEvictionNodePoolSettings { get; set; }
Property Value
Type Description
NodeEvictionNodePoolSettings

NodeImageName

Declaration
[JsonProperty(PropertyName = "nodeImageName")]
public string NodeImageName { get; set; }
Property Value
Type Description
string

Deprecated. Use nodeSourceDetails instead. If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool.

NodeMetadata

Declaration
[JsonProperty(PropertyName = "nodeMetadata")]
public Dictionary<string, string> NodeMetadata { get; set; }
Property Value
Type Description
Dictionary<string, string>

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

NodePoolCyclingDetails

Declaration
[JsonProperty(PropertyName = "nodePoolCyclingDetails")]
public NodePoolCyclingDetails NodePoolCyclingDetails { get; set; }
Property Value
Type Description
NodePoolCyclingDetails

NodeShape

Declaration
[Required(ErrorMessage = "NodeShape is required.")]
[JsonProperty(PropertyName = "nodeShape")]
public string NodeShape { get; set; }
Property Value
Type Description
string

The name of the node shape of the nodes in the node pool.

Remarks

Required

NodeShapeConfig

Declaration
[JsonProperty(PropertyName = "nodeShapeConfig")]
public CreateNodeShapeConfigDetails NodeShapeConfig { get; set; }
Property Value
Type Description
CreateNodeShapeConfigDetails

Specify the configuration of the shape to launch nodes in the node pool.

NodeSourceDetails

Declaration
[JsonProperty(PropertyName = "nodeSourceDetails")]
public NodeSourceDetails NodeSourceDetails { get; set; }
Property Value
Type Description
NodeSourceDetails

Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

QuantityPerSubnet

Declaration
[JsonProperty(PropertyName = "quantityPerSubnet")]
public int? QuantityPerSubnet { get; set; }
Property Value
Type Description
int?

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.

SshPublicKey

Declaration
[JsonProperty(PropertyName = "sshPublicKey")]
public string SshPublicKey { get; set; }
Property Value
Type Description
string

The SSH public key on each node in the node pool on launch.

SubnetIds

Declaration
[JsonProperty(PropertyName = "subnetIds")]
public List<string> SubnetIds { get; set; }
Property Value
Type Description
List<string>

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.

In this article
Back to top