Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Yandex

v0.10.0 published on Thursday, Nov 18, 2021 by Pulumi

getKubernetesCluster

Get information about a Yandex Kubernetes Cluster.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var myCluster = Output.Create(Yandex.GetKubernetesCluster.InvokeAsync(new Yandex.GetKubernetesClusterArgs
        {
            ClusterId = "some_k8s_cluster_id",
        }));
        this.ClusterExternalV4Endpoint = myCluster.Apply(myCluster => myCluster.Master?.ExternalV4Endpoint);
    }

    [Output("clusterExternalV4Endpoint")]
    public Output<string> ClusterExternalV4Endpoint { get; set; }
}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "some_k8s_cluster_id"
		myCluster, err := yandex.LookupKubernetesCluster(ctx, &GetKubernetesClusterArgs{
			ClusterId: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("clusterExternalV4Endpoint", myCluster.Master.ExternalV4Endpoint)
		return nil
	})
}
import pulumi
import pulumi_yandex as yandex

my_cluster = yandex.get_kubernetes_cluster(cluster_id="some_k8s_cluster_id")
pulumi.export("clusterExternalV4Endpoint", my_cluster.master.external_v4_endpoint)
import * as pulumi from "@pulumi/pulumi";
import * as yandex from "@pulumi/yandex";

const myCluster = pulumi.output(yandex.getKubernetesCluster({
    clusterId: "some_k8s_cluster_id",
}));

export const clusterExternalV4Endpoint = myCluster.master.externalV4Endpoint;

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,
                           folder_id: Optional[str] = None,
                           name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetKubernetesClusterResult
def get_kubernetes_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                           folder_id: Optional[pulumi.Input[str]] = None,
                           name: 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)
}

The following arguments are supported:

ClusterId string
ID of a specific Kubernetes cluster.
FolderId string
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
Name string
Name of a specific Kubernetes cluster.
ClusterId string
ID of a specific Kubernetes cluster.
FolderId string
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
Name string
Name of a specific Kubernetes cluster.
clusterId string
ID of a specific Kubernetes cluster.
folderId string
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
name string
Name of a specific Kubernetes cluster.
cluster_id str
ID of a specific Kubernetes cluster.
folder_id str
Folder that the resource belongs to. If value is omitted, the default provider folder is used.
name str
Name of a specific Kubernetes cluster.

getKubernetesCluster Result

The following output properties are available:

