AWS Native v0.54.0, Mar 21 23

aws-native.eks.getCluster

An object representing an Amazon EKS cluster.

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.

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>

def get_cluster(name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(name: Optional[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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:eks:getCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The unique name to give to your cluster.

Name string: The unique name to give to your cluster.

name String: The unique name to give to your cluster.

name string: The unique name to give to your cluster.

name str: The unique name to give to your cluster.

name String: The unique name to give to your cluster.

getCluster Result

The following output properties are available:

Arn string: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
CertificateAuthorityData string: The certificate-authority-data for your cluster.
ClusterSecurityGroupId string: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
EncryptionConfigKeyArn string: Amazon Resource Name (ARN) or alias of the customer master key (CMK).
Endpoint string: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
Id string: The unique ID given to your cluster.
Logging Pulumi.AwsNative.EKS.Outputs.ClusterLogging
OpenIdConnectIssuerUrl string: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
ResourcesVpcConfig Pulumi.AwsNative.EKS.Outputs.ClusterResourcesVpcConfig
Tags List<Pulumi.AwsNative.EKS.Outputs.ClusterTag>: An array of key-value pairs to apply to this resource.
Version string: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

Arn string: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
CertificateAuthorityData string: The certificate-authority-data for your cluster.
ClusterSecurityGroupId string: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
EncryptionConfigKeyArn string: Amazon Resource Name (ARN) or alias of the customer master key (CMK).
Endpoint string: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
Id string: The unique ID given to your cluster.
Logging ClusterLogging
OpenIdConnectIssuerUrl string: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
ResourcesVpcConfig ClusterResourcesVpcConfig
Tags []ClusterTag: An array of key-value pairs to apply to this resource.
Version string: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

arn String: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
certificateAuthorityData String: The certificate-authority-data for your cluster.
clusterSecurityGroupId String: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
encryptionConfigKeyArn String: Amazon Resource Name (ARN) or alias of the customer master key (CMK).
endpoint String: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
id String: The unique ID given to your cluster.
logging ClusterLogging
openIdConnectIssuerUrl String: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
resourcesVpcConfig ClusterResourcesVpcConfig
tags List<ClusterTag>: An array of key-value pairs to apply to this resource.
version String: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

arn string: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
certificateAuthorityData string: The certificate-authority-data for your cluster.
clusterSecurityGroupId string: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
encryptionConfigKeyArn string: Amazon Resource Name (ARN) or alias of the customer master key (CMK).
endpoint string: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
id string: The unique ID given to your cluster.
logging ClusterLogging
openIdConnectIssuerUrl string: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
resourcesVpcConfig ClusterResourcesVpcConfig
tags ClusterTag[]: An array of key-value pairs to apply to this resource.
version string: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

arn str: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
certificate_authority_data str: The certificate-authority-data for your cluster.
cluster_security_group_id str: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
encryption_config_key_arn str: Amazon Resource Name (ARN) or alias of the customer master key (CMK).
endpoint str: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
id str: The unique ID given to your cluster.
logging ClusterLogging
open_id_connect_issuer_url str: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
resources_vpc_config ClusterResourcesVpcConfig
tags Sequence[ClusterTag]: An array of key-value pairs to apply to this resource.
version str: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

arn String: The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod.
certificateAuthorityData String: The certificate-authority-data for your cluster.
clusterSecurityGroupId String: The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
encryptionConfigKeyArn String: Amazon Resource Name (ARN) or alias of the customer master key (CMK).
endpoint String: The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com.
id String: The unique ID given to your cluster.
logging Property Map
openIdConnectIssuerUrl String: The issuer URL for the cluster's OIDC identity provider, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E. If you need to remove https:// from this output value, you can include the following code in your template.
resourcesVpcConfig Property Map
tags List<Property Map>: An array of key-value pairs to apply to this resource.
version String: The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

Supporting Types

ClusterLogging

ClusterLoggingValue Pulumi.AwsNative.EKS.Inputs.ClusterLoggingEnabledTypes: The cluster control plane logging configuration for your cluster.

ClusterLogging ClusterLoggingEnabledTypes: The cluster control plane logging configuration for your cluster.

clusterLogging ClusterLoggingEnabledTypes: The cluster control plane logging configuration for your cluster.

clusterLogging ClusterLoggingEnabledTypes: The cluster control plane logging configuration for your cluster.

cluster_logging ClusterLoggingEnabledTypes: The cluster control plane logging configuration for your cluster.

clusterLogging Property Map: The cluster control plane logging configuration for your cluster.

ClusterLoggingEnabledTypes

EnabledTypes List<Pulumi.AwsNative.EKS.Inputs.ClusterLoggingTypeConfig>

EnabledTypes []ClusterLoggingTypeConfig

enabledTypes List<ClusterLoggingTypeConfig>

enabledTypes ClusterLoggingTypeConfig[]

enabled_types Sequence[ClusterLoggingTypeConfig]

enabledTypes List<Property Map>

ClusterLoggingTypeConfig

Type Pulumi.AwsNative.EKS.ClusterLoggingTypeConfigType: name of the log type

Type ClusterLoggingTypeConfigType: name of the log type

type ClusterLoggingTypeConfigType: name of the log type

type ClusterLoggingTypeConfigType: name of the log type

type ClusterLoggingTypeConfigType: name of the log type

type "api" | "audit" | "authenticator" | "controllerManager" | "scheduler": name of the log type

ClusterLoggingTypeConfigType

ClusterResourcesVpcConfig

SubnetIds List<string>: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
EndpointPrivateAccess bool: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
EndpointPublicAccess bool: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
PublicAccessCidrs List<string>: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
SecurityGroupIds List<string>: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

SubnetIds []string: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
EndpointPrivateAccess bool: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
EndpointPublicAccess bool: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
PublicAccessCidrs []string: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
SecurityGroupIds []string: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

subnetIds List<String>: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
endpointPrivateAccess Boolean: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
endpointPublicAccess Boolean: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
publicAccessCidrs List<String>: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
securityGroupIds List<String>: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

subnetIds string[]: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
endpointPrivateAccess boolean: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
endpointPublicAccess boolean: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
publicAccessCidrs string[]: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
securityGroupIds string[]: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

subnet_ids Sequence[str]: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
endpoint_private_access bool: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
endpoint_public_access bool: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
public_access_cidrs Sequence[str]: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
security_group_ids Sequence[str]: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

subnetIds List<String>: Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.
endpointPrivateAccess Boolean: Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods.
endpointPublicAccess Boolean: Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server.
publicAccessCidrs List<String>: The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks.
securityGroupIds List<String>: Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

ClusterTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0