Scaleway

Community
Package contributed by a community member
v0.2.1 published on Friday, Feb 25, 2022 by Lee Briggs

getKubernetesNodePool

Gets information about a Kubernetes Cluster’s Pool.

Example Usage

using Pulumi;
using Scaleway = Pulumi.Scaleway;

class MyStack : Stack
{
    public MyStack()
    {
        var myKey = Output.Create(Scaleway.GetKubernetesNodePool.InvokeAsync(new Scaleway.GetKubernetesNodePoolArgs
        {
            PoolId = "11111111-1111-1111-1111-111111111111",
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-scaleway/sdk/go/scaleway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scaleway.LookupKubernetesNodePool(ctx, &GetKubernetesNodePoolArgs{
			PoolId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_scaleway as scaleway

my_key = scaleway.get_kubernetes_node_pool(pool_id="11111111-1111-1111-1111-111111111111")
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";

// Get info by pool id
const myKey = pulumi.output(scaleway.getKubernetesNodePool({
    poolId: "11111111-1111-1111-1111-111111111111",
}));

Coming soon!

Using getKubernetesNodePool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKubernetesNodePool(args: GetKubernetesNodePoolArgs, opts?: InvokeOptions): Promise<GetKubernetesNodePoolResult>
function getKubernetesNodePoolOutput(args: GetKubernetesNodePoolOutputArgs, opts?: InvokeOptions): Output<GetKubernetesNodePoolResult>
def get_kubernetes_node_pool(cluster_id: Optional[str] = None,
                             name: Optional[str] = None,
                             pool_id: Optional[str] = None,
                             region: Optional[str] = None,
                             size: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> GetKubernetesNodePoolResult
def get_kubernetes_node_pool_output(cluster_id: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             pool_id: Optional[pulumi.Input[str]] = None,
                             region: Optional[pulumi.Input[str]] = None,
                             size: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesNodePoolResult]
func LookupKubernetesNodePool(ctx *Context, args *LookupKubernetesNodePoolArgs, opts ...InvokeOption) (*LookupKubernetesNodePoolResult, error)
func LookupKubernetesNodePoolOutput(ctx *Context, args *LookupKubernetesNodePoolOutputArgs, opts ...InvokeOption) LookupKubernetesNodePoolResultOutput

> Note: This function is named LookupKubernetesNodePool in the Go SDK.

public static class GetKubernetesNodePool 
{
    public static Task<GetKubernetesNodePoolResult> InvokeAsync(GetKubernetesNodePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesNodePoolResult> Invoke(GetKubernetesNodePoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKubernetesNodePoolResult> getKubernetesNodePool(GetKubernetesNodePoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: scaleway:index/getKubernetesNodePool:getKubernetesNodePool
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ClusterId string

The cluster ID. Required when name is set.

Name string

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

PoolId string

The pool's ID. Only one of name and pool_id should be specified.

Region string

region) The region in which the pool exists.

Size int

The size of the pool.

ClusterId string

The cluster ID. Required when name is set.

Name string

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

PoolId string

The pool's ID. Only one of name and pool_id should be specified.

Region string

region) The region in which the pool exists.

Size int

The size of the pool.

clusterId String

The cluster ID. Required when name is set.

name String

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

poolId String

The pool's ID. Only one of name and pool_id should be specified.

region String

region) The region in which the pool exists.

size Integer

The size of the pool.

clusterId string

The cluster ID. Required when name is set.

name string

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

poolId string

The pool's ID. Only one of name and pool_id should be specified.

region string

region) The region in which the pool exists.

size number

The size of the pool.

cluster_id str

The cluster ID. Required when name is set.

name str

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

pool_id str

The pool's ID. Only one of name and pool_id should be specified.

region str

region) The region in which the pool exists.

size int

The size of the pool.

clusterId String

The cluster ID. Required when name is set.

name String

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

poolId String

The pool's ID. Only one of name and pool_id should be specified.

region String

region) The region in which the pool exists.

size Number

The size of the pool.

getKubernetesNodePool Result

The following output properties are available:

Autohealing bool

True if the autohealing feature is enabled for this pool.

Autoscaling bool

True if the autoscaling feature is enabled for this pool.

ContainerRuntime string

The container runtime of the pool.

CreatedAt string

The creation date of the pool.

CurrentSize int
Id string

The provider-assigned unique ID for this managed resource.

KubeletArgs Dictionary<string, string>
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.

NodeType string

The commercial type of the pool instances.

Nodes List<GetKubernetesNodePoolNode>

(List of) The nodes in the default pool.

PlacementGroupId string

placement group the nodes of the pool are attached to.

Status string

The status of the node.

Tags List<string>

The tags associated with the pool.

UpdatedAt string

The last update date of the pool.

UpgradePolicies List<GetKubernetesNodePoolUpgradePolicy>
Version string

The version of the pool.

WaitForPoolReady bool
Zone string
ClusterId string
Name string

The name of the node.

PoolId string
Region string
Size int

The size of the pool.

Autohealing bool

True if the autohealing feature is enabled for this pool.

Autoscaling bool

True if the autoscaling feature is enabled for this pool.

ContainerRuntime string

The container runtime of the pool.

CreatedAt string

The creation date of the pool.

CurrentSize int
Id string

The provider-assigned unique ID for this managed resource.

KubeletArgs map[string]string
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.

NodeType string

The commercial type of the pool instances.

Nodes []GetKubernetesNodePoolNode

(List of) The nodes in the default pool.

PlacementGroupId string

placement group the nodes of the pool are attached to.

Status string

The status of the node.

Tags []string

The tags associated with the pool.

UpdatedAt string

The last update date of the pool.

UpgradePolicies []GetKubernetesNodePoolUpgradePolicy
Version string

The version of the pool.

WaitForPoolReady bool
Zone string
ClusterId string
Name string

The name of the node.

PoolId string
Region string
Size int

The size of the pool.

autohealing Boolean

True if the autohealing feature is enabled for this pool.

autoscaling Boolean

True if the autoscaling feature is enabled for this pool.

containerRuntime String

The container runtime of the pool.

createdAt String

The creation date of the pool.

currentSize Integer
id String

The provider-assigned unique ID for this managed resource.

kubeletArgs Map
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.

nodeType String

The commercial type of the pool instances.

nodes ListKubernetesNodePoolNode>

(List of) The nodes in the default pool.

placementGroupId String

placement group the nodes of the pool are attached to.

status String

The status of the node.

tags List

The tags associated with the pool.

updatedAt String

The last update date of the pool.

upgradePolicies ListKubernetesNodePoolUpgradePolicy>
version String

The version of the pool.

waitForPoolReady Boolean
zone String
clusterId String
name String

The name of the node.

poolId String
region String
size Integer

The size of the pool.

autohealing boolean

True if the autohealing feature is enabled for this pool.

autoscaling boolean

True if the autoscaling feature is enabled for this pool.

containerRuntime string

The container runtime of the pool.

createdAt string

The creation date of the pool.

currentSize number
id string

The provider-assigned unique ID for this managed resource.

kubeletArgs {[key: string]: string}
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.

nodeType string

The commercial type of the pool instances.

nodes GetKubernetesNodePoolNode[]

(List of) The nodes in the default pool.

placementGroupId string

placement group the nodes of the pool are attached to.

status string

The status of the node.

tags string[]

The tags associated with the pool.

updatedAt string

The last update date of the pool.

upgradePolicies GetKubernetesNodePoolUpgradePolicy[]
version string

The version of the pool.

waitForPoolReady boolean
zone string
clusterId string
name string

The name of the node.

poolId string
region string
size number

The size of the pool.

autohealing bool

True if the autohealing feature is enabled for this pool.

autoscaling bool

True if the autoscaling feature is enabled for this pool.

container_runtime str

The container runtime of the pool.

created_at str

The creation date of the pool.

current_size int
id str

The provider-assigned unique ID for this managed resource.

kubelet_args Mapping[str, str]
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.

node_type str

The commercial type of the pool instances.

nodes Sequence[GetKubernetesNodePoolNode]

(List of) The nodes in the default pool.

placement_group_id str

placement group the nodes of the pool are attached to.

status str

The status of the node.

tags Sequence[str]

The tags associated with the pool.

updated_at str

The last update date of the pool.

upgrade_policies Sequence[GetKubernetesNodePoolUpgradePolicy]
version str

The version of the pool.

wait_for_pool_ready bool
zone str
cluster_id str
name str

The name of the node.

pool_id str
region str
size int

The size of the pool.

autohealing Boolean

True if the autohealing feature is enabled for this pool.

autoscaling Boolean

True if the autoscaling feature is enabled for this pool.

containerRuntime String

The container runtime of the pool.

createdAt String

The creation date of the pool.

currentSize Number
id String

The provider-assigned unique ID for this managed resource.

kubeletArgs Map
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.

nodeType String

The commercial type of the pool instances.

nodes List

(List of) The nodes in the default pool.

placementGroupId String

placement group the nodes of the pool are attached to.

status String

The status of the node.

tags List

The tags associated with the pool.

updatedAt String

The last update date of the pool.

upgradePolicies List
version String

The version of the pool.

waitForPoolReady Boolean
zone String
clusterId String
name String

The name of the node.

poolId String
region String
size Number

The size of the pool.

Supporting Types

GetKubernetesNodePoolNode

Name string

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

PublicIp string

The public IPv4.

PublicIpV6 string

The public IPv6.

Status string

The status of the node.

Name string

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

PublicIp string

The public IPv4.

PublicIpV6 string

The public IPv6.

Status string

The status of the node.

name String

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

publicIp String

The public IPv4.

publicIpV6 String

The public IPv6.

status String

The status of the node.

name string

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

publicIp string

The public IPv4.

publicIpV6 string

The public IPv6.

status string

The status of the node.

name str

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

public_ip str

The public IPv4.

public_ip_v6 str

The public IPv6.

status str

The status of the node.

name String

The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.

publicIp String

The public IPv4.

publicIpV6 String

The public IPv6.

status String

The status of the node.

GetKubernetesNodePoolUpgradePolicy

maxSurge Integer
maxUnavailable Integer

Package Details

Repository
https://github.com/jaxxstorm/pulumi-scaleway
License
Apache-2.0
Notes

This Pulumi package is based on the scaleway Terraform Provider.