Scaleway

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

getKubernetesCluster

Gets information about a Kubernetes Cluster.

Example Usage

using Pulumi;
using Scaleway = Pulumi.Scaleway;

class MyStack : Stack
{
    public MyStack()
    {
        var myKey = Output.Create(Scaleway.GetKubernetesCluster.InvokeAsync(new Scaleway.GetKubernetesClusterArgs
        {
            ClusterId = "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.LookupKubernetesCluster(ctx, &GetKubernetesClusterArgs{
			ClusterId: 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_cluster(cluster_id="11111111-1111-1111-1111-111111111111")
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";

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

Coming soon!

Using getKubernetesCluster

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 getKubernetesCluster(args: GetKubernetesClusterArgs, opts?: InvokeOptions): Promise<GetKubernetesClusterResult>
function getKubernetesClusterOutput(args: GetKubernetesClusterOutputArgs, opts?: InvokeOptions): Output<GetKubernetesClusterResult>
def get_kubernetes_cluster(cluster_id: Optional[str] = None,
                           name: Optional[str] = None,
                           region: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterResult
def get_kubernetes_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           region: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesClusterResult]
func LookupKubernetesCluster(ctx *Context, args *LookupKubernetesClusterArgs, opts ...InvokeOption) (*LookupKubernetesClusterResult, error)
func LookupKubernetesClusterOutput(ctx *Context, args *LookupKubernetesClusterOutputArgs, opts ...InvokeOption) LookupKubernetesClusterResultOutput

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

public static class GetKubernetesCluster 
{
    public static Task<GetKubernetesClusterResult> InvokeAsync(GetKubernetesClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesClusterResult> Invoke(GetKubernetesClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKubernetesClusterResult> getKubernetesCluster(GetKubernetesClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: scaleway:index/getKubernetesCluster:getKubernetesCluster
  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.

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.

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.

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.

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.

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.

region String

region) The region in which the cluster exists.

getKubernetesCluster 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<GetKubernetesClusterAutoUpgrade>

The auto upgrade configuration.

AutoscalerConfigs List<GetKubernetesClusterAutoscalerConfig>

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<GetKubernetesClusterKubeconfig>
OpenIdConnectConfigs List<GetKubernetesClusterOpenIdConnectConfig>
OrganizationId string

The ID of the organization the cluster is associated with.

ProjectId string

The ID of the project the cluster is associated with.

Status string

The status of the Kubernetes cluster.

Tags List<string>

The tags associated with the Kubernetes cluster.

Type string
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
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 []GetKubernetesClusterAutoUpgrade

The auto upgrade configuration.

AutoscalerConfigs []GetKubernetesClusterAutoscalerConfig

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 []GetKubernetesClusterKubeconfig
OpenIdConnectConfigs []GetKubernetesClusterOpenIdConnectConfig
OrganizationId string

The ID of the organization the cluster is associated with.

ProjectId string

The ID of the project the cluster is associated with.

Status string

The status of the Kubernetes cluster.

Tags []string

The tags associated with the Kubernetes cluster.

Type string
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
Region string

The region in which the cluster is.

admissionPlugins List

The list of admission plugins enabled on the cluster.

apiserverCertSans List
apiserverUrl String

The URL of the Kubernetes API server.

autoUpgrades ListKubernetesClusterAutoUpgrade>

The auto upgrade configuration.

autoscalerConfigs ListKubernetesClusterAutoscalerConfig>

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

The list of feature gates enabled on the cluster.

id String

The provider-assigned unique ID for this managed resource.

kubeconfigs ListKubernetesClusterKubeconfig>
openIdConnectConfigs ListKubernetesClusterOpenIdConnectConfig>
organizationId String

The ID of the organization the cluster is associated with.

projectId String

The ID of the project the cluster is associated with.

status String

The status of the Kubernetes cluster.

tags List

The tags associated with the Kubernetes cluster.

type String
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
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 GetKubernetesClusterAutoUpgrade[]

The auto upgrade configuration.

autoscalerConfigs GetKubernetesClusterAutoscalerConfig[]

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 GetKubernetesClusterKubeconfig[]
openIdConnectConfigs GetKubernetesClusterOpenIdConnectConfig[]
organizationId string

The ID of the organization the cluster is associated with.

projectId string

The ID of the project the cluster is associated with.

status string

The status of the Kubernetes cluster.

tags string[]

The tags associated with the Kubernetes cluster.

type string
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
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[GetKubernetesClusterAutoUpgrade]

The auto upgrade configuration.

autoscaler_configs Sequence[GetKubernetesClusterAutoscalerConfig]

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[GetKubernetesClusterKubeconfig]
open_id_connect_configs Sequence[GetKubernetesClusterOpenIdConnectConfig]
organization_id str

The ID of the organization the cluster is associated with.

project_id str

The ID of the project the cluster is associated with.

status str

The status of the Kubernetes cluster.

tags Sequence[str]

The tags associated with the Kubernetes cluster.

type str
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
region str

The region in which the cluster is.

admissionPlugins List

The list of admission plugins enabled on the cluster.

apiserverCertSans List
apiserverUrl String

The URL of the Kubernetes API server.

autoUpgrades List

The auto upgrade configuration.

autoscalerConfigs List

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

The list of feature gates enabled on the cluster.

id String

The provider-assigned unique ID for this managed resource.

kubeconfigs List
openIdConnectConfigs List
organizationId String

The ID of the organization the cluster is associated with.

projectId String

The ID of the project the cluster is associated with.

status String

The status of the Kubernetes cluster.

tags List

The tags associated with the Kubernetes cluster.

type String
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
region String

The region in which the cluster is.

Supporting Types

GetKubernetesClusterAutoUpgrade

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).

GetKubernetesClusterAutoscalerConfig

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
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
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
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
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
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
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
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
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
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
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
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

GetKubernetesClusterKubeconfig

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.

GetKubernetesClusterOpenIdConnectConfig

ClientId string
GroupsClaims List<string>
GroupsPrefix string
IssuerUrl string
RequiredClaims List<string>
UsernameClaim string
UsernamePrefix string

Package Details

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

This Pulumi package is based on the scaleway Terraform Provider.