ClusterId string
ClusterIpv4Range string
IP range for allocating pod addresses.
ClusterIpv6Range string
Identical to cluster_ipv4_range but for the IPv6 protocol.
CreatedAt string
The Kubernetes cluster creation timestamp.
Description string
A description of the Kubernetes cluster.
FolderId string
Health string
Health of the Kubernetes cluster.
Id string
The provider-assigned unique ID for this managed resource.
KmsProvider GetKubernetesClusterKmsProvider
cluster KMS provider parameters.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Kubernetes cluster.
LogGroupId string
Log group where cluster stores cluster system logs, like audit, events, or controlplane logs.
Master GetKubernetesClusterMaster
Kubernetes master configuration options. The structure is documented below.
Name string
NetworkId string
The ID of the cluster network.
NetworkImplementation GetKubernetesClusterNetworkImplementation
(Optional) Network Implementation options. The structure is documented below.
NetworkPolicyProvider string
Network policy provider for the cluster, if present. Possible values: CALICO.
NodeIpv4CidrMaskSize int
Size of the masks that are assigned to each node in the cluster.
NodeServiceAccountId string
Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
ReleaseChannel string
Cluster release channel.
ServiceAccountId string
Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides.
ServiceIpv4Range string
IP range Kubernetes services Kubernetes cluster IP addresses will be allocated from.
ServiceIpv6Range string
Identical to service_ipv4_range but for the IPv6 protocol.
Status string
Status of the Kubernetes cluster.
ClusterId string
ClusterIpv4Range string
IP range for allocating pod addresses.
ClusterIpv6Range string
Identical to cluster_ipv4_range but for the IPv6 protocol.
CreatedAt string
The Kubernetes cluster creation timestamp.
Description string
A description of the Kubernetes cluster.
FolderId string
Health string
Health of the Kubernetes cluster.
Id string
The provider-assigned unique ID for this managed resource.
KmsProvider GetKubernetesClusterKmsProvider
cluster KMS provider parameters.
Labels map[string]string
A set of key/value label pairs to assign to the Kubernetes cluster.
LogGroupId string
Log group where cluster stores cluster system logs, like audit, events, or controlplane logs.
Master GetKubernetesClusterMaster
Kubernetes master configuration options. The structure is documented below.
Name string
NetworkId string
The ID of the cluster network.
NetworkImplementation GetKubernetesClusterNetworkImplementation
(Optional) Network Implementation options. The structure is documented below.
NetworkPolicyProvider string
Network policy provider for the cluster, if present. Possible values: CALICO.
NodeIpv4CidrMaskSize int
Size of the masks that are assigned to each node in the cluster.
NodeServiceAccountId string
Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
ReleaseChannel string
Cluster release channel.
ServiceAccountId string
Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides.
ServiceIpv4Range string
IP range Kubernetes services Kubernetes cluster IP addresses will be allocated from.
ServiceIpv6Range string
Identical to service_ipv4_range but for the IPv6 protocol.
Status string
Status of the Kubernetes cluster.
clusterId string
clusterIpv4Range string
IP range for allocating pod addresses.
clusterIpv6Range string
Identical to cluster_ipv4_range but for the IPv6 protocol.
createdAt string
The Kubernetes cluster creation timestamp.
description string
A description of the Kubernetes cluster.
folderId string
health string
Health of the Kubernetes cluster.
id string
The provider-assigned unique ID for this managed resource.
kmsProvider GetKubernetesClusterKmsProvider
cluster KMS provider parameters.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Kubernetes cluster.
logGroupId string
Log group where cluster stores cluster system logs, like audit, events, or controlplane logs.
master GetKubernetesClusterMaster
Kubernetes master configuration options. The structure is documented below.
name string
networkId string
The ID of the cluster network.
networkImplementation GetKubernetesClusterNetworkImplementation
(Optional) Network Implementation options. The structure is documented below.
networkPolicyProvider string
Network policy provider for the cluster, if present. Possible values: CALICO.
nodeIpv4CidrMaskSize number
Size of the masks that are assigned to each node in the cluster.
nodeServiceAccountId string
Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
releaseChannel string
Cluster release channel.
serviceAccountId string
Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides.
serviceIpv4Range string
IP range Kubernetes services Kubernetes cluster IP addresses will be allocated from.
serviceIpv6Range string
Identical to service_ipv4_range but for the IPv6 protocol.
status string
Status of the Kubernetes cluster.
cluster_id str
cluster_ipv4_range str
IP range for allocating pod addresses.
cluster_ipv6_range str
Identical to cluster_ipv4_range but for the IPv6 protocol.
created_at str
The Kubernetes cluster creation timestamp.
description str
A description of the Kubernetes cluster.
folder_id str
health str
Health of the Kubernetes cluster.
id str
The provider-assigned unique ID for this managed resource.
kms_provider GetKubernetesClusterKmsProvider
cluster KMS provider parameters.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Kubernetes cluster.
log_group_id str
Log group where cluster stores cluster system logs, like audit, events, or controlplane logs.
master GetKubernetesClusterMaster
Kubernetes master configuration options. The structure is documented below.
name str
network_id str
The ID of the cluster network.
network_implementation GetKubernetesClusterNetworkImplementation
(Optional) Network Implementation options. The structure is documented below.
network_policy_provider str
Network policy provider for the cluster, if present. Possible values: CALICO.
node_ipv4_cidr_mask_size int
Size of the masks that are assigned to each node in the cluster.
node_service_account_id str
Service account to be used by the worker nodes of the Kubernetes cluster to access Container Registry or to push node logs and metrics.
release_channel str
Cluster release channel.
service_account_id str
Service account to be used for provisioning Compute Cloud and VPC resources for Kubernetes cluster. Selected service account should have edit role on the folder where the Kubernetes cluster will be located and on the folder where selected network resides.
service_ipv4_range str
IP range Kubernetes services Kubernetes cluster IP addresses will be allocated from.
service_ipv6_range str
Identical to service_ipv4_range but for the IPv6 protocol.
status str
Status of the Kubernetes cluster.

Supporting Types

GetKubernetesClusterKmsProvider

KeyId string
KMS key ID.
KeyId string
KMS key ID.
keyId string
KMS key ID.
key_id str
KMS key ID.

