AWS v6.76.0, Apr 8 25

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

aws.eks.getCluster

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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)

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}

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 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.List;
import java.util.ArrayList;
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.applyValue(getClusterResult -> getClusterResult.endpoint()));
        ctx.export("kubeconfig-certificate-authority-data", example.applyValue(getClusterResult -> getClusterResult.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}

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(name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, 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: aws:eks/getCluster:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the cluster.
Tags Dictionary<string, string>: Key-value map of resource tags.

Name string: Name of the cluster.
Tags map[string]string: Key-value map of resource tags.

name String: Name of the cluster.
tags Map<String,String>: Key-value map of resource tags.

name string: Name of the cluster.
tags {[key: string]: string}: Key-value map of resource tags.

name str: Name of the cluster.
tags Mapping[str, str]: Key-value map of resource tags.

name String: Name of the cluster.
tags Map<String>: Key-value map of resource tags.

getCluster Result

The following output properties are available:

AccessConfigs List<GetClusterAccessConfig>: Configuration block for access config.
Arn string: ARN of the cluster.
CertificateAuthorities List<GetClusterCertificateAuthority>: Nested attribute containing certificate-authority-data for your cluster.
ClusterId string: The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
ComputeConfigs List<GetClusterComputeConfig>: Nested attribute containing compute capability configuration for EKS Auto Mode enabled cluster.
CreatedAt string: Unix epoch time stamp in seconds for when the cluster was created.
EnabledClusterLogTypes List<string>: The enabled control plane logs.
Endpoint string: Endpoint for your Kubernetes API server.
Id string: The provider-assigned unique ID for this managed resource.
Identities List<GetClusterIdentity>: Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the aws.eks.Cluster resource documentation.
KubernetesNetworkConfigs List<GetClusterKubernetesNetworkConfig>: Nested list containing Kubernetes Network Configuration.
Name string
OutpostConfigs List<GetClusterOutpostConfig>: Contains Outpost Configuration.
PlatformVersion string: Platform version for the cluster.
RemoteNetworkConfigs List<GetClusterRemoteNetworkConfig>: Contains remote network configuration for EKS Hybrid Nodes.
RoleArn string: ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
Status string: Status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
StorageConfigs List<GetClusterStorageConfig>: Contains storage configuration for EKS Auto Mode enabled cluster.
Tags Dictionary<string, string>: Key-value map of resource tags.
UpgradePolicies List<GetClusterUpgradePolicy>: Configuration block for the support policy to use for the cluster.
Version string: Kubernetes server version for the cluster.
VpcConfig GetClusterVpcConfig: Nested list containing VPC configuration for the cluster.
ZonalShiftConfigs List<GetClusterZonalShiftConfig>: Contains Zonal Shift Configuration.

AccessConfigs []GetClusterAccessConfig: Configuration block for access config.
Arn string: ARN of the cluster.
CertificateAuthorities []GetClusterCertificateAuthority: Nested attribute containing certificate-authority-data for your cluster.
ClusterId string: The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
ComputeConfigs []GetClusterComputeConfig: Nested attribute containing compute capability configuration for EKS Auto Mode enabled cluster.
CreatedAt string: Unix epoch time stamp in seconds for when the cluster was created.
EnabledClusterLogTypes []string: The enabled control plane logs.
Endpoint string: Endpoint for your Kubernetes API server.
Id string: The provider-assigned unique ID for this managed resource.
Identities []GetClusterIdentity: Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the aws.eks.Cluster resource documentation.
KubernetesNetworkConfigs []GetClusterKubernetesNetworkConfig: Nested list containing Kubernetes Network Configuration.
Name string
OutpostConfigs []GetClusterOutpostConfig: Contains Outpost Configuration.
PlatformVersion string: Platform version for the cluster.
RemoteNetworkConfigs []GetClusterRemoteNetworkConfig: Contains remote network configuration for EKS Hybrid Nodes.
RoleArn string: ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
Status string: Status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
StorageConfigs []GetClusterStorageConfig: Contains storage configuration for EKS Auto Mode enabled cluster.
Tags map[string]string: Key-value map of resource tags.
UpgradePolicies []GetClusterUpgradePolicy: Configuration block for the support policy to use for the cluster.
Version string: Kubernetes server version for the cluster.
VpcConfig GetClusterVpcConfig: Nested list containing VPC configuration for the cluster.
ZonalShiftConfigs []GetClusterZonalShiftConfig: Contains Zonal Shift Configuration.

accessConfigs List<GetClusterAccessConfig>: Configuration block for access config.
arn String: ARN of the cluster.
certificateAuthorities List<GetClusterCertificateAuthority>: Nested attribute containing certificate-authority-data for your cluster.
clusterId String: The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
computeConfigs List<GetClusterComputeConfig>: Nested attribute containing compute capability configuration for EKS Auto Mode enabled cluster.
createdAt String: Unix epoch time stamp in seconds for when the cluster was created.
enabledClusterLogTypes List<String>: The enabled control plane logs.
endpoint String: Endpoint for your Kubernetes API server.
id String: The provider-assigned unique ID for this managed resource.
identities List<GetClusterIdentity>: Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the aws.eks.Cluster resource documentation.
kubernetesNetworkConfigs List<GetClusterKubernetesNetworkConfig>: Nested list containing Kubernetes Network Configuration.
name String
outpostConfigs List<GetClusterOutpostConfig>: Contains Outpost Configuration.
platformVersion String: Platform version for the cluster.
remoteNetworkConfigs List<GetClusterRemoteNetworkConfig>: Contains remote network configuration for EKS Hybrid Nodes.
roleArn String: ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
status String: Status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
storageConfigs List<GetClusterStorageConfig>: Contains storage configuration for EKS Auto Mode enabled cluster.
tags Map<String,String>: Key-value map of resource tags.
upgradePolicies List<GetClusterUpgradePolicy>: Configuration block for the support policy to use for the cluster.
version String: Kubernetes server version for the cluster.
vpcConfig GetClusterVpcConfig: Nested list containing VPC configuration for the cluster.
zonalShiftConfigs List<GetClusterZonalShiftConfig>: Contains Zonal Shift Configuration.

accessConfigs GetClusterAccessConfig[]: Configuration block for access config.
arn string: ARN of the cluster.
certificateAuthorities GetClusterCertificateAuthority[]: Nested attribute containing certificate-authority-data for your cluster.
clusterId string: The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
computeConfigs GetClusterComputeConfig[]: Nested attribute containing compute capability configuration for EKS Auto Mode enabled cluster.
createdAt string: Unix epoch time stamp in seconds for when the cluster was created.
enabledClusterLogTypes string[]: The enabled control plane logs.
endpoint string: Endpoint for your Kubernetes API server.
id string: The provider-assigned unique ID for this managed resource.
identities GetClusterIdentity[]: Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the aws.eks.Cluster resource documentation.
kubernetesNetworkConfigs GetClusterKubernetesNetworkConfig[]: Nested list containing Kubernetes Network Configuration.
name string
outpostConfigs GetClusterOutpostConfig[]: Contains Outpost Configuration.
platformVersion string: Platform version for the cluster.
remoteNetworkConfigs GetClusterRemoteNetworkConfig[]: Contains remote network configuration for EKS Hybrid Nodes.
roleArn string: ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
status string: Status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
storageConfigs GetClusterStorageConfig[]: Contains storage configuration for EKS Auto Mode enabled cluster.
tags {[key: string]: string}: Key-value map of resource tags.
upgradePolicies GetClusterUpgradePolicy[]: Configuration block for the support policy to use for the cluster.
version string: Kubernetes server version for the cluster.
vpcConfig GetClusterVpcConfig: Nested list containing VPC configuration for the cluster.
zonalShiftConfigs GetClusterZonalShiftConfig[]: Contains Zonal Shift Configuration.

access_configs Sequence[GetClusterAccessConfig]: Configuration block for access config.
arn str: ARN of the cluster.
certificate_authorities Sequence[GetClusterCertificateAuthority]: Nested attribute containing certificate-authority-data for your cluster.
cluster_id str: The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
compute_configs Sequence[GetClusterComputeConfig]: Nested attribute containing compute capability configuration for EKS Auto Mode enabled cluster.
created_at str: Unix epoch time stamp in seconds for when the cluster was created.
enabled_cluster_log_types Sequence[str]: The enabled control plane logs.
endpoint str: Endpoint for your Kubernetes API server.
id str: The provider-assigned unique ID for this managed resource.
identities Sequence[GetClusterIdentity]: Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the aws.eks.Cluster resource documentation.
kubernetes_network_configs Sequence[GetClusterKubernetesNetworkConfig]: Nested list containing Kubernetes Network Configuration.
name str
outpost_configs Sequence[GetClusterOutpostConfig]: Contains Outpost Configuration.
platform_version str: Platform version for the cluster.
remote_network_configs Sequence[GetClusterRemoteNetworkConfig]: Contains remote network configuration for EKS Hybrid Nodes.
role_arn str: ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
status str: Status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
storage_configs Sequence[GetClusterStorageConfig]: Contains storage configuration for EKS Auto Mode enabled cluster.
tags Mapping[str, str]: Key-value map of resource tags.
upgrade_policies Sequence[GetClusterUpgradePolicy]: Configuration block for the support policy to use for the cluster.
version str: Kubernetes server version for the cluster.
vpc_config GetClusterVpcConfig: Nested list containing VPC configuration for the cluster.
zonal_shift_configs Sequence[GetClusterZonalShiftConfig]: Contains Zonal Shift Configuration.

accessConfigs List<Property Map>: Configuration block for access config.
arn String: ARN of the cluster.
certificateAuthorities List<Property Map>: Nested attribute containing certificate-authority-data for your cluster.
clusterId String: The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud.
computeConfigs List<Property Map>: Nested attribute containing compute capability configuration for EKS Auto Mode enabled cluster.
createdAt String: Unix epoch time stamp in seconds for when the cluster was created.
enabledClusterLogTypes List<String>: The enabled control plane logs.
endpoint String: Endpoint for your Kubernetes API server.
id String: The provider-assigned unique ID for this managed resource.
identities List<Property Map>: Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the aws.eks.Cluster resource documentation.
kubernetesNetworkConfigs List<Property Map>: Nested list containing Kubernetes Network Configuration.
name String
outpostConfigs List<Property Map>: Contains Outpost Configuration.
platformVersion String: Platform version for the cluster.
remoteNetworkConfigs List<Property Map>: Contains remote network configuration for EKS Hybrid Nodes.
roleArn String: ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
status String: Status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
storageConfigs List<Property Map>: Contains storage configuration for EKS Auto Mode enabled cluster.
tags Map<String>: Key-value map of resource tags.
upgradePolicies List<Property Map>: Configuration block for the support policy to use for the cluster.
version String: Kubernetes server version for the cluster.
vpcConfig Property Map: Nested list containing VPC configuration for the cluster.
zonalShiftConfigs List<Property Map>: Contains Zonal Shift Configuration.

Supporting Types

GetClusterAccessConfig

AuthenticationMode string: Values returned are CONFIG_MAP, API or API_AND_CONFIG_MAP
BootstrapClusterCreatorAdminPermissions bool: Default to true.

AuthenticationMode string: Values returned are CONFIG_MAP, API or API_AND_CONFIG_MAP
BootstrapClusterCreatorAdminPermissions bool: Default to true.

authenticationMode String: Values returned are CONFIG_MAP, API or API_AND_CONFIG_MAP
bootstrapClusterCreatorAdminPermissions Boolean: Default to true.

authenticationMode string: Values returned are CONFIG_MAP, API or API_AND_CONFIG_MAP
bootstrapClusterCreatorAdminPermissions boolean: Default to true.

authentication_mode str: Values returned are CONFIG_MAP, API or API_AND_CONFIG_MAP
bootstrap_cluster_creator_admin_permissions bool: Default to true.

authenticationMode String: Values returned are CONFIG_MAP, API or API_AND_CONFIG_MAP
bootstrapClusterCreatorAdminPermissions Boolean: Default to true.

GetClusterCertificateAuthority

Data string: The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

Data string: The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

data String: The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

data string: The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

data str: The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

data String: The base64 encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

GetClusterComputeConfig

Enabled bool: Whether zonal shift is enabled.
NodePools List<string>: List of node pools for the EKS Auto Mode compute capability.
NodeRoleArn string: The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

Enabled bool: Whether zonal shift is enabled.
NodePools []string: List of node pools for the EKS Auto Mode compute capability.
NodeRoleArn string: The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

enabled Boolean: Whether zonal shift is enabled.
nodePools List<String>: List of node pools for the EKS Auto Mode compute capability.
nodeRoleArn String: The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

enabled boolean: Whether zonal shift is enabled.
nodePools string[]: List of node pools for the EKS Auto Mode compute capability.
nodeRoleArn string: The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

enabled bool: Whether zonal shift is enabled.
node_pools Sequence[str]: List of node pools for the EKS Auto Mode compute capability.
node_role_arn str: The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

enabled Boolean: Whether zonal shift is enabled.
nodePools List<String>: List of node pools for the EKS Auto Mode compute capability.
nodeRoleArn String: The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster.

GetClusterIdentity

Oidcs List<GetClusterIdentityOidc>: Nested attribute containing OpenID Connect identity provider information for the cluster.

Oidcs []GetClusterIdentityOidc: Nested attribute containing OpenID Connect identity provider information for the cluster.

oidcs List<GetClusterIdentityOidc>: Nested attribute containing OpenID Connect identity provider information for the cluster.

oidcs GetClusterIdentityOidc[]: Nested attribute containing OpenID Connect identity provider information for the cluster.

oidcs Sequence[GetClusterIdentityOidc]: Nested attribute containing OpenID Connect identity provider information for the cluster.

oidcs List<Property Map>: Nested attribute containing OpenID Connect identity provider information for the cluster.

GetClusterIdentityOidc

Issuer string: Issuer URL for the OpenID Connect identity provider.

Issuer string: Issuer URL for the OpenID Connect identity provider.

issuer String: Issuer URL for the OpenID Connect identity provider.

issuer string: Issuer URL for the OpenID Connect identity provider.

issuer str: Issuer URL for the OpenID Connect identity provider.

issuer String: Issuer URL for the OpenID Connect identity provider.

GetClusterKubernetesNetworkConfig

ElasticLoadBalancings List<GetClusterKubernetesNetworkConfigElasticLoadBalancing>: Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.
IpFamily string: ipv4 or ipv6.
ServiceIpv4Cidr string: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv4 was specified when the cluster was created.
ServiceIpv6Cidr string: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv6 was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

ElasticLoadBalancings []GetClusterKubernetesNetworkConfigElasticLoadBalancing: Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.
IpFamily string: ipv4 or ipv6.
ServiceIpv4Cidr string: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv4 was specified when the cluster was created.
ServiceIpv6Cidr string: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv6 was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

elasticLoadBalancings List<GetClusterKubernetesNetworkConfigElasticLoadBalancing>: Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.
ipFamily String: ipv4 or ipv6.
serviceIpv4Cidr String: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv4 was specified when the cluster was created.
serviceIpv6Cidr String: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv6 was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

elasticLoadBalancings GetClusterKubernetesNetworkConfigElasticLoadBalancing[]: Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.
ipFamily string: ipv4 or ipv6.
serviceIpv4Cidr string: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv4 was specified when the cluster was created.
serviceIpv6Cidr string: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv6 was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

elastic_load_balancings Sequence[GetClusterKubernetesNetworkConfigElasticLoadBalancing]: Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.
ip_family str: ipv4 or ipv6.
service_ipv4_cidr str: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv4 was specified when the cluster was created.
service_ipv6_cidr str: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv6 was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

elasticLoadBalancings List<Property Map>: Contains Elastic Load Balancing configuration for EKS Auto Mode enabled cluster.
ipFamily String: ipv4 or ipv6.
serviceIpv4Cidr String: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv4 was specified when the cluster was created.
serviceIpv6Cidr String: The CIDR block to assign Kubernetes pod and service IP addresses from if ipv6 was specified when the cluster was created. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

GetClusterKubernetesNetworkConfigElasticLoadBalancing

Enabled bool: Whether zonal shift is enabled.

Enabled bool: Whether zonal shift is enabled.

enabled Boolean: Whether zonal shift is enabled.

enabled boolean: Whether zonal shift is enabled.

enabled bool: Whether zonal shift is enabled.

enabled Boolean: Whether zonal shift is enabled.

GetClusterOutpostConfig

ControlPlaneInstanceType string: The Amazon EC2 instance type for all Kubernetes control plane instances.
ControlPlanePlacements List<GetClusterOutpostConfigControlPlanePlacement>: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.
OutpostArns List<string>: List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.

ControlPlaneInstanceType string: The Amazon EC2 instance type for all Kubernetes control plane instances.
ControlPlanePlacements []GetClusterOutpostConfigControlPlanePlacement: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.
OutpostArns []string: List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.

controlPlaneInstanceType String: The Amazon EC2 instance type for all Kubernetes control plane instances.
controlPlanePlacements List<GetClusterOutpostConfigControlPlanePlacement>: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.
outpostArns List<String>: List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.

controlPlaneInstanceType string: The Amazon EC2 instance type for all Kubernetes control plane instances.
controlPlanePlacements GetClusterOutpostConfigControlPlanePlacement[]: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.
outpostArns string[]: List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.

control_plane_instance_type str: The Amazon EC2 instance type for all Kubernetes control plane instances.
control_plane_placements Sequence[GetClusterOutpostConfigControlPlanePlacement]: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.
outpost_arns Sequence[str]: List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.

controlPlaneInstanceType String: The Amazon EC2 instance type for all Kubernetes control plane instances.
controlPlanePlacements List<Property Map>: An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on AWS Outpost.
outpostArns List<String>: List of ARNs of the Outposts hosting the EKS cluster. Only a single ARN is supported currently.

GetClusterOutpostConfigControlPlanePlacement

GroupName string: The name of the placement group for the Kubernetes control plane instances.

GroupName string: The name of the placement group for the Kubernetes control plane instances.

groupName String: The name of the placement group for the Kubernetes control plane instances.

groupName string: The name of the placement group for the Kubernetes control plane instances.

group_name str: The name of the placement group for the Kubernetes control plane instances.

groupName String: The name of the placement group for the Kubernetes control plane instances.

GetClusterRemoteNetworkConfig

RemoteNodeNetworks List<GetClusterRemoteNetworkConfigRemoteNodeNetwork>: The networks that can contain hybrid nodes.
RemotePodNetworks List<GetClusterRemoteNetworkConfigRemotePodNetwork>: The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.

RemoteNodeNetworks []GetClusterRemoteNetworkConfigRemoteNodeNetwork: The networks that can contain hybrid nodes.
RemotePodNetworks []GetClusterRemoteNetworkConfigRemotePodNetwork: The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.

remoteNodeNetworks List<GetClusterRemoteNetworkConfigRemoteNodeNetwork>: The networks that can contain hybrid nodes.
remotePodNetworks List<GetClusterRemoteNetworkConfigRemotePodNetwork>: The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.

remoteNodeNetworks GetClusterRemoteNetworkConfigRemoteNodeNetwork[]: The networks that can contain hybrid nodes.
remotePodNetworks GetClusterRemoteNetworkConfigRemotePodNetwork[]: The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.

remote_node_networks Sequence[GetClusterRemoteNetworkConfigRemoteNodeNetwork]: The networks that can contain hybrid nodes.
remote_pod_networks Sequence[GetClusterRemoteNetworkConfigRemotePodNetwork]: The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.

remoteNodeNetworks List<Property Map>: The networks that can contain hybrid nodes.
remotePodNetworks List<Property Map>: The networks that can contain pods that run Kubernetes webhooks on hybrid nodes.

GetClusterRemoteNetworkConfigRemoteNodeNetwork

Cidrs List<string>: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

Cidrs []string: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs List<String>: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs string[]: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs Sequence[str]: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs List<String>: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

GetClusterRemoteNetworkConfigRemotePodNetwork

Cidrs List<string>: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

Cidrs []string: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs List<String>: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs string[]: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs Sequence[str]: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

cidrs List<String>: List of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes.

GetClusterStorageConfig

BlockStorages List<GetClusterStorageConfigBlockStorage>: Contains block storage configuration for EKS Auto Mode enabled cluster.

BlockStorages []GetClusterStorageConfigBlockStorage: Contains block storage configuration for EKS Auto Mode enabled cluster.

blockStorages List<GetClusterStorageConfigBlockStorage>: Contains block storage configuration for EKS Auto Mode enabled cluster.

blockStorages GetClusterStorageConfigBlockStorage[]: Contains block storage configuration for EKS Auto Mode enabled cluster.

block_storages Sequence[GetClusterStorageConfigBlockStorage]: Contains block storage configuration for EKS Auto Mode enabled cluster.

blockStorages List<Property Map>: Contains block storage configuration for EKS Auto Mode enabled cluster.

GetClusterStorageConfigBlockStorage

Enabled bool: Whether zonal shift is enabled.

Enabled bool: Whether zonal shift is enabled.

enabled Boolean: Whether zonal shift is enabled.

enabled boolean: Whether zonal shift is enabled.

enabled bool: Whether zonal shift is enabled.

enabled Boolean: Whether zonal shift is enabled.

GetClusterUpgradePolicy

SupportType string: Support type to use for the cluster.

SupportType string: Support type to use for the cluster.

supportType String: Support type to use for the cluster.

supportType string: Support type to use for the cluster.

support_type str: Support type to use for the cluster.

supportType String: Support type to use for the cluster.

GetClusterVpcConfig

ClusterSecurityGroupId string: The cluster security group that was created by Amazon EKS for the cluster.
EndpointPrivateAccess bool: Indicates whether or not the Amazon EKS private API server endpoint is enabled.
EndpointPublicAccess bool: Indicates whether or not the Amazon EKS public API server endpoint is enabled.
PublicAccessCidrs List<string>: List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
SecurityGroupIds List<string>: List of security group IDs
SubnetIds List<string>: List of subnet IDs
VpcId string: The VPC associated with your cluster.

ClusterSecurityGroupId string: The cluster security group that was created by Amazon EKS for the cluster.
EndpointPrivateAccess bool: Indicates whether or not the Amazon EKS private API server endpoint is enabled.
EndpointPublicAccess bool: Indicates whether or not the Amazon EKS public API server endpoint is enabled.
PublicAccessCidrs []string: List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
SecurityGroupIds []string: List of security group IDs
SubnetIds []string: List of subnet IDs
VpcId string: The VPC associated with your cluster.

clusterSecurityGroupId String: The cluster security group that was created by Amazon EKS for the cluster.
endpointPrivateAccess Boolean: Indicates whether or not the Amazon EKS private API server endpoint is enabled.
endpointPublicAccess Boolean: Indicates whether or not the Amazon EKS public API server endpoint is enabled.
publicAccessCidrs List<String>: List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
securityGroupIds List<String>: List of security group IDs
subnetIds List<String>: List of subnet IDs
vpcId String: The VPC associated with your cluster.

clusterSecurityGroupId string: The cluster security group that was created by Amazon EKS for the cluster.
endpointPrivateAccess boolean: Indicates whether or not the Amazon EKS private API server endpoint is enabled.
endpointPublicAccess boolean: Indicates whether or not the Amazon EKS public API server endpoint is enabled.
publicAccessCidrs string[]: List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
securityGroupIds string[]: List of security group IDs
subnetIds string[]: List of subnet IDs
vpcId string: The VPC associated with your cluster.

cluster_security_group_id str: The cluster security group that was created by Amazon EKS for the cluster.
endpoint_private_access bool: Indicates whether or not the Amazon EKS private API server endpoint is enabled.
endpoint_public_access bool: Indicates whether or not the Amazon EKS public API server endpoint is enabled.
public_access_cidrs Sequence[str]: List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
security_group_ids Sequence[str]: List of security group IDs
subnet_ids Sequence[str]: List of subnet IDs
vpc_id str: The VPC associated with your cluster.

clusterSecurityGroupId String: The cluster security group that was created by Amazon EKS for the cluster.
endpointPrivateAccess Boolean: Indicates whether or not the Amazon EKS private API server endpoint is enabled.
endpointPublicAccess Boolean: Indicates whether or not the Amazon EKS public API server endpoint is enabled.
publicAccessCidrs List<String>: List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint.
securityGroupIds List<String>: List of security group IDs
subnetIds List<String>: List of subnet IDs
vpcId String: The VPC associated with your cluster.

GetClusterZonalShiftConfig

Enabled bool: Whether zonal shift is enabled.

Enabled bool: Whether zonal shift is enabled.

enabled Boolean: Whether zonal shift is enabled.

enabled boolean: Whether zonal shift is enabled.

enabled bool: Whether zonal shift is enabled.

enabled Boolean: Whether zonal shift is enabled.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-aws

aws.eks.getCluster

On this page

On this page

Example Usage

Using getCluster

getCluster Result

Supporting Types

GetClusterAccessConfig

GetClusterCertificateAuthority

GetClusterComputeConfig

GetClusterIdentity

GetClusterIdentityOidc

GetClusterKubernetesNetworkConfig

GetClusterKubernetesNetworkConfigElasticLoadBalancing

GetClusterOutpostConfig

GetClusterOutpostConfigControlPlanePlacement

GetClusterRemoteNetworkConfig

GetClusterRemoteNetworkConfigRemoteNodeNetwork

GetClusterRemoteNetworkConfigRemotePodNetwork

GetClusterStorageConfig

GetClusterStorageConfigBlockStorage

GetClusterUpgradePolicy

GetClusterVpcConfig

GetClusterZonalShiftConfig

Package Details

On this page

On this page