getCluster function

Future<GetClusterResult> getCluster(
  1. GetClusterArgs args, {
  2. InvokeOptions? options,
})

Retrieve information about an EKS Cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

export = async () => {
    const example = await aws.eks.getCluster({
        name: "example",
    });
    return {
        endpoint: example.endpoint,
        "kubeconfig-certificate-authority-data": example.certificateAuthorities?.[0]?.data,
    };
}
import pulumi
import pulumi_aws as aws

example = aws.eks.get_cluster(name="example")
pulumi.export("endpoint", example.endpoint)
pulumi.export("kubeconfig-certificate-authority-data", example.certificate_authorities[0].data)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Eks.GetCluster.Invoke(new()
    {
        Name = "example",
    });

    return new Dictionary<string, object?>
    {
        ["endpoint"] = example.Apply(getClusterResult => getClusterResult.Endpoint),
        ["kubeconfig-certificate-authority-data"] = example.Apply(getClusterResult => getClusterResult.CertificateAuthorities[0]?.Data),
    };
});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/eks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := eks.LookupCluster(ctx, &eks.LookupClusterArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("endpoint", example.Endpoint)
		ctx.Export("kubeconfig-certificate-authority-data", example.CertificateAuthorities[0].Data)
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_eks_getcluster" "example" {
  name = "example"
}

output "endpoint" {
  value = data.aws_eks_getcluster.example.endpoint
}
output "kubeconfig-certificate-authority-data" {
  value = data.aws_eks_getcluster.example.certificate_authorities[0].data
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.EksFunctions;
import com.pulumi.aws.eks.inputs.GetClusterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = EksFunctions.getCluster(GetClusterArgs.builder()
            .name("example")
            .build());

        ctx.export("endpoint", example.endpoint());
        ctx.export("kubeconfig-certificate-authority-data", example.certificateAuthorities()[0].data());
    }
}
variables:
  example:
    fn::invoke:
      function: aws:eks:getCluster
      arguments:
        name: example
outputs:
  endpoint: ${example.endpoint}
  kubeconfig-certificate-authority-data: ${example.certificateAuthorities[0].data}

args Arguments passed to this invoke. Arguments for getCluster. options Invoke options controlling this call.

Implementation

Future<GetClusterResult> getCluster(
  GetClusterArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:eks/getCluster:getCluster',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetClusterResult.fromMap(result);
}