GetKubernetesClusterMaster

ClusterCaCertificate string
PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.
ExternalV4Address string
An IPv4 external network address that is assigned to the master.
ExternalV4Endpoint string
External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
InternalV4Address string
An IPv4 internal network address that is assigned to the master.
InternalV4Endpoint string
Internal endpoint that can be used to connect to the master from cloud networks.
MaintenancePolicy GetKubernetesClusterMasterMaintenancePolicy
Maintenance policy for Kubernetes master. The structure is documented below.
PublicIp bool
Boolean flag. When true, Kubernetes master have visible ipv4 address.
Regional GetKubernetesClusterMasterRegional
Information about cluster regional master. The structure is documented below.
SecurityGroupIds List<string>
A list of security groups IDs of the Kubernetes cluster.
Version string
Version of Kubernetes master.
VersionInfo GetKubernetesClusterMasterVersionInfo
Information about cluster version. The structure is documented below.
Zonal GetKubernetesClusterMasterZonal
Information about cluster zonal master. The structure is documented below.
ClusterCaCertificate string
PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.
ExternalV4Address string
An IPv4 external network address that is assigned to the master.
ExternalV4Endpoint string
External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
InternalV4Address string
An IPv4 internal network address that is assigned to the master.
InternalV4Endpoint string
Internal endpoint that can be used to connect to the master from cloud networks.
MaintenancePolicy GetKubernetesClusterMasterMaintenancePolicy
Maintenance policy for Kubernetes master. The structure is documented below.
PublicIp bool
Boolean flag. When true, Kubernetes master have visible ipv4 address.
Regional GetKubernetesClusterMasterRegional
Information about cluster regional master. The structure is documented below.
SecurityGroupIds []string
A list of security groups IDs of the Kubernetes cluster.
Version string
Version of Kubernetes master.
VersionInfo GetKubernetesClusterMasterVersionInfo
Information about cluster version. The structure is documented below.
Zonal GetKubernetesClusterMasterZonal
Information about cluster zonal master. The structure is documented below.
clusterCaCertificate string
PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.
externalV4Address string
An IPv4 external network address that is assigned to the master.
externalV4Endpoint string
External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
internalV4Address string
An IPv4 internal network address that is assigned to the master.
internalV4Endpoint string
Internal endpoint that can be used to connect to the master from cloud networks.
maintenancePolicy GetKubernetesClusterMasterMaintenancePolicy
Maintenance policy for Kubernetes master. The structure is documented below.
publicIp boolean
Boolean flag. When true, Kubernetes master have visible ipv4 address.
regional GetKubernetesClusterMasterRegional
Information about cluster regional master. The structure is documented below.
securityGroupIds string[]
A list of security groups IDs of the Kubernetes cluster.
version string
Version of Kubernetes master.
versionInfo GetKubernetesClusterMasterVersionInfo
Information about cluster version. The structure is documented below.
zonal GetKubernetesClusterMasterZonal
Information about cluster zonal master. The structure is documented below.
cluster_ca_certificate str
PEM-encoded public certificate that is the root of trust for the Kubernetes cluster.
external_v4_address str
An IPv4 external network address that is assigned to the master.
external_v4_endpoint str
External endpoint that can be used to access Kubernetes cluster API from the internet (outside of the cloud).
internal_v4_address str
An IPv4 internal network address that is assigned to the master.
internal_v4_endpoint str
Internal endpoint that can be used to connect to the master from cloud networks.
maintenance_policy GetKubernetesClusterMasterMaintenancePolicy
Maintenance policy for Kubernetes master. The structure is documented below.
public_ip bool
Boolean flag. When true, Kubernetes master have visible ipv4 address.
regional GetKubernetesClusterMasterRegional
Information about cluster regional master. The structure is documented below.
security_group_ids Sequence[str]
A list of security groups IDs of the Kubernetes cluster.
version str
Version of Kubernetes master.
version_info GetKubernetesClusterMasterVersionInfo
Information about cluster version. The structure is documented below.
zonal GetKubernetesClusterMasterZonal
Information about cluster zonal master. The structure is documented below.

GetKubernetesClusterMasterMaintenancePolicy

AutoUpgrade bool
Boolean flag that specifies if master can be upgraded automatically.
MaintenanceWindows List<GetKubernetesClusterMasterMaintenancePolicyMaintenanceWindow>
Set of day intervals, when maintenance is allowed, when update for master is allowed. When omitted, it defaults to any time.
AutoUpgrade bool
Boolean flag that specifies if master can be upgraded automatically.
MaintenanceWindows []GetKubernetesClusterMasterMaintenancePolicyMaintenanceWindow
Set of day intervals, when maintenance is allowed, when update for master is allowed. When omitted, it defaults to any time.
autoUpgrade boolean
Boolean flag that specifies if master can be upgraded automatically.
maintenanceWindows GetKubernetesClusterMasterMaintenancePolicyMaintenanceWindow[]
Set of day intervals, when maintenance is allowed, when update for master is allowed. When omitted, it defaults to any time.
auto_upgrade bool
Boolean flag that specifies if master can be upgraded automatically.
maintenance_windows Sequence[GetKubernetesClusterMasterMaintenancePolicyMaintenanceWindow]
Set of day intervals, when maintenance is allowed, when update for master is allowed. When omitted, it defaults to any time.

GetKubernetesClusterMasterMaintenancePolicyMaintenanceWindow

Day string
Duration string
StartTime string
Day string
Duration string
StartTime string
day string
duration string
startTime string

GetKubernetesClusterMasterRegional

Region string
ID of the availability region where the master compute instances resides.
Region string
ID of the availability region where the master compute instances resides.
region string
ID of the availability region where the master compute instances resides.
region str
ID of the availability region where the master compute instances resides.

GetKubernetesClusterMasterVersionInfo

CurrentVersion string
Current Kubernetes version, major.minor (e.g. 1.15).
NewRevisionAvailable bool
True/false flag. Newer revisions may include Kubernetes patches (e.g 1.15.1 > 1.15.2) as well as some internal component updates - new features or bug fixes in yandex-specific components either on the master or nodes.
NewRevisionSummary string
Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
VersionDeprecated bool
True/false flag. The current version is on the deprecation schedule, component (master or node group) should be upgraded.
CurrentVersion string
Current Kubernetes version, major.minor (e.g. 1.15).
NewRevisionAvailable bool
True/false flag. Newer revisions may include Kubernetes patches (e.g 1.15.1 > 1.15.2) as well as some internal component updates - new features or bug fixes in yandex-specific components either on the master or nodes.
NewRevisionSummary string
Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
VersionDeprecated bool
True/false flag. The current version is on the deprecation schedule, component (master or node group) should be upgraded.
currentVersion string
Current Kubernetes version, major.minor (e.g. 1.15).
newRevisionAvailable boolean
True/false flag. Newer revisions may include Kubernetes patches (e.g 1.15.1 > 1.15.2) as well as some internal component updates - new features or bug fixes in yandex-specific components either on the master or nodes.
newRevisionSummary string
Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
versionDeprecated boolean
True/false flag. The current version is on the deprecation schedule, component (master or node group) should be upgraded.
current_version str
Current Kubernetes version, major.minor (e.g. 1.15).
new_revision_available bool
True/false flag. Newer revisions may include Kubernetes patches (e.g 1.15.1 > 1.15.2) as well as some internal component updates - new features or bug fixes in yandex-specific components either on the master or nodes.
new_revision_summary str
Human readable description of the changes to be applied when updating to the latest revision. Empty if new_revision_available is false.
version_deprecated bool
True/false flag. The current version is on the deprecation schedule, component (master or node group) should be upgraded.

GetKubernetesClusterMasterZonal

Zone string
ID of the availability zone where the master compute instance resides.
Zone string
ID of the availability zone where the master compute instance resides.
zone string
ID of the availability zone where the master compute instance resides.
zone str
ID of the availability zone where the master compute instance resides.

GetKubernetesClusterNetworkImplementation

Cilium GetKubernetesClusterNetworkImplementationCilium
Cilium network implementation configuration. No options exist.
Cilium GetKubernetesClusterNetworkImplementationCilium
Cilium network implementation configuration. No options exist.
cilium GetKubernetesClusterNetworkImplementationCilium
Cilium network implementation configuration. No options exist.
cilium GetKubernetesClusterNetworkImplementationCilium
Cilium network implementation configuration. No options exist.

GetKubernetesClusterNetworkImplementationCilium

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.