Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. KubernetesNodePool
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.KubernetesNodePool

Explore with Pulumi AI

scaleway logo
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
pulumiverse/pulumi-scaleway

    Import

    Kubernetes pools can be imported using the {region}/{id}, e.g.

    bash

    $ pulumi import scaleway:index/kubernetesNodePool:KubernetesNodePool mypool fr-par/11111111-1111-1111-1111-111111111111

    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,
                       node_type: Optional[str] = None,
                       size: Optional[int] = None,
                       cluster_id: Optional[str] = None,
                       kubelet_args: Optional[Mapping[str, str]] = None,
                       public_ip_disabled: Optional[bool] = None,
                       max_size: Optional[int] = None,
                       min_size: Optional[int] = None,
                       name: Optional[str] = None,
                       container_runtime: Optional[str] = None,
                       placement_group_id: Optional[str] = None,
                       autohealing: Optional[bool] = None,
                       region: Optional[str] = None,
                       root_volume_size_in_gb: Optional[int] = None,
                       root_volume_type: Optional[str] = None,
                       autoscaling: Optional[bool] = None,
                       tags: Optional[Sequence[str]] = None,
                       upgrade_policy: Optional[KubernetesNodePoolUpgradePolicyArgs] = None,
                       wait_for_pool_ready: Optional[bool] = None,
                       zone: Optional[str] = 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: scaleway: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 Scaleway.KubernetesNodePool("kubernetesNodePoolResource", new()
{
    NodeType = "string",
    Size = 0,
    ClusterId = "string",
    KubeletArgs = 
    {
        { "string", "string" },
    },
    PublicIpDisabled = false,
    MaxSize = 0,
    MinSize = 0,
    Name = "string",
    ContainerRuntime = "string",
    PlacementGroupId = "string",
    Autohealing = false,
    Region = "string",
    RootVolumeSizeInGb = 0,
    RootVolumeType = "string",
    Autoscaling = false,
    Tags = new[]
    {
        "string",
    },
    UpgradePolicy = new Scaleway.Inputs.KubernetesNodePoolUpgradePolicyArgs
    {
        MaxSurge = 0,
        MaxUnavailable = 0,
    },
    WaitForPoolReady = false,
    Zone = "string",
});

    example, err := scaleway.NewKubernetesNodePool(ctx, "kubernetesNodePoolResource", &scaleway.KubernetesNodePoolArgs{
	NodeType:  pulumi.String("string"),
	Size:      pulumi.Int(0),
	ClusterId: pulumi.String("string"),
	KubeletArgs: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PublicIpDisabled:   pulumi.Bool(false),
	MaxSize:            pulumi.Int(0),
	MinSize:            pulumi.Int(0),
	Name:               pulumi.String("string"),
	ContainerRuntime:   pulumi.String("string"),
	PlacementGroupId:   pulumi.String("string"),
	Autohealing:        pulumi.Bool(false),
	Region:             pulumi.String("string"),
	RootVolumeSizeInGb: pulumi.Int(0),
	RootVolumeType:     pulumi.String("string"),
	Autoscaling:        pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UpgradePolicy: &scaleway.KubernetesNodePoolUpgradePolicyArgs{
		MaxSurge:       pulumi.Int(0),
		MaxUnavailable: pulumi.Int(0),
	},
	WaitForPoolReady: pulumi.Bool(false),
	Zone:             pulumi.String("string"),
})

    var kubernetesNodePoolResource = new KubernetesNodePool("kubernetesNodePoolResource", KubernetesNodePoolArgs.builder()
    .nodeType("string")
    .size(0)
    .clusterId("string")
    .kubeletArgs(Map.of("string", "string"))
    .publicIpDisabled(false)
    .maxSize(0)
    .minSize(0)
    .name("string")
    .containerRuntime("string")
    .placementGroupId("string")
    .autohealing(false)
    .region("string")
    .rootVolumeSizeInGb(0)
    .rootVolumeType("string")
    .autoscaling(false)
    .tags("string")
    .upgradePolicy(KubernetesNodePoolUpgradePolicyArgs.builder()
        .maxSurge(0)
        .maxUnavailable(0)
        .build())
    .waitForPoolReady(false)
    .zone("string")
    .build());

    kubernetes_node_pool_resource = scaleway.KubernetesNodePool("kubernetesNodePoolResource",
    node_type="string",
    size=0,
    cluster_id="string",
    kubelet_args={
        "string": "string",
    },
    public_ip_disabled=False,
    max_size=0,
    min_size=0,
    name="string",
    container_runtime="string",
    placement_group_id="string",
    autohealing=False,
    region="string",
    root_volume_size_in_gb=0,
    root_volume_type="string",
    autoscaling=False,
    tags=["string"],
    upgrade_policy={
        "max_surge": 0,
        "max_unavailable": 0,
    },
    wait_for_pool_ready=False,
    zone="string")

    const kubernetesNodePoolResource = new scaleway.KubernetesNodePool("kubernetesNodePoolResource", {
    nodeType: "string",
    size: 0,
    clusterId: "string",
    kubeletArgs: {
        string: "string",
    },
    publicIpDisabled: false,
    maxSize: 0,
    minSize: 0,
    name: "string",
    containerRuntime: "string",
    placementGroupId: "string",
    autohealing: false,
    region: "string",
    rootVolumeSizeInGb: 0,
    rootVolumeType: "string",
    autoscaling: false,
    tags: ["string"],
    upgradePolicy: {
        maxSurge: 0,
        maxUnavailable: 0,
    },
    waitForPoolReady: false,
    zone: "string",
});

    type: scaleway:KubernetesNodePool
