Scaleway v1.26.0, Mar 28 25

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

scaleway.kubernetes.getCluster

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse

Using getCluster

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.

TypeScript
Python
Go
C#
Java
YAML

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(cluster_id: Optional[str] = None,
                name: Optional[str] = None,
                project_id: Optional[str] = None,
                region: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                region: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

fn::invoke:
  function: scaleway:kubernetes/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string: The cluster ID. Only one of name and cluster_id should be specified.
Name string: The cluster name. Only one of name and cluster_id should be specified.
ProjectId string: The ID of the project the cluster is associated with.
Region string: region) The region in which the cluster exists.

ClusterId string: The cluster ID. Only one of name and cluster_id should be specified.
Name string: The cluster name. Only one of name and cluster_id should be specified.
ProjectId string: The ID of the project the cluster is associated with.
Region string: region) The region in which the cluster exists.

clusterId String: The cluster ID. Only one of name and cluster_id should be specified.
name String: The cluster name. Only one of name and cluster_id should be specified.
projectId String: The ID of the project the cluster is associated with.
region String: region) The region in which the cluster exists.

clusterId string: The cluster ID. Only one of name and cluster_id should be specified.
name string: The cluster name. Only one of name and cluster_id should be specified.
projectId string: The ID of the project the cluster is associated with.
region string: region) The region in which the cluster exists.

cluster_id str: The cluster ID. Only one of name and cluster_id should be specified.
name str: The cluster name. Only one of name and cluster_id should be specified.
project_id str: The ID of the project the cluster is associated with.
region str: region) The region in which the cluster exists.

clusterId String: The cluster ID. Only one of name and cluster_id should be specified.
name String: The cluster name. Only one of name and cluster_id should be specified.
projectId String: The ID of the project the cluster is associated with.
region String: region) The region in which the cluster exists.

getCluster Result

The following output properties are available:

AdmissionPlugins List<string>: The list of admission plugins enabled on the cluster.
ApiserverCertSans List<string>
ApiserverUrl string: The URL of the Kubernetes API server.
AutoUpgrades List<Pulumiverse.Scaleway.Kubernetes.Outputs.GetClusterAutoUpgrade>: The auto upgrade configuration.
AutoscalerConfigs List<Pulumiverse.Scaleway.Kubernetes.Outputs.GetClusterAutoscalerConfig>: The configuration options for the Kubernetes cluster autoscaler.
Cni string: The Container Network Interface (CNI) for the Kubernetes cluster.
CreatedAt string: The creation date of the cluster.
Description string: A description for the Kubernetes cluster.
FeatureGates List<string>: The list of feature gates enabled on the cluster.
Id string: The provider-assigned unique ID for this managed resource.
Kubeconfigs List<Pulumiverse.Scaleway.Kubernetes.Outputs.GetClusterKubeconfig>
OpenIdConnectConfigs List<Pulumiverse.Scaleway.Kubernetes.Outputs.GetClusterOpenIdConnectConfig>
OrganizationId string: The ID of the organization the cluster is associated with.
PrivateNetworkId string: The ID of the private network of the cluster.
Status string: The status of the Kubernetes cluster.
Tags List<string>: The tags associated with the Kubernetes cluster.
Type string: The type of the Kubernetes cluster.
UpdatedAt string: The last update date of the cluster.
UpgradeAvailable bool: True if a newer Kubernetes version is available.
Version string: The version of the Kubernetes cluster.
WildcardDns string: The DNS wildcard that points to all ready nodes.
ClusterId string
Name string
ProjectId string
Region string: The region in which the cluster is.

