Docs Packages
  1. Packages
  2. Civo
  3. API Docs
  4. KubernetesNodePool
Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi
pulumi/pulumi-civo

civo.KubernetesNodePool

Explore with Pulumi AI

civo logo
Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi
pulumi/pulumi-civo

    Import

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

    Create KubernetesNodePool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new KubernetesNodePool(name: string, args: KubernetesNodePoolArgs, opts?: CustomResourceOptions);
    @overload
def KubernetesNodePool(resource_name: str,
                       args: KubernetesNodePoolArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def KubernetesNodePool(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       cluster_id: Optional[str] = None,
                       node_count: Optional[int] = None,
                       size: Optional[str] = None,
                       label: Optional[str] = None,
                       labels: Optional[Mapping[str, str]] = None,
                       public_ip_node_pool: Optional[bool] = None,
                       taints: Optional[Sequence[KubernetesNodePoolTaintArgs]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var kubernetesNodePoolResource = new Civo.KubernetesNodePool("kubernetesNodePoolResource", new()
{
    ClusterId = "string",
    NodeCount = 0,
    Size = "string",
    Label = "string",
    Labels = 
    {
        { "string", "string" },
    },
    PublicIpNodePool = false,
    Taints = new[]
    {
        new Civo.Inputs.KubernetesNodePoolTaintArgs
        {
            Effect = "string",
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := civo.NewKubernetesNodePool(ctx, "kubernetesNodePoolResource", &civo.KubernetesNodePoolArgs{
	ClusterId: pulumi.String("string"),
	NodeCount: pulumi.Int(0),
	Size:      pulumi.String("string"),
	Label:     pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PublicIpNodePool: pulumi.Bool(false),
	Taints: civo.KubernetesNodePoolTaintArray{
		&civo.KubernetesNodePoolTaintArgs{
			Effect: pulumi.String("string"),
			Key:    pulumi.String("string"),
			Value:  pulumi.String("string"),
		},
	},
})

    var kubernetesNodePoolResource = new KubernetesNodePool("kubernetesNodePoolResource", KubernetesNodePoolArgs.builder()
    .clusterId("string")
    .nodeCount(0)
    .size("string")
    .label("string")
    .labels(Map.of("string", "string"))
    .publicIpNodePool(false)
    .taints(KubernetesNodePoolTaintArgs.builder()
        .effect("string")
        .key("string")
        .value("string")
        .build())
    .build());

    kubernetes_node_pool_resource = civo.KubernetesNodePool("kubernetesNodePoolResource",
    cluster_id="string",
    node_count=0,
    size="string",
    label="string",
    labels={
        "string": "string",
    },
    public_ip_node_pool=False,
    taints=[civo.KubernetesNodePoolTaintArgs(
        effect="string",
        key="string",
        value="string",
    )])

    const kubernetesNodePoolResource = new civo.KubernetesNodePool("kubernetesNodePoolResource", {
    clusterId: "string",
    nodeCount: 0,
    size: "string",
    label: "string",
    labels: {
        string: "string",
    },
    publicIpNodePool: false,
    taints: [{
        effect: "string",
        key: "string",
        value: "string",
    }],
});

    type: civo:KubernetesNodePool
properties:
    clusterId: string
    label: string
    labels:
        string: string
    nodeCount: 0
    publicIpNodePool: false
    size: string
    taints:
        - effect: string
          key: string
          value: string

    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
    NodeCount int
    Number of nodes in the nodepool
    Size string
    Size of the nodes in the nodepool
    Label string
    Node pool label, if you don't provide one, we will generate one for you
    Labels Dictionary<string, string>
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    Taints List<KubernetesNodePoolTaint>
    ClusterId string
    The ID of your cluster
    NodeCount int
    Number of nodes in the nodepool
    Size string
    Size of the nodes in the nodepool
    Label string
    Node pool label, if you don't provide one, we will generate one for you
    Labels map[string]string
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    Taints []KubernetesNodePoolTaintArgs
    clusterId String
    The ID of your cluster
    nodeCount Integer
    Number of nodes in the nodepool
    size String
    Size of the nodes in the nodepool
    label String
    Node pool label, if you don't provide one, we will generate one for you
    labels Map<String,String>
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    taints List<KubernetesNodePoolTaint>
    clusterId string
    The ID of your cluster
    nodeCount number
    Number of nodes in the nodepool
    size string
    Size of the nodes in the nodepool
    label string
    Node pool label, if you don't provide one, we will generate one for you
    labels {[key: string]: string}
    publicIpNodePool boolean
    Node pool belongs to the public ip node pool
    taints KubernetesNodePoolTaint[]
    cluster_id str
    The ID of your cluster
    node_count int
    Number of nodes in the nodepool
    size str
    Size of the nodes in the nodepool
    label str
    Node pool label, if you don't provide one, we will generate one for you
    labels Mapping[str, str]
    public_ip_node_pool bool
    Node pool belongs to the public ip node pool
    taints Sequence[KubernetesNodePoolTaintArgs]
    clusterId String
    The ID of your cluster
    nodeCount Number
    Number of nodes in the nodepool
    size String
    Size of the nodes in the nodepool
    label String
    Node pool label, if you don't provide one, we will generate one for you
    labels Map<String>
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    taints List<Property Map>

    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,
        labels: Optional[Mapping[str, str]] = None,
        node_count: Optional[int] = None,
        public_ip_node_pool: Optional[bool] = None,
        size: Optional[str] = None,
        taints: Optional[Sequence[KubernetesNodePoolTaintArgs]] = 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
    Labels Dictionary<string, string>
    NodeCount int
    Number of nodes in the nodepool
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    Size string
    Size of the nodes in the nodepool
    Taints List<KubernetesNodePoolTaint>
    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
    Labels map[string]string
    NodeCount int
    Number of nodes in the nodepool
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    Size string
    Size of the nodes in the nodepool
    Taints []KubernetesNodePoolTaintArgs
    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
    labels Map<String,String>
    nodeCount Integer
    Number of nodes in the nodepool
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    size String
    Size of the nodes in the nodepool
    taints List<KubernetesNodePoolTaint>
    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
    labels {[key: string]: string}
    nodeCount number
    Number of nodes in the nodepool
    publicIpNodePool boolean
    Node pool belongs to the public ip node pool
    size string
    Size of the nodes in the nodepool
    taints KubernetesNodePoolTaint[]
    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
    labels Mapping[str, str]
    node_count int
    Number of nodes in the nodepool
    public_ip_node_pool bool
    Node pool belongs to the public ip node pool
    size str
    Size of the nodes in the nodepool
    taints Sequence[KubernetesNodePoolTaintArgs]
    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
    labels Map<String>
    nodeCount Number
    Number of nodes in the nodepool
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    size String
    Size of the nodes in the nodepool
    taints List<Property Map>

    Supporting Types

    KubernetesNodePoolTaint, KubernetesNodePoolTaintArgs

    Effect string
    Key string
    Value string
    Effect string
    Key string
    Value string
    effect String
    key String
    value String
    effect string
    key string
    value string
    effect str
    key str
    value str
    effect String
    key String
    value String

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi
    pulumi/pulumi-civo