Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
scaleway.getKubernetesCluster
Explore with Pulumi AI
Gets information about a Kubernetes Cluster.
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,
project_id: 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,
project_id: 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:
- cluster_
id str - The cluster ID. Only one of
name
andcluster_id
should be specified. - name str
- The cluster name. Only one of
name
andcluster_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.
getKubernetesCluster Result
The following output properties are available:
- Admission
Plugins List<string> - The list of admission plugins enabled on the cluster.
- Apiserver
Cert List<string>Sans - Apiserver
Url string - The URL of the Kubernetes API server.
- Auto
Upgrades List<Pulumiverse.Scaleway. Outputs. Get Kubernetes Cluster Auto Upgrade> - The auto upgrade configuration.
- Autoscaler
Configs List<Pulumiverse.Scaleway. Outputs. Get Kubernetes Cluster Autoscaler Config> - The configuration options for the Kubernetes cluster autoscaler.
- Cni string
- The Container Network Interface (CNI) for the Kubernetes cluster.
- Created
At string - The creation date of the cluster.
- Description string
- A description for the Kubernetes cluster.
- Feature
Gates 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. Outputs. Get Kubernetes Cluster Kubeconfig> - Open
Id List<Pulumiverse.Connect Configs Scaleway. Outputs. Get Kubernetes Cluster Open Id Connect Config> - Organization
Id string - The ID of the organization the cluster is associated with.
- Private
Network stringId - The ID of the private network of the cluster.
- Status string
- The status of the Kubernetes cluster.
- List<string>
- The tags associated with the Kubernetes cluster.
- Type string
- The type of the Kubernetes cluster.
- Updated
At string - The last update date of the cluster.
- Upgrade
Available bool - True if a newer Kubernetes version is available.
- Version string
- The version of the Kubernetes cluster.
- Wildcard
Dns string - The DNS wildcard that points to all ready nodes.
- Cluster
Id string - Name string
- Project
Id string - Region string
- The region in which the cluster is.
- Admission
Plugins []string - The list of admission plugins enabled on the cluster.
- Apiserver
Cert []stringSans - Apiserver
Url string - The URL of the Kubernetes API server.
- Auto
Upgrades []GetKubernetes Cluster Auto Upgrade - The auto upgrade configuration.
- Autoscaler
Configs []GetKubernetes Cluster Autoscaler Config - The configuration options for the Kubernetes cluster autoscaler.
- Cni string
- The Container Network Interface (CNI) for the Kubernetes cluster.
- Created
At string - The creation date of the cluster.
- Description string
- A description for the Kubernetes cluster.
- Feature
Gates []string - The list of feature gates enabled on the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Kubeconfigs
[]Get
Kubernetes Cluster Kubeconfig - Open
Id []GetConnect Configs Kubernetes Cluster Open Id Connect Config - Organization
Id string - The ID of the organization the cluster is associated with.
- Private
Network stringId - The ID of the private network of the cluster.
- Status string
- The status of the Kubernetes cluster.
- []string
- The tags associated with the Kubernetes cluster.
- Type string
- The type of the Kubernetes cluster.
- Updated
At string - The last update date of the cluster.
- Upgrade
Available bool - True if a newer Kubernetes version is available.
- Version string
- The version of the Kubernetes cluster.
- Wildcard
Dns string - The DNS wildcard that points to all ready nodes.
- Cluster
Id string - Name string
- Project
Id string - Region string
- The region in which the cluster is.
- admission
Plugins List<String> - The list of admission plugins enabled on the cluster.
- apiserver
Cert List<String>Sans - apiserver
Url String - The URL of the Kubernetes API server.
- auto
Upgrades List<GetKubernetes Cluster Auto Upgrade> - The auto upgrade configuration.
- autoscaler
Configs List<GetKubernetes Cluster Autoscaler Config> - The configuration options for the Kubernetes cluster autoscaler.
- cni String
- The Container Network Interface (CNI) for the Kubernetes cluster.
- created
At String - The creation date of the cluster.
- description String
- A description for the Kubernetes cluster.
- feature
Gates List<String> - The list of feature gates enabled on the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- kubeconfigs
List<Get
Kubernetes Cluster Kubeconfig> - open
Id List<GetConnect Configs Kubernetes Cluster Open Id Connect Config> - organization
Id String - The ID of the organization the cluster is associated with.
- private
Network StringId - The ID of the private network of the cluster.
- status String
- The status of the Kubernetes cluster.
- List<String>
- The tags associated with the Kubernetes cluster.
- type String
- The type of the Kubernetes cluster.
- updated
At String - The last update date of the cluster.
- upgrade
Available Boolean - True if a newer Kubernetes version is available.
- version String
- The version of the Kubernetes cluster.
- wildcard
Dns String - The DNS wildcard that points to all ready nodes.
- cluster
Id String - name String
- project
Id String - region String
- The region in which the cluster is.
- admission
Plugins string[] - The list of admission plugins enabled on the cluster.
- apiserver
Cert string[]Sans - apiserver
Url string - The URL of the Kubernetes API server.
- auto
Upgrades GetKubernetes Cluster Auto Upgrade[] - The auto upgrade configuration.
- autoscaler
Configs GetKubernetes Cluster Autoscaler Config[] - The configuration options for the Kubernetes cluster autoscaler.
- cni string
- The Container Network Interface (CNI) for the Kubernetes cluster.
- created
At string - The creation date of the cluster.
- description string
- A description for the Kubernetes cluster.
- feature
Gates string[] - The list of feature gates enabled on the cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- kubeconfigs
Get
Kubernetes Cluster Kubeconfig[] - open
Id GetConnect Configs Kubernetes Cluster Open Id Connect Config[] - organization
Id string - The ID of the organization the cluster is associated with.
- private
Network stringId - The ID of the private network of the cluster.
- status string
- The status of the Kubernetes cluster.
- string[]
- The tags associated with the Kubernetes cluster.
- type string
- The type of the Kubernetes cluster.
- updated
At string - The last update date of the cluster.
- upgrade
Available boolean - True if a newer Kubernetes version is available.
- version string
- The version of the Kubernetes cluster.
- wildcard
Dns string - The DNS wildcard that points to all ready nodes.
- cluster
Id string - name string
- project
Id 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_ Sequence[str]sans - apiserver_
url str - The URL of the Kubernetes API server.
- auto_
upgrades Sequence[GetKubernetes Cluster Auto Upgrade] - The auto upgrade configuration.
- autoscaler_
configs Sequence[GetKubernetes Cluster Autoscaler Config] - 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[Get
Kubernetes Cluster Kubeconfig] - open_
id_ Sequence[Getconnect_ configs Kubernetes Cluster Open Id Connect Config] - organization_
id str - The ID of the organization the cluster is associated with.
- private_
network_ strid - The ID of the private network of the cluster.
- status str
- The status of the Kubernetes cluster.
- 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.
- admission
Plugins List<String> - The list of admission plugins enabled on the cluster.
- apiserver
Cert List<String>Sans - apiserver
Url String - The URL of the Kubernetes API server.
- auto
Upgrades List<Property Map> - The auto upgrade configuration.
- autoscaler
Configs List<Property Map> - The configuration options for the Kubernetes cluster autoscaler.
- cni String
- The Container Network Interface (CNI) for the Kubernetes cluster.
- created
At String - The creation date of the cluster.
- description String
- A description for the Kubernetes cluster.
- feature
Gates 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>
- open
Id List<Property Map>Connect Configs - organization
Id String - The ID of the organization the cluster is associated with.
- private
Network StringId - The ID of the private network of the cluster.
- status String
- The status of the Kubernetes cluster.
- List<String>
- The tags associated with the Kubernetes cluster.
- type String
- The type of the Kubernetes cluster.
- updated
At String - The last update date of the cluster.
- upgrade
Available Boolean - True if a newer Kubernetes version is available.
- version String
- The version of the Kubernetes cluster.
- wildcard
Dns String - The DNS wildcard that points to all ready nodes.
- cluster
Id String - name String
- project
Id String - region String
- The region in which the cluster is.
Supporting Types
GetKubernetesClusterAutoUpgrade
- Enable bool
- True if Kubernetes patch version auto upgrades is enabled.
- Maintenance
Window stringDay - The day of the auto upgrade maintenance window (
monday
tosunday
, orany
). - Maintenance
Window intStart Hour - 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 stringDay - The day of the auto upgrade maintenance window (
monday
tosunday
, orany
). - Maintenance
Window intStart Hour - 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.
- maintenance
Window StringDay - The day of the auto upgrade maintenance window (
monday
tosunday
, orany
). - maintenance
Window IntegerStart Hour - 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.
- maintenance
Window stringDay - The day of the auto upgrade maintenance window (
monday
tosunday
, orany
). - maintenance
Window numberStart Hour - 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_ strday - The day of the auto upgrade maintenance window (
monday
tosunday
, orany
). - maintenance_
window_ intstart_ hour - 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.
- maintenance
Window StringDay - The day of the auto upgrade maintenance window (
monday
tosunday
, orany
). - maintenance
Window NumberStart Hour - The start hour (UTC) of the 2-hour auto upgrade maintenance window (0 to 23).
GetKubernetesClusterAutoscalerConfig
- Balance
Similar boolNode Groups - True if detecting similar node groups and balance the number of nodes between them is enabled.
- Disable
Scale boolDown - 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.
- Expendable
Pods intPriority Cutoff - 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 boolUtilization - True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
- Max
Graceful intTermination Sec - Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
- Scale
Down stringDelay After Add - The duration after scale up that scale down evaluation resumes.
- Scale
Down stringUnneeded Time - The duration a node should be unneeded before it is eligible for scale down.
- Scale
Down doubleUtilization Threshold - Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
- Balance
Similar boolNode Groups - True if detecting similar node groups and balance the number of nodes between them is enabled.
- Disable
Scale boolDown - 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.
- Expendable
Pods intPriority Cutoff - 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 boolUtilization - True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
- Max
Graceful intTermination Sec - Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
- Scale
Down stringDelay After Add - The duration after scale up that scale down evaluation resumes.
- Scale
Down stringUnneeded Time - The duration a node should be unneeded before it is eligible for scale down.
- Scale
Down float64Utilization Threshold - Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
- balance
Similar BooleanNode Groups - True if detecting similar node groups and balance the number of nodes between them is enabled.
- disable
Scale BooleanDown - 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.
- expendable
Pods IntegerPriority Cutoff - 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 BooleanUtilization - True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
- max
Graceful IntegerTermination Sec - Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
- scale
Down StringDelay After Add - The duration after scale up that scale down evaluation resumes.
- scale
Down StringUnneeded Time - The duration a node should be unneeded before it is eligible for scale down.
- scale
Down DoubleUtilization Threshold - Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
- balance
Similar booleanNode Groups - True if detecting similar node groups and balance the number of nodes between them is enabled.
- disable
Scale booleanDown - 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.
- expendable
Pods numberPriority Cutoff - 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 booleanUtilization - True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
- max
Graceful numberTermination Sec - Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
- scale
Down stringDelay After Add - The duration after scale up that scale down evaluation resumes.
- scale
Down stringUnneeded Time - The duration a node should be unneeded before it is eligible for scale down.
- scale
Down numberUtilization Threshold - Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
- balance_
similar_ boolnode_ groups - True if detecting similar node groups and balance the number of nodes between them is enabled.
- disable_
scale_ booldown - 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_ intpriority_ cutoff - 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_ boolutilization - True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
- max_
graceful_ inttermination_ sec - Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
- scale_
down_ strdelay_ after_ add - The duration after scale up that scale down evaluation resumes.
- scale_
down_ strunneeded_ time - The duration a node should be unneeded before it is eligible for scale down.
- scale_
down_ floatutilization_ threshold - Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
- balance
Similar BooleanNode Groups - True if detecting similar node groups and balance the number of nodes between them is enabled.
- disable
Scale BooleanDown - 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.
- expendable
Pods NumberPriority Cutoff - 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 BooleanUtilization - True if ignoring DaemonSet pods when calculating resource utilization for scaling down is enabled.
- max
Graceful NumberTermination Sec - Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node
- scale
Down StringDelay After Add - The duration after scale up that scale down evaluation resumes.
- scale
Down StringUnneeded Time - The duration a node should be unneeded before it is eligible for scale down.
- scale
Down NumberUtilization Threshold - Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
GetKubernetesClusterKubeconfig
- Cluster
Ca stringCertificate - The CA certificate of the Kubernetes API server.
- Config
File 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 stringCertificate - The CA certificate of the Kubernetes API server.
- Config
File 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 StringCertificate - The CA certificate of the Kubernetes API server.
- config
File 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 stringCertificate - The CA certificate of the Kubernetes API server.
- config
File 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_ strcertificate - 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.
- cluster
Ca StringCertificate - The CA certificate of the Kubernetes API server.
- config
File 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
- Client
Id string - A client id that all tokens must be issued for
- Groups
Claims List<string> - JWT claim to use as the user's group
- Groups
Prefix string - Prefix prepended to group claims
- Issuer
Url string - URL of the provider which allows the API server to discover public signing keys
- Required
Claims List<string> - Multiple key=value pairs that describes a required claim in the ID Token
- Username
Claim string - JWT claim to use as the user name
- Username
Prefix string - Prefix prepended to username
- Client
Id string - A client id that all tokens must be issued for
- Groups
Claims []string - JWT claim to use as the user's group
- Groups
Prefix string - Prefix prepended to group claims
- Issuer
Url string - URL of the provider which allows the API server to discover public signing keys
- Required
Claims []string - Multiple key=value pairs that describes a required claim in the ID Token
- Username
Claim string - JWT claim to use as the user name
- Username
Prefix string - Prefix prepended to username
- client
Id String - A client id that all tokens must be issued for
- groups
Claims List<String> - JWT claim to use as the user's group
- groups
Prefix String - Prefix prepended to group claims
- issuer
Url String - URL of the provider which allows the API server to discover public signing keys
- required
Claims List<String> - Multiple key=value pairs that describes a required claim in the ID Token
- username
Claim String - JWT claim to use as the user name
- username
Prefix String - Prefix prepended to username
- client
Id string - A client id that all tokens must be issued for
- groups
Claims string[] - JWT claim to use as the user's group
- groups
Prefix string - Prefix prepended to group claims
- issuer
Url string - URL of the provider which allows the API server to discover public signing keys
- required
Claims string[] - Multiple key=value pairs that describes a required claim in the ID Token
- username
Claim string - JWT claim to use as the user name
- username
Prefix 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
- client
Id String - A client id that all tokens must be issued for
- groups
Claims List<String> - JWT claim to use as the user's group
- groups
Prefix String - Prefix prepended to group claims
- issuer
Url String - URL of the provider which allows the API server to discover public signing keys
- required
Claims List<String> - Multiple key=value pairs that describes a required claim in the ID Token
- username
Claim String - JWT claim to use as the user name
- username
Prefix 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.