Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. kubernetes
  5. getPool
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.kubernetes.getPool

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

Gets information about a Kubernetes Cluster’s Pool.

Using getPool

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 getPool(args: GetPoolArgs, opts?: InvokeOptions): Promise<GetPoolResult>
function getPoolOutput(args: GetPoolOutputArgs, opts?: InvokeOptions): Output<GetPoolResult>
Copy
def get_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) -> GetPoolResult
def get_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[GetPoolResult]
Copy
func LookupPool(ctx *Context, args *LookupPoolArgs, opts ...InvokeOption) (*LookupPoolResult, error)
func LookupPoolOutput(ctx *Context, args *LookupPoolOutputArgs, opts ...InvokeOption) LookupPoolResultOutput
Copy

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

public static class GetPool 
{
    public static Task<GetPoolResult> InvokeAsync(GetPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetPoolResult> Invoke(GetPoolInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
public static Output<GetPoolResult> getPool(GetPoolArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scaleway:kubernetes/getPool:getPool
  arguments:
    # arguments dictionary
Copy

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.

getPool 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<Pulumiverse.Scaleway.Kubernetes.Outputs.GetPoolNode>
(List of) The nodes in the default pool.
PlacementGroupId string
placement group the nodes of the pool are attached to.
PublicIpDisabled bool
RootVolumeSizeInGb int
RootVolumeType string
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<Pulumiverse.Scaleway.Kubernetes.Outputs.GetPoolUpgradePolicy>
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 []GetPoolNode
(List of) The nodes in the default pool.
PlacementGroupId string
placement group the nodes of the pool are attached to.
PublicIpDisabled bool
RootVolumeSizeInGb int
RootVolumeType string
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 []GetPoolUpgradePolicy
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<String,String>
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 List<GetPoolNode>
(List of) The nodes in the default pool.
placementGroupId String
placement group the nodes of the pool are attached to.
publicIpDisabled Boolean
rootVolumeSizeInGb Integer
rootVolumeType String
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<GetPoolUpgradePolicy>
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 GetPoolNode[]
(List of) The nodes in the default pool.
placementGroupId string
placement group the nodes of the pool are attached to.
publicIpDisabled boolean
rootVolumeSizeInGb number
rootVolumeType string
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 GetPoolUpgradePolicy[]
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[GetPoolNode]
(List of) The nodes in the default pool.
placement_group_id str
placement group the nodes of the pool are attached to.
public_ip_disabled bool
root_volume_size_in_gb int
root_volume_type str
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[GetPoolUpgradePolicy]
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<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 List<Property Map>
(List of) The nodes in the default pool.
placementGroupId String
placement group the nodes of the pool are attached to.
publicIpDisabled Boolean
rootVolumeSizeInGb Number
rootVolumeType String
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<Property Map>
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

GetPoolNode

Name This property is required. string
The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.
PublicIp This property is required. string
The public IPv4.
PublicIpV6 This property is required. string
The public IPv6.
Status This property is required. string
The status of the node.
Name This property is required. string
The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.
PublicIp This property is required. string
The public IPv4.
PublicIpV6 This property is required. string
The public IPv6.
Status This property is required. string
The status of the node.
name This property is required. String
The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.
publicIp This property is required. String
The public IPv4.
publicIpV6 This property is required. String
The public IPv6.
status This property is required. String
The status of the node.
name This property is required. string
The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.
publicIp This property is required. string
The public IPv4.
publicIpV6 This property is required. string
The public IPv6.
status This property is required. string
The status of the node.
name This property is required. str
The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.
public_ip This property is required. str
The public IPv4.
public_ip_v6 This property is required. str
The public IPv6.
status This property is required. str
The status of the node.
name This property is required. String
The pool name. Only one of name and pool_id should be specified. cluster_id should be specified with name.
publicIp This property is required. String
The public IPv4.
publicIpV6 This property is required. String
The public IPv6.
status This property is required. String
The status of the node.

GetPoolUpgradePolicy

MaxSurge This property is required. int
The maximum number of nodes to be created during the upgrade
MaxUnavailable This property is required. int
The maximum number of nodes that can be not ready at the same time
MaxSurge This property is required. int
The maximum number of nodes to be created during the upgrade
MaxUnavailable This property is required. int
The maximum number of nodes that can be not ready at the same time
maxSurge This property is required. Integer
The maximum number of nodes to be created during the upgrade
maxUnavailable This property is required. Integer
The maximum number of nodes that can be not ready at the same time
maxSurge This property is required. number
The maximum number of nodes to be created during the upgrade
maxUnavailable This property is required. number
The maximum number of nodes that can be not ready at the same time
max_surge This property is required. int
The maximum number of nodes to be created during the upgrade
max_unavailable This property is required. int
The maximum number of nodes that can be not ready at the same time
maxSurge This property is required. Number
The maximum number of nodes to be created during the upgrade
maxUnavailable This property is required. 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 v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway