1. Docs
  2. Reference
  3. API
  4. AWS
  5. eks
  6. getCluster

getCluster

Retrieve information about an EKS Cluster.

Using getCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
def get_cluster(name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string
The name of the cluster
Tags Dictionary<string, string>
Key-value map of resource tags.
Name string
The name of the cluster
Tags map[string]string
Key-value map of resource tags.
name string
The name of the cluster
tags {[key: string]: string}
Key-value map of resource tags.
name str
The name of the cluster
tags Mapping[str, str]
Key-value map of resource tags.

getCluster Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) of the cluster.
CertificateAuthority GetClusterCertificateAuthority
Nested attribute containing certificate-authority-data for your cluster.
CreatedAt string
The Unix epoch time stamp in seconds for when the cluster was created.
EnabledClusterLogTypes List<string>
The enabled control plane logs.
Endpoint string
The 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
PlatformVersion string
The platform version for the cluster.
RoleArn string
The Amazon Resource Name (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
The status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
Tags Dictionary<string, string>
Key-value map of resource tags.
Version string
The Kubernetes server version for the cluster.
VpcConfig GetClusterVpcConfig
Nested list containing VPC configuration for the cluster.
Arn string
The Amazon Resource Name (ARN) of the cluster.
CertificateAuthority GetClusterCertificateAuthority
Nested attribute containing certificate-authority-data for your cluster.
CreatedAt string
The Unix epoch time stamp in seconds for when the cluster was created.
EnabledClusterLogTypes []string
The enabled control plane logs.
Endpoint string
The 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
PlatformVersion string
The platform version for the cluster.
RoleArn string
The Amazon Resource Name (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
The status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
Tags map[string]string
Key-value map of resource tags.
Version string
The Kubernetes server version for the cluster.
VpcConfig GetClusterVpcConfig
Nested list containing VPC configuration for the cluster.
arn string
The Amazon Resource Name (ARN) of the cluster.
certificateAuthority GetClusterCertificateAuthority
Nested attribute containing certificate-authority-data for your cluster.
createdAt string
The Unix epoch time stamp in seconds for when the cluster was created.
enabledClusterLogTypes string[]
The enabled control plane logs.
endpoint string
The 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
platformVersion string
The platform version for the cluster.
roleArn string
The Amazon Resource Name (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
The status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
tags {[key: string]: string}
Key-value map of resource tags.
version string
The Kubernetes server version for the cluster.
vpcConfig GetClusterVpcConfig
Nested list containing VPC configuration for the cluster.
arn str
The Amazon Resource Name (ARN) of the cluster.
certificate_authority GetClusterCertificateAuthority
Nested attribute containing certificate-authority-data for your cluster.
created_at str
The 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
The 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
platform_version str
The platform version for the cluster.
role_arn str
The Amazon Resource Name (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
The status of the EKS cluster. One of CREATING, ACTIVE, DELETING, FAILED.
tags Mapping[str, str]
Key-value map of resource tags.
version str
The Kubernetes server version for the cluster.
vpc_config GetClusterVpcConfig
Nested list containing VPC configuration for the cluster.

Supporting Types

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

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

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 str
Issuer URL for the OpenID Connect identity provider.

GetClusterKubernetesNetworkConfig

ServiceIpv4Cidr string
The CIDR block to assign Kubernetes service IP addresses from.
ServiceIpv4Cidr string
The CIDR block to assign Kubernetes service IP addresses from.
serviceIpv4Cidr string
The CIDR block to assign Kubernetes service IP addresses from.
service_ipv4_cidr str
The CIDR block to assign Kubernetes service IP addresses from.

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
Register Now For PulumiUP