properties:
    autohealing: false
    autoscaling: false
    clusterId: string
    containerRuntime: string
    kubeletArgs:
        string: string
    maxSize: 0
    minSize: 0
    name: string
    nodeType: string
    placementGroupId: string
    publicIpDisabled: false
    region: string
    rootVolumeSizeInGb: 0
    rootVolumeType: string
    size: 0
    tags:
        - string
    upgradePolicy:
        maxSurge: 0
        maxUnavailable: 0
    waitForPoolReady: false
    zone: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The KubernetesNodePool resource accepts the following input properties:

    ClusterId string
    The ID of the Kubernetes cluster on which this pool will be created.
    NodeType string

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    Size int

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    Autohealing bool
    Enables the autohealing feature for this pool.
    Autoscaling bool

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    ContainerRuntime string

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    KubeletArgs Dictionary<string, string>
    The Kubelet arguments to be used by this pool
    MaxSize int
    The maximum size of the pool, used by the autoscaling feature.
    MinSize int
    The minimum size of the pool, used by the autoscaling feature.
    Name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    PlacementGroupId string

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    PublicIpDisabled bool

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    Region string
    region) The region in which the pool should be created.
    RootVolumeSizeInGb int
    The size of the system volume of the nodes in gigabyte
    RootVolumeType string
    System volume type of the nodes composing the pool
    Tags List<string>

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    UpgradePolicy Pulumiverse.Scaleway.Inputs.KubernetesNodePoolUpgradePolicy
    The Pool upgrade policy
    WaitForPoolReady bool
    Whether to wait for the pool to be ready.
    Zone string

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    ClusterId string
    The ID of the Kubernetes cluster on which this pool will be created.
    NodeType string

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    Size int

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    Autohealing bool
    Enables the autohealing feature for this pool.
    Autoscaling bool

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    ContainerRuntime string

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    KubeletArgs map[string]string
    The Kubelet arguments to be used by this pool
    MaxSize int
    The maximum size of the pool, used by the autoscaling feature.
    MinSize int
    The minimum size of the pool, used by the autoscaling feature.
    Name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    PlacementGroupId string

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    PublicIpDisabled bool

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    Region string
    region) The region in which the pool should be created.
    RootVolumeSizeInGb int
    The size of the system volume of the nodes in gigabyte
    RootVolumeType string
    System volume type of the nodes composing the pool
    Tags []string

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    UpgradePolicy KubernetesNodePoolUpgradePolicyArgs
    The Pool upgrade policy
    WaitForPoolReady bool
    Whether to wait for the pool to be ready.
    Zone string

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    clusterId String
    The ID of the Kubernetes cluster on which this pool will be created.
    nodeType String

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    size Integer

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    autohealing Boolean
    Enables the autohealing feature for this pool.
    autoscaling Boolean

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    containerRuntime String

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    kubeletArgs Map<String,String>
    The Kubelet arguments to be used by this pool
    maxSize Integer
    The maximum size of the pool, used by the autoscaling feature.
    minSize Integer
    The minimum size of the pool, used by the autoscaling feature.
    name String

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    placementGroupId String

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    publicIpDisabled Boolean

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region String
    region) The region in which the pool should be created.
    rootVolumeSizeInGb Integer
    The size of the system volume of the nodes in gigabyte
    rootVolumeType String
    System volume type of the nodes composing the pool
    tags List<String>

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    upgradePolicy KubernetesNodePoolUpgradePolicy
    The Pool upgrade policy
    waitForPoolReady Boolean
    Whether to wait for the pool to be ready.
    zone String

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    clusterId string
    The ID of the Kubernetes cluster on which this pool will be created.
    nodeType string

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    size number

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    autohealing boolean
    Enables the autohealing feature for this pool.
    autoscaling boolean

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    containerRuntime string

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    kubeletArgs {[key: string]: string}
    The Kubelet arguments to be used by this pool
    maxSize number
    The maximum size of the pool, used by the autoscaling feature.
    minSize number
    The minimum size of the pool, used by the autoscaling feature.
    name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    placementGroupId string

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    publicIpDisabled boolean

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region string
    region) The region in which the pool should be created.
    rootVolumeSizeInGb number
    The size of the system volume of the nodes in gigabyte
    rootVolumeType string
    System volume type of the nodes composing the pool
    tags string[]

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    upgradePolicy KubernetesNodePoolUpgradePolicy
    The Pool upgrade policy
    waitForPoolReady boolean
    Whether to wait for the pool to be ready.
    zone string

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    cluster_id str
    The ID of the Kubernetes cluster on which this pool will be created.
    node_type str

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    size int

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    autohealing bool
    Enables the autohealing feature for this pool.
    autoscaling bool

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    container_runtime str

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    kubelet_args Mapping[str, str]
    The Kubelet arguments to be used by this pool
    max_size int
    The maximum size of the pool, used by the autoscaling feature.
    min_size int
    The minimum size of the pool, used by the autoscaling feature.
    name str

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    placement_group_id str

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    public_ip_disabled bool

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region str
    region) The region in which the pool should be created.
    root_volume_size_in_gb int
    The size of the system volume of the nodes in gigabyte
    root_volume_type str
    System volume type of the nodes composing the pool
    tags Sequence[str]

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    upgrade_policy KubernetesNodePoolUpgradePolicyArgs
    The Pool upgrade policy
    wait_for_pool_ready bool
    Whether to wait for the pool to be ready.
    zone str

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    clusterId String
    The ID of the Kubernetes cluster on which this pool will be created.
    nodeType String

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    size Number

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    autohealing Boolean
    Enables the autohealing feature for this pool.
    autoscaling Boolean

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    containerRuntime String

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    kubeletArgs Map<String>
    The Kubelet arguments to be used by this pool
    maxSize Number
    The maximum size of the pool, used by the autoscaling feature.
    minSize Number
    The minimum size of the pool, used by the autoscaling feature.
    name String

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    placementGroupId String

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    publicIpDisabled Boolean

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region String
    region) The region in which the pool should be created.
    rootVolumeSizeInGb Number
    The size of the system volume of the nodes in gigabyte
    rootVolumeType String
    System volume type of the nodes composing the pool
    tags List<String>

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    upgradePolicy Property Map
    The Pool upgrade policy
    waitForPoolReady Boolean
    Whether to wait for the pool to be ready.
    zone String

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    Outputs

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

    CreatedAt string
    The creation date of the pool.
    CurrentSize int
    The actual size of the pool
    Id string
    The provider-assigned unique ID for this managed resource.
    Nodes List<Pulumiverse.Scaleway.Outputs.KubernetesNodePoolNode>
    (List of) The nodes in the default pool.
    Status string
    The status of the node.
    UpdatedAt string
    The last update date of the pool.
    Version string
    The version of the pool.
    CreatedAt string
    The creation date of the pool.
    CurrentSize int
    The actual size of the pool
    Id string
    The provider-assigned unique ID for this managed resource.
    Nodes []KubernetesNodePoolNode
    (List of) The nodes in the default pool.
    Status string
    The status of the node.
    UpdatedAt string
    The last update date of the pool.
    Version string
    The version of the pool.
    createdAt String
    The creation date of the pool.
    currentSize Integer
    The actual size of the pool
    id String
    The provider-assigned unique ID for this managed resource.
    nodes List<KubernetesNodePoolNode>
    (List of) The nodes in the default pool.
    status String
    The status of the node.
    updatedAt String
    The last update date of the pool.
    version String
    The version of the pool.
    createdAt string
    The creation date of the pool.
    currentSize number
    The actual size of the pool
    id string
    The provider-assigned unique ID for this managed resource.
    nodes KubernetesNodePoolNode[]
    (List of) The nodes in the default pool.
    status string
    The status of the node.
    updatedAt string
    The last update date of the pool.
    version string
    The version of the pool.
    created_at str
    The creation date of the pool.
    current_size int
    The actual size of the pool
    id str
    The provider-assigned unique ID for this managed resource.
    nodes Sequence[KubernetesNodePoolNode]
    (List of) The nodes in the default pool.
    status str
    The status of the node.
    updated_at str
    The last update date of the pool.
    version str
    The version of the pool.
    createdAt String
    The creation date of the pool.
    currentSize Number
    The actual size of the pool
    id String
    The provider-assigned unique ID for this managed resource.
    nodes List<Property Map>
    (List of) The nodes in the default pool.
    status String
    The status of the node.
    updatedAt String
    The last update date of the pool.
    version String
    The version of the pool.

    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,
        autohealing: Optional[bool] = None,
        autoscaling: Optional[bool] = None,
        cluster_id: Optional[str] = None,
        container_runtime: Optional[str] = None,
        created_at: Optional[str] = None,
        current_size: Optional[int] = None,
        kubelet_args: Optional[Mapping[str, str]] = None,
        max_size: Optional[int] = None,
        min_size: Optional[int] = None,
        name: Optional[str] = None,
        node_type: Optional[str] = None,
        nodes: Optional[Sequence[KubernetesNodePoolNodeArgs]] = None,
        placement_group_id: Optional[str] = None,
        public_ip_disabled: Optional[bool] = None,
        region: Optional[str] = None,
        root_volume_size_in_gb: Optional[int] = None,
        root_volume_type: Optional[str] = None,
        size: Optional[int] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[str] = None,
        upgrade_policy: Optional[KubernetesNodePoolUpgradePolicyArgs] = None,
        version: Optional[str] = None,
        wait_for_pool_ready: Optional[bool] = None,
        zone: 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:
    Autohealing bool
    Enables the autohealing feature for this pool.
    Autoscaling bool

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    ClusterId string
    The ID of the Kubernetes cluster on which this pool will be created.
    ContainerRuntime string

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    CreatedAt string
    The creation date of the pool.
    CurrentSize int
    The actual size of the pool
    KubeletArgs Dictionary<string, string>
    The Kubelet arguments to be used by this pool
    MaxSize int
    The maximum size of the pool, used by the autoscaling feature.
    MinSize int
    The minimum size of the pool, used by the autoscaling feature.
    Name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    NodeType string

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    Nodes List<Pulumiverse.Scaleway.Inputs.KubernetesNodePoolNode>
    (List of) The nodes in the default pool.
    PlacementGroupId string

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    PublicIpDisabled bool

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    Region string
    region) The region in which the pool should be created.
    RootVolumeSizeInGb int
    The size of the system volume of the nodes in gigabyte
    RootVolumeType string
    System volume type of the nodes composing the pool
    Size int

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    Status string
    The status of the node.
    Tags List<string>

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    UpdatedAt string
    The last update date of the pool.
    UpgradePolicy Pulumiverse.Scaleway.Inputs.KubernetesNodePoolUpgradePolicy
    The Pool upgrade policy
    Version string
    The version of the pool.
    WaitForPoolReady bool
    Whether to wait for the pool to be ready.
    Zone string

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    Autohealing bool
    Enables the autohealing feature for this pool.
    Autoscaling bool

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    ClusterId string
    The ID of the Kubernetes cluster on which this pool will be created.
    ContainerRuntime string

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    CreatedAt string
    The creation date of the pool.
    CurrentSize int
    The actual size of the pool
    KubeletArgs map[string]string
    The Kubelet arguments to be used by this pool
    MaxSize int
    The maximum size of the pool, used by the autoscaling feature.
    MinSize int
    The minimum size of the pool, used by the autoscaling feature.
    Name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    NodeType string

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    Nodes []KubernetesNodePoolNodeArgs
    (List of) The nodes in the default pool.
    PlacementGroupId string

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    PublicIpDisabled bool

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    Region string
    region) The region in which the pool should be created.
    RootVolumeSizeInGb int
    The size of the system volume of the nodes in gigabyte
    RootVolumeType string
    System volume type of the nodes composing the pool
    Size int

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    Status string
    The status of the node.
    Tags []string

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    UpdatedAt string
    The last update date of the pool.
    UpgradePolicy KubernetesNodePoolUpgradePolicyArgs
    The Pool upgrade policy
    Version string
    The version of the pool.
    WaitForPoolReady bool
    Whether to wait for the pool to be ready.
    Zone string

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    autohealing Boolean
    Enables the autohealing feature for this pool.
    autoscaling Boolean

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    clusterId String
    The ID of the Kubernetes cluster on which this pool will be created.
    containerRuntime String

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    createdAt String
    The creation date of the pool.
    currentSize Integer
    The actual size of the pool
    kubeletArgs Map<String,String>
    The Kubelet arguments to be used by this pool
    maxSize Integer
    The maximum size of the pool, used by the autoscaling feature.
    minSize Integer
    The minimum size of the pool, used by the autoscaling feature.
    name String

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    nodeType String

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    nodes List<KubernetesNodePoolNode>
    (List of) The nodes in the default pool.
    placementGroupId String

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    publicIpDisabled Boolean

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region String
    region) The region in which the pool should be created.
    rootVolumeSizeInGb Integer
    The size of the system volume of the nodes in gigabyte
    rootVolumeType String
    System volume type of the nodes composing the pool
    size Integer

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    status String
    The status of the node.
    tags List<String>

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    updatedAt String
    The last update date of the pool.
    upgradePolicy KubernetesNodePoolUpgradePolicy
    The Pool upgrade policy
    version String
    The version of the pool.
    waitForPoolReady Boolean
    Whether to wait for the pool to be ready.
    zone String

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    autohealing boolean
    Enables the autohealing feature for this pool.
    autoscaling boolean

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    clusterId string
    The ID of the Kubernetes cluster on which this pool will be created.
    containerRuntime string

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    createdAt string
    The creation date of the pool.
    currentSize number
    The actual size of the pool
    kubeletArgs {[key: string]: string}
    The Kubelet arguments to be used by this pool
    maxSize number
    The maximum size of the pool, used by the autoscaling feature.
    minSize number
    The minimum size of the pool, used by the autoscaling feature.
    name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    nodeType string

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    nodes KubernetesNodePoolNode[]
    (List of) The nodes in the default pool.
    placementGroupId string

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    publicIpDisabled boolean

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region string
    region) The region in which the pool should be created.
    rootVolumeSizeInGb number
    The size of the system volume of the nodes in gigabyte
    rootVolumeType string
    System volume type of the nodes composing the pool
    size number

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    status string
    The status of the node.
    tags string[]

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    updatedAt string
    The last update date of the pool.
    upgradePolicy KubernetesNodePoolUpgradePolicy
    The Pool upgrade policy
    version string
    The version of the pool.
    waitForPoolReady boolean
    Whether to wait for the pool to be ready.
    zone string

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    autohealing bool
    Enables the autohealing feature for this pool.
    autoscaling bool

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    cluster_id str
    The ID of the Kubernetes cluster on which this pool will be created.
    container_runtime str

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    created_at str
    The creation date of the pool.
    current_size int
    The actual size of the pool
    kubelet_args Mapping[str, str]
    The Kubelet arguments to be used by this pool
    max_size int
    The maximum size of the pool, used by the autoscaling feature.
    min_size int
    The minimum size of the pool, used by the autoscaling feature.
    name str

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    node_type str

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    nodes Sequence[KubernetesNodePoolNodeArgs]
    (List of) The nodes in the default pool.
    placement_group_id str

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    public_ip_disabled bool

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region str
    region) The region in which the pool should be created.
    root_volume_size_in_gb int
    The size of the system volume of the nodes in gigabyte
    root_volume_type str
    System volume type of the nodes composing the pool
    size int

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    status str
    The status of the node.
    tags Sequence[str]

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    updated_at str
    The last update date of the pool.
    upgrade_policy KubernetesNodePoolUpgradePolicyArgs
    The Pool upgrade policy
    version str
    The version of the pool.
    wait_for_pool_ready bool
    Whether to wait for the pool to be ready.
    zone str

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    autohealing Boolean
    Enables the autohealing feature for this pool.
    autoscaling Boolean

    Enables the autoscaling feature for this pool.

    Important: When enabled, an update of the size will not be taken into account.

    clusterId String
    The ID of the Kubernetes cluster on which this pool will be created.
    containerRuntime String

    The container runtime of the pool.

    Important: Updates to this field will recreate a new resource.

    createdAt String
    The creation date of the pool.
    currentSize Number
    The actual size of the pool
    kubeletArgs Map<String>
    The Kubelet arguments to be used by this pool
    maxSize Number
    The maximum size of the pool, used by the autoscaling feature.
    minSize Number
    The minimum size of the pool, used by the autoscaling feature.
    name String

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    nodeType String

    The commercial type of the pool instances. Instances with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). external is a special node type used to provision from other Cloud providers.

    Important: Updates to this field will recreate a new resource.

    nodes List<Property Map>
    (List of) The nodes in the default pool.
    placementGroupId String

    The placement group the nodes of the pool will be attached to.

    Important: Updates to this field will recreate a new resource.

    publicIpDisabled Boolean

    Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway.

    Important: Updates to this field will recreate a new resource.

    region String
    region) The region in which the pool should be created.
    rootVolumeSizeInGb Number
    The size of the system volume of the nodes in gigabyte
    rootVolumeType String
    System volume type of the nodes composing the pool
    size Number

    The size of the pool.

    Important: This field will only be used at creation if autoscaling is enabled.

    status String
    The status of the node.
    tags List<String>

    The tags associated with the pool.

    Note: As mentionned in this document, taints of a pool's nodes are applied using tags. (Example: "taint=taintName=taineValue:Effect")

    updatedAt String
    The last update date of the pool.
    upgradePolicy Property Map
    The Pool upgrade policy
    version String
    The version of the pool.
    waitForPoolReady Boolean
    Whether to wait for the pool to be ready.
    zone String

    zone) The zone in which the pool should be created.

    Important: Updates to this field will recreate a new resource.

    Supporting Types

    KubernetesNodePoolNode, KubernetesNodePoolNodeArgs

    Name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    PublicIp string
    The public IPv4. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    PublicIpV6 string
    The public IPv6. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    Status string
    The status of the node.
    Name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    PublicIp string
    The public IPv4. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    PublicIpV6 string
    The public IPv6. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    Status string
    The status of the node.
    name String

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    publicIp String
    The public IPv4. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    publicIpV6 String
    The public IPv6. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    status String
    The status of the node.
    name string

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    publicIp string
    The public IPv4. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    publicIpV6 string
    The public IPv6. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    status string
    The status of the node.
    name str

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    public_ip str
    The public IPv4. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    public_ip_v6 str
    The public IPv6. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    status str
    The status of the node.
    name String

    The name for the pool.

    Important: Updates to this field will recreate a new resource.

    publicIp String
    The public IPv4. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    publicIpV6 String
    The public IPv6. (Deprecated, Please use the official Kubernetes provider and the kubernetes_nodes data source)

    Deprecated: Please use the official Kubernetes provider and the kubernetes_nodes data source

    status String
    The status of the node.

    KubernetesNodePoolUpgradePolicy, KubernetesNodePoolUpgradePolicyArgs

    MaxSurge int
    The maximum number of nodes to be created during the upgrade
    MaxUnavailable int
    The maximum number of nodes that can be not ready at the same time
    MaxSurge int
    The maximum number of nodes to be created during the upgrade
    MaxUnavailable int
    The maximum number of nodes that can be not ready at the same time
    maxSurge Integer
    The maximum number of nodes to be created during the upgrade
    maxUnavailable Integer
    The maximum number of nodes that can be not ready at the same time
    maxSurge number
    The maximum number of nodes to be created during the upgrade
    maxUnavailable number
    The maximum number of nodes that can be not ready at the same time
    max_surge int
    The maximum number of nodes to be created during the upgrade
    max_unavailable int
    The maximum number of nodes that can be not ready at the same time
    maxSurge Number
    The maximum number of nodes to be created during the upgrade
    maxUnavailable Number
    The maximum number of nodes that can be not ready at the same time

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
    pulumiverse/pulumi-scaleway