AdmissionPlugins []string: The list of admission plugins enabled on the cluster.
ApiserverCertSans []string
ApiserverUrl string: The URL of the Kubernetes API server.
AutoUpgrades []GetClusterAutoUpgrade: The auto upgrade configuration.
AutoscalerConfigs []GetClusterAutoscalerConfig: The configuration options for the Kubernetes cluster autoscaler.
Cni string: The Container Network Interface (CNI) for the Kubernetes cluster.
CreatedAt string: The creation date of the cluster.
Description string: A description for the Kubernetes cluster.
FeatureGates []string: The list of feature gates enabled on the cluster.
Id string: The provider-assigned unique ID for this managed resource.
Kubeconfigs []GetClusterKubeconfig
OpenIdConnectConfigs []GetClusterOpenIdConnectConfig
OrganizationId string: The ID of the organization the cluster is associated with.
PrivateNetworkId string: The ID of the private network of the cluster.
Status string: The status of the Kubernetes cluster.
Tags []string: The tags associated with the Kubernetes cluster.
Type string: The type of the Kubernetes cluster.
UpdatedAt string: The last update date of the cluster.
UpgradeAvailable bool: True if a newer Kubernetes version is available.
Version string: The version of the Kubernetes cluster.
WildcardDns string: The DNS wildcard that points to all ready nodes.
ClusterId string
Name string
ProjectId string
Region string: The region in which the cluster is.

admissionPlugins List<String>: The list of admission plugins enabled on the cluster.
apiserverCertSans List<String>
apiserverUrl String: The URL of the Kubernetes API server.
autoUpgrades List<GetClusterAutoUpgrade>: The auto upgrade configuration.
autoscalerConfigs List<GetClusterAutoscalerConfig>: The configuration options for the Kubernetes cluster autoscaler.
cni String: The Container Network Interface (CNI) for the Kubernetes cluster.
createdAt String: The creation date of the cluster.
description String: A description for the Kubernetes cluster.
featureGates List<String>: The list of feature gates enabled on the cluster.
id String: The provider-assigned unique ID for this managed resource.
kubeconfigs List<GetClusterKubeconfig>
openIdConnectConfigs List<GetClusterOpenIdConnectConfig>
organizationId String: The ID of the organization the cluster is associated with.
privateNetworkId String: The ID of the private network of the cluster.
status String: The status of the Kubernetes cluster.
tags List<String>: The tags associated with the Kubernetes cluster.
type String: The type of the Kubernetes cluster.
updatedAt String: The last update date of the cluster.
upgradeAvailable Boolean: True if a newer Kubernetes version is available.
version String: The version of the Kubernetes cluster.
wildcardDns String: The DNS wildcard that points to all ready nodes.
clusterId String
name String
projectId String
region String: The region in which the cluster is.

admissionPlugins string[]: The list of admission plugins enabled on the cluster.
apiserverCertSans string[]
apiserverUrl string: The URL of the Kubernetes API server.
autoUpgrades GetClusterAutoUpgrade[]: The auto upgrade configuration.
autoscalerConfigs GetClusterAutoscalerConfig[]: The configuration options for the Kubernetes cluster autoscaler.
cni string: The Container Network Interface (CNI) for the Kubernetes cluster.
createdAt string: The creation date of the cluster.
description string: A description for the Kubernetes cluster.
featureGates string[]: The list of feature gates enabled on the cluster.
id string: The provider-assigned unique ID for this managed resource.
kubeconfigs GetClusterKubeconfig[]
openIdConnectConfigs GetClusterOpenIdConnectConfig[]
organizationId string: The ID of the organization the cluster is associated with.
privateNetworkId string: The ID of the private network of the cluster.
status string: The status of the Kubernetes cluster.
tags string[]: The tags associated with the Kubernetes cluster.
type string: The type of the Kubernetes cluster.
updatedAt string: The last update date of the cluster.
upgradeAvailable boolean: True if a newer Kubernetes version is available.
version string: The version of the Kubernetes cluster.
wildcardDns string: The DNS wildcard that points to all ready nodes.
clusterId string
name string
projectId string
region string: The region in which the cluster is.

admission_plugins Sequence[str]: The list of admission plugins enabled on the cluster.
apiserver_cert_sans Sequence[str]
apiserver_url str: The URL of the Kubernetes API server.
auto_upgrades Sequence[GetClusterAutoUpgrade]: The auto upgrade configuration.
autoscaler_configs Sequence[GetClusterAutoscalerConfig]: The configuration options for the Kubernetes cluster autoscaler.
cni str: The Container Network Interface (CNI) for the Kubernetes cluster.
created_at str: The creation date of the cluster.
description str: A description for the Kubernetes cluster.
feature_gates Sequence[str]: The list of feature gates enabled on the cluster.
id str: The provider-assigned unique ID for this managed resource.
kubeconfigs Sequence[GetClusterKubeconfig]
open_id_connect_configs Sequence[GetClusterOpenIdConnectConfig]
organization_id str: The ID of the organization the cluster is associated with.
private_network_id str: The ID of the private network of the cluster.
status str: The status of the Kubernetes cluster.
tags Sequence[str]: The tags associated with the Kubernetes cluster.
type str: The type of the Kubernetes cluster.
updated_at str: The last update date of the cluster.
upgrade_available bool: True if a newer Kubernetes version is available.
version str: The version of the Kubernetes cluster.
wildcard_dns str: The DNS wildcard that points to all ready nodes.
cluster_id str
name str
project_id str
region str: The region in which the cluster is.

admissionPlugins List<String>: The list of admission plugins enabled on the cluster.
apiserverCertSans List<String>
apiserverUrl String: The URL of the Kubernetes API server.
autoUpgrades List<Property Map>: The auto upgrade configuration.
autoscalerConfigs List<Property Map>: The configuration options for the Kubernetes cluster autoscaler.
cni String: The Container Network Interface (CNI) for the Kubernetes cluster.
createdAt String: The creation date of the cluster.
description String: A description for the Kubernetes cluster.
featureGates List<String>: The list of feature gates enabled on the cluster.
id String: The provider-assigned unique ID for this managed resource.
kubeconfigs List<Property Map>
openIdConnectConfigs List<Property Map>
organizationId String: The ID of the organization the cluster is associated with.
privateNetworkId String: The ID of the private network of the cluster.
status String: The status of the Kubernetes cluster.
tags List<String>: The tags associated with the Kubernetes cluster.
type String: The type of the Kubernetes cluster.
updatedAt String: The last update date of the cluster.
upgradeAvailable Boolean: True if a newer Kubernetes version is available.
version String: The version of the Kubernetes cluster.
wildcardDns String: The DNS wildcard that points to all ready nodes.
clusterId String
name String
projectId String
region String: The region in which the cluster is.

Supporting Types

GetClusterAutoUpgrade

Enable bool: True if Kubernetes patch version auto upgrades is enabled.
MaintenanceWindowDay string: The day of the auto upgrade maintenance window (monday to sunday, or any).
MaintenanceWindowStartHour int: The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).

Enable bool: True if Kubernetes patch version auto upgrades is enabled.
MaintenanceWindowDay string: The day of the auto upgrade maintenance window (monday to sunday, or any).
MaintenanceWindowStartHour int: The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).

enable Boolean: True if Kubernetes patch version auto upgrades is enabled.
maintenanceWindowDay String: The day of the auto upgrade maintenance window (monday to sunday, or any).
maintenanceWindowStartHour Integer: The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).

enable boolean: True if Kubernetes patch version auto upgrades is enabled.
maintenanceWindowDay string: The day of the auto upgrade maintenance window (monday to sunday, or any).
maintenanceWindowStartHour number: The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).

enable bool: True if Kubernetes patch version auto upgrades is enabled.
maintenance_window_day str: The day of the auto upgrade maintenance window (monday to sunday, or any).
maintenance_window_start_hour int: The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).

enable Boolean: True if Kubernetes patch version auto upgrades is enabled.
maintenanceWindowDay String: The day of the auto upgrade maintenance window (monday to sunday, or any).
maintenanceWindowStartHour Number: The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).

GetClusterAutoscalerConfig

BalanceSimilarNodeGroups bool: True if detecting similar node groups and balance the number of nodes between them is enabled.
DisableScaleDown bool: True if the scale down feature of the autoscaler is disabled.
Estimator string: The type of resource estimator used in scale up.
Expander string: The type of node group expander be used in scale up.
ExpendablePodsPriorityCutoff int: Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
IgnoreDaemonsetsUtilization bool: True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
MaxGracefulTerminationSec int: Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
ScaleDownDelayAfterAdd string: The duration after scale up that scale down evaluation resumes.
ScaleDownUnneededTime string: The duration a node should be unneeded before it is eligible for scale down.
ScaleDownUtilizationThreshold double: Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down

BalanceSimilarNodeGroups bool: True if detecting similar node groups and balance the number of nodes between them is enabled.
DisableScaleDown bool: True if the scale down feature of the autoscaler is disabled.
Estimator string: The type of resource estimator used in scale up.
Expander string: The type of node group expander be used in scale up.
ExpendablePodsPriorityCutoff int: Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
IgnoreDaemonsetsUtilization bool: True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
MaxGracefulTerminationSec int: Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
ScaleDownDelayAfterAdd string: The duration after scale up that scale down evaluation resumes.
ScaleDownUnneededTime string: The duration a node should be unneeded before it is eligible for scale down.
ScaleDownUtilizationThreshold float64: Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down

balanceSimilarNodeGroups Boolean: True if detecting similar node groups and balance the number of nodes between them is enabled.
disableScaleDown Boolean: True if the scale down feature of the autoscaler is disabled.
estimator String: The type of resource estimator used in scale up.
expander String: The type of node group expander be used in scale up.
expendablePodsPriorityCutoff Integer: Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
ignoreDaemonsetsUtilization Boolean: True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
maxGracefulTerminationSec Integer: Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
scaleDownDelayAfterAdd String: The duration after scale up that scale down evaluation resumes.
scaleDownUnneededTime String: The duration a node should be unneeded before it is eligible for scale down.
scaleDownUtilizationThreshold Double: Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down

balanceSimilarNodeGroups boolean: True if detecting similar node groups and balance the number of nodes between them is enabled.
disableScaleDown boolean: True if the scale down feature of the autoscaler is disabled.
estimator string: The type of resource estimator used in scale up.
expander string: The type of node group expander be used in scale up.
expendablePodsPriorityCutoff number: Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
ignoreDaemonsetsUtilization boolean: True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
maxGracefulTerminationSec number: Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
scaleDownDelayAfterAdd string: The duration after scale up that scale down evaluation resumes.
scaleDownUnneededTime string: The duration a node should be unneeded before it is eligible for scale down.
scaleDownUtilizationThreshold number: Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down

balance_similar_node_groups bool: True if detecting similar node groups and balance the number of nodes between them is enabled.
disable_scale_down bool: True if the scale down feature of the autoscaler is disabled.
estimator str: The type of resource estimator used in scale up.
expander str: The type of node group expander be used in scale up.
expendable_pods_priority_cutoff int: Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
ignore_daemonsets_utilization bool: True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
max_graceful_termination_sec int: Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
scale_down_delay_after_add str: The duration after scale up that scale down evaluation resumes.
scale_down_unneeded_time str: The duration a node should be unneeded before it is eligible for scale down.
scale_down_utilization_threshold float: Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down

balanceSimilarNodeGroups Boolean: True if detecting similar node groups and balance the number of nodes between them is enabled.
disableScaleDown Boolean: True if the scale down feature of the autoscaler is disabled.
estimator String: The type of resource estimator used in scale up.
expander String: The type of node group expander be used in scale up.
expendablePodsPriorityCutoff Number: Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they don't cause scale up. Pods with null priority (PodPriority disabled) are non expendable.
ignoreDaemonsetsUtilization Boolean: True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
maxGracefulTerminationSec Number: Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
scaleDownDelayAfterAdd String: The duration after scale up that scale down evaluation resumes.
scaleDownUnneededTime String: The duration a node should be unneeded before it is eligible for scale down.
scaleDownUtilizationThreshold Number: Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down

GetClusterKubeconfig

ClusterCaCertificate string: The CA certificate of the Kubernetes API server.
ConfigFile string: The raw kubeconfig file.
Host string: The URL of the Kubernetes API server.
Token string: The token to connect to the Kubernetes API server.

ClusterCaCertificate string: The CA certificate of the Kubernetes API server.
ConfigFile string: The raw kubeconfig file.
Host string: The URL of the Kubernetes API server.
Token string: The token to connect to the Kubernetes API server.

clusterCaCertificate String: The CA certificate of the Kubernetes API server.
configFile String: The raw kubeconfig file.
host String: The URL of the Kubernetes API server.
token String: The token to connect to the Kubernetes API server.

clusterCaCertificate string: The CA certificate of the Kubernetes API server.
configFile string: The raw kubeconfig file.
host string: The URL of the Kubernetes API server.
token string: The token to connect to the Kubernetes API server.

cluster_ca_certificate str: The CA certificate of the Kubernetes API server.
config_file str: The raw kubeconfig file.
host str: The URL of the Kubernetes API server.
token str: The token to connect to the Kubernetes API server.

clusterCaCertificate String: The CA certificate of the Kubernetes API server.
configFile String: The raw kubeconfig file.
host String: The URL of the Kubernetes API server.
token String: The token to connect to the Kubernetes API server.

GetClusterOpenIdConnectConfig

ClientId string: A client id that all tokens must be issued for
GroupsClaims List<string>: JWT claim to use as the user's group
GroupsPrefix string: Prefix prepended to group claims
IssuerUrl string: URL of the provider which allows the API server to discover public signing keys
RequiredClaims List<string>: Multiple key=value pairs that describes a required claim in the ID Token
UsernameClaim string: JWT claim to use as the user name
UsernamePrefix string: Prefix prepended to username

ClientId string: A client id that all tokens must be issued for
GroupsClaims []string: JWT claim to use as the user's group
GroupsPrefix string: Prefix prepended to group claims
IssuerUrl string: URL of the provider which allows the API server to discover public signing keys
RequiredClaims []string: Multiple key=value pairs that describes a required claim in the ID Token
UsernameClaim string: JWT claim to use as the user name
UsernamePrefix string: Prefix prepended to username

clientId String: A client id that all tokens must be issued for
groupsClaims List<String>: JWT claim to use as the user's group
groupsPrefix String: Prefix prepended to group claims
issuerUrl String: URL of the provider which allows the API server to discover public signing keys
requiredClaims List<String>: Multiple key=value pairs that describes a required claim in the ID Token
usernameClaim String: JWT claim to use as the user name
usernamePrefix String: Prefix prepended to username

clientId string: A client id that all tokens must be issued for
groupsClaims string[]: JWT claim to use as the user's group
groupsPrefix string: Prefix prepended to group claims
issuerUrl string: URL of the provider which allows the API server to discover public signing keys
requiredClaims string[]: Multiple key=value pairs that describes a required claim in the ID Token
usernameClaim string: JWT claim to use as the user name
usernamePrefix string: Prefix prepended to username

client_id str: A client id that all tokens must be issued for
groups_claims Sequence[str]: JWT claim to use as the user's group
groups_prefix str: Prefix prepended to group claims
issuer_url str: URL of the provider which allows the API server to discover public signing keys
required_claims Sequence[str]: Multiple key=value pairs that describes a required claim in the ID Token
username_claim str: JWT claim to use as the user name
username_prefix str: Prefix prepended to username

clientId String: A client id that all tokens must be issued for
groupsClaims List<String>: JWT claim to use as the user's group
groupsPrefix String: Prefix prepended to group claims
issuerUrl String: URL of the provider which allows the API server to discover public signing keys
requiredClaims List<String>: Multiple key=value pairs that describes a required claim in the ID Token
usernameClaim String: JWT claim to use as the user name
usernamePrefix String: Prefix prepended to username

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

scaleway.kubernetes.getCluster

On this page

On this page

Using getCluster

getCluster Result

Supporting Types

GetClusterAutoUpgrade

GetClusterAutoscalerConfig

GetClusterKubeconfig

GetClusterOpenIdConnectConfig

Package Details

On this page

On this page