civo.KubernetesNodePool

Provides a Civo Kubernetes node pool resource. While the default node pool must be defined in the civo.KubernetesCluster resource, this resource can be used to add additional ones to a cluster.

Create KubernetesNodePool Resource

new KubernetesNodePool(name: string, args: KubernetesNodePoolArgs, opts?: CustomResourceOptions);
@overload
def KubernetesNodePool(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cluster_id: Optional[str] = None,
                       label: Optional[str] = None,
                       node_count: Optional[int] = None,
                       num_target_nodes: Optional[int] = None,
                       region: Optional[str] = None,
                       size: Optional[str] = None,
                       target_nodes_size: Optional[str] = None)
@overload
def KubernetesNodePool(resource_name: str,
                       args: KubernetesNodePoolArgs,
                       opts: Optional[ResourceOptions] = None)
func NewKubernetesNodePool(ctx *Context, name string, args KubernetesNodePoolArgs, opts ...ResourceOption) (*KubernetesNodePool, error)
public KubernetesNodePool(string name, KubernetesNodePoolArgs args, CustomResourceOptions? opts = null)
public KubernetesNodePool(String name, KubernetesNodePoolArgs args)
public KubernetesNodePool(String name, KubernetesNodePoolArgs args, CustomResourceOptions options)
type: civo:KubernetesNodePool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args KubernetesNodePoolArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

KubernetesNodePool Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The KubernetesNodePool resource accepts the following input properties:

ClusterId string

The ID of your cluster

Region string

The region of the node pool, has to match that of the cluster

Label string

Node pool label, if you don't provide one, we will generate one for you

NodeCount int

the number of instances to create (optional, the default at the time of writing is 3)

NumTargetNodes int

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

Size string

the size of each node (optional, the default is currently g4s.kube.medium)

TargetNodesSize string

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

ClusterId string

The ID of your cluster

Region string

The region of the node pool, has to match that of the cluster

Label string

Node pool label, if you don't provide one, we will generate one for you

NodeCount int

the number of instances to create (optional, the default at the time of writing is 3)

NumTargetNodes int

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

Size string

the size of each node (optional, the default is currently g4s.kube.medium)

TargetNodesSize string

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

clusterId String

The ID of your cluster

region String

The region of the node pool, has to match that of the cluster

label String

Node pool label, if you don't provide one, we will generate one for you

nodeCount Integer

the number of instances to create (optional, the default at the time of writing is 3)

numTargetNodes Integer

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

size String

the size of each node (optional, the default is currently g4s.kube.medium)

targetNodesSize String

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

clusterId string

The ID of your cluster

region string

The region of the node pool, has to match that of the cluster

label string

Node pool label, if you don't provide one, we will generate one for you

nodeCount number

the number of instances to create (optional, the default at the time of writing is 3)

numTargetNodes number

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

size string

the size of each node (optional, the default is currently g4s.kube.medium)

targetNodesSize string

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

cluster_id str

The ID of your cluster

region str

The region of the node pool, has to match that of the cluster

label str

Node pool label, if you don't provide one, we will generate one for you

node_count int

the number of instances to create (optional, the default at the time of writing is 3)

num_target_nodes int

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

size str

the size of each node (optional, the default is currently g4s.kube.medium)

target_nodes_size str

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

clusterId String

The ID of your cluster

region String

The region of the node pool, has to match that of the cluster

label String

Node pool label, if you don't provide one, we will generate one for you

nodeCount Number

the number of instances to create (optional, the default at the time of writing is 3)

numTargetNodes Number

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

size String

the size of each node (optional, the default is currently g4s.kube.medium)

targetNodesSize String

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

Outputs

All input properties are implicitly available as output properties. Additionally, the KubernetesNodePool resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

InstanceNames List<string>

Instance names in the nodepool

Id string

The provider-assigned unique ID for this managed resource.

InstanceNames []string

Instance names in the nodepool

id String

The provider-assigned unique ID for this managed resource.

instanceNames List<String>

Instance names in the nodepool

id string

The provider-assigned unique ID for this managed resource.

instanceNames string[]

Instance names in the nodepool

id str

The provider-assigned unique ID for this managed resource.

instance_names Sequence[str]

Instance names in the nodepool

id String

The provider-assigned unique ID for this managed resource.

instanceNames List<String>

Instance names in the nodepool

Look up Existing KubernetesNodePool Resource

Get an existing KubernetesNodePool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KubernetesNodePoolState, opts?: CustomResourceOptions): KubernetesNodePool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        instance_names: Optional[Sequence[str]] = None,
        label: Optional[str] = None,
        node_count: Optional[int] = None,
        num_target_nodes: Optional[int] = None,
        region: Optional[str] = None,
        size: Optional[str] = None,
        target_nodes_size: Optional[str] = None) -> KubernetesNodePool
func GetKubernetesNodePool(ctx *Context, name string, id IDInput, state *KubernetesNodePoolState, opts ...ResourceOption) (*KubernetesNodePool, error)
public static KubernetesNodePool Get(string name, Input<string> id, KubernetesNodePoolState? state, CustomResourceOptions? opts = null)
public static KubernetesNodePool get(String name, Output<String> id, KubernetesNodePoolState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClusterId string

The ID of your cluster

InstanceNames List<string>

Instance names in the nodepool

Label string

Node pool label, if you don't provide one, we will generate one for you

NodeCount int

the number of instances to create (optional, the default at the time of writing is 3)

NumTargetNodes int

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

Region string

The region of the node pool, has to match that of the cluster

Size string

the size of each node (optional, the default is currently g4s.kube.medium)

TargetNodesSize string

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

ClusterId string

The ID of your cluster

InstanceNames []string

Instance names in the nodepool

Label string

Node pool label, if you don't provide one, we will generate one for you

NodeCount int

the number of instances to create (optional, the default at the time of writing is 3)

NumTargetNodes int

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

Region string

The region of the node pool, has to match that of the cluster

Size string

the size of each node (optional, the default is currently g4s.kube.medium)

TargetNodesSize string

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

clusterId String

The ID of your cluster

instanceNames List<String>

Instance names in the nodepool

label String

Node pool label, if you don't provide one, we will generate one for you

nodeCount Integer

the number of instances to create (optional, the default at the time of writing is 3)

numTargetNodes Integer

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

region String

The region of the node pool, has to match that of the cluster

size String

the size of each node (optional, the default is currently g4s.kube.medium)

targetNodesSize String

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

clusterId string

The ID of your cluster

instanceNames string[]

Instance names in the nodepool

label string

Node pool label, if you don't provide one, we will generate one for you

nodeCount number

the number of instances to create (optional, the default at the time of writing is 3)

numTargetNodes number

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

region string

The region of the node pool, has to match that of the cluster

size string

the size of each node (optional, the default is currently g4s.kube.medium)

targetNodesSize string

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

cluster_id str

The ID of your cluster

instance_names Sequence[str]

Instance names in the nodepool

label str

Node pool label, if you don't provide one, we will generate one for you

node_count int

the number of instances to create (optional, the default at the time of writing is 3)

num_target_nodes int

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

region str

The region of the node pool, has to match that of the cluster

size str

the size of each node (optional, the default is currently g4s.kube.medium)

target_nodes_size str

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

clusterId String

The ID of your cluster

instanceNames List<String>

Instance names in the nodepool

label String

Node pool label, if you don't provide one, we will generate one for you

nodeCount Number

the number of instances to create (optional, the default at the time of writing is 3)

numTargetNodes Number

the number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field is deprecated, please use node_count instead

region String

The region of the node pool, has to match that of the cluster

size String

the size of each node (optional, the default is currently g4s.kube.medium)

targetNodesSize String

the size of each node (optional, the default is currently g4s.kube.medium)

Deprecated:

This field is deprecated, please use size instead

Import

using cluster_id:node_pool_id

 $ pulumi import civo:index/kubernetesNodePool:KubernetesNodePool my-pool 1b8b2100-0e9f-4e8f-ad78-9eb578c2a0af:502c1130-cb9b-4a88-b6d2-307bd96d946a

Package Details

Repository
Civo pulumi/pulumi-civo
License
Apache-2.0
Notes

This Pulumi package is based on the civo Terraform Provider.