1. Packages
  2. Civo
  3. API Docs
  4. KubernetesNodePool
Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi

civo.KubernetesNodePool

Explore with Pulumi AI

civo logo
Civo v2.3.13 published on Friday, Jan 19, 2024 by Pulumi

    Import

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

    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,
                           labels: Optional[Mapping[str, str]] = None,
                           node_count: Optional[int] = None,
                           public_ip_node_pool: Optional[bool] = None,
                           region: Optional[str] = None,
                           size: Optional[str] = None,
                           taints: Optional[Sequence[KubernetesNodePoolTaintArgs]] = 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
    Labels Dictionary<string, string>
    NodeCount int
    the number of instances to create (optional, the default at the time of writing is 3)
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    Size string
    the size of each node (optional, the default is currently g4s.kube.medium)
    Taints List<KubernetesNodePoolTaint>
    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
    Labels map[string]string
    NodeCount int
    the number of instances to create (optional, the default at the time of writing is 3)
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    Size string
    the size of each node (optional, the default is currently g4s.kube.medium)
    Taints []KubernetesNodePoolTaintArgs
    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
    labels Map<String,String>
    nodeCount Integer
    the number of instances to create (optional, the default at the time of writing is 3)
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    size String
    the size of each node (optional, the default is currently g4s.kube.medium)
    taints List<KubernetesNodePoolTaint>
    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
    labels {[key: string]: string}
    nodeCount number
    the number of instances to create (optional, the default at the time of writing is 3)
    publicIpNodePool boolean
    Node pool belongs to the public ip node pool
    size string
    the size of each node (optional, the default is currently g4s.kube.medium)
    taints KubernetesNodePoolTaint[]
    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
    labels Mapping[str, str]
    node_count int
    the number of instances to create (optional, the default at the time of writing is 3)
    public_ip_node_pool bool
    Node pool belongs to the public ip node pool
    size str
    the size of each node (optional, the default is currently g4s.kube.medium)
    taints Sequence[KubernetesNodePoolTaintArgs]
    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
    labels Map<String>
    nodeCount Number
    the number of instances to create (optional, the default at the time of writing is 3)
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    size String
    the size of each node (optional, the default is currently g4s.kube.medium)
    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,
            region: Optional[str] = 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
    the number of instances to create (optional, the default at the time of writing is 3)
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    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)
    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
    the number of instances to create (optional, the default at the time of writing is 3)
    PublicIpNodePool bool
    Node pool belongs to the public ip node pool
    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)
    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
    the number of instances to create (optional, the default at the time of writing is 3)
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    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)
    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
    the number of instances to create (optional, the default at the time of writing is 3)
    publicIpNodePool boolean
    Node pool belongs to the public ip node pool
    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)
    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
    the number of instances to create (optional, the default at the time of writing is 3)
    public_ip_node_pool bool
    Node pool belongs to the public ip node pool
    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)
    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
    the number of instances to create (optional, the default at the time of writing is 3)
    publicIpNodePool Boolean
    Node pool belongs to the public ip node pool
    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)
    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.13 published on Friday, Jan 19, 2024 by Pulumi