Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. eks
  5. getCluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.eks.getCluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    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)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    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:

    AccessConfig Pulumi.AwsNative.Eks.Outputs.ClusterAccessConfig
    The access configuration for the cluster.
    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.
    ComputeConfig Pulumi.AwsNative.Eks.Outputs.ClusterComputeConfig
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .
    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.
    KubernetesNetworkConfig Pulumi.AwsNative.Eks.Outputs.ClusterKubernetesNetworkConfig
    The Kubernetes network configuration for the cluster.
    Logging Pulumi.AwsNative.Eks.Outputs.Logging
    The logging configuration for your cluster.
    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.
    RemoteNetworkConfig Pulumi.AwsNative.Eks.Outputs.ClusterRemoteNetworkConfig
    The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    ResourcesVpcConfig Pulumi.AwsNative.Eks.Outputs.ClusterResourcesVpcConfig
    The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
    StorageConfig Pulumi.AwsNative.Eks.Outputs.ClusterStorageConfig
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    UpgradePolicy Pulumi.AwsNative.Eks.Outputs.ClusterUpgradePolicy

    This value indicates if extended support is enabled or disabled for the cluster.

    Learn more about EKS Extended Support in the Amazon EKS User Guide .

    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.
    ZonalShiftConfig Pulumi.AwsNative.Eks.Outputs.ClusterZonalShiftConfig
    The configuration for zonal shift for the cluster.
    AccessConfig ClusterAccessConfig
    The access configuration for the cluster.
    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.
    ComputeConfig ClusterComputeConfig
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .
    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.
    KubernetesNetworkConfig ClusterKubernetesNetworkConfig
    The Kubernetes network configuration for the cluster.
    Logging Logging
    The logging configuration for your cluster.
    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.
    RemoteNetworkConfig ClusterRemoteNetworkConfig
    The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    ResourcesVpcConfig ClusterResourcesVpcConfig
    The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
    StorageConfig ClusterStorageConfig
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .
    Tags Tag
    An array of key-value pairs to apply to this resource.
    UpgradePolicy ClusterUpgradePolicy

    This value indicates if extended support is enabled or disabled for the cluster.

    Learn more about EKS Extended Support in the Amazon EKS User Guide .

    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.
    ZonalShiftConfig ClusterZonalShiftConfig
    The configuration for zonal shift for the cluster.
    accessConfig ClusterAccessConfig
    The access configuration for the cluster.
    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.
    computeConfig ClusterComputeConfig
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .
    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.
    kubernetesNetworkConfig ClusterKubernetesNetworkConfig
    The Kubernetes network configuration for the cluster.
    logging Logging
    The logging configuration for your cluster.
    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.
    remoteNetworkConfig ClusterRemoteNetworkConfig
    The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    resourcesVpcConfig ClusterResourcesVpcConfig
    The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
    storageConfig ClusterStorageConfig
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    upgradePolicy ClusterUpgradePolicy

    This value indicates if extended support is enabled or disabled for the cluster.

    Learn more about EKS Extended Support in the Amazon EKS User Guide .

    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.
    zonalShiftConfig ClusterZonalShiftConfig
    The configuration for zonal shift for the cluster.
    accessConfig ClusterAccessConfig
    The access configuration for the cluster.
    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.
    computeConfig ClusterComputeConfig
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .
    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.
    kubernetesNetworkConfig ClusterKubernetesNetworkConfig
    The Kubernetes network configuration for the cluster.
    logging Logging
    The logging configuration for your cluster.
    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.
    remoteNetworkConfig ClusterRemoteNetworkConfig
    The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    resourcesVpcConfig ClusterResourcesVpcConfig
    The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
    storageConfig ClusterStorageConfig
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    upgradePolicy ClusterUpgradePolicy

    This value indicates if extended support is enabled or disabled for the cluster.

    Learn more about EKS Extended Support in the Amazon EKS User Guide .

    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.
    zonalShiftConfig ClusterZonalShiftConfig
    The configuration for zonal shift for the cluster.
    access_config ClusterAccessConfig
    The access configuration for the cluster.
    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.
    compute_config ClusterComputeConfig
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .
    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.
    kubernetes_network_config ClusterKubernetesNetworkConfig
    The Kubernetes network configuration for the cluster.
    logging Logging
    The logging configuration for your cluster.
    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.
    remote_network_config ClusterRemoteNetworkConfig
    The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    resources_vpc_config ClusterResourcesVpcConfig
    The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
    storage_config ClusterStorageConfig
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    upgrade_policy ClusterUpgradePolicy

    This value indicates if extended support is enabled or disabled for the cluster.

    Learn more about EKS Extended Support in the Amazon EKS User Guide .

    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.
    zonal_shift_config ClusterZonalShiftConfig
    The configuration for zonal shift for the cluster.
    accessConfig Property Map
    The access configuration for the cluster.
    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.
    computeConfig Property Map
    Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your AWS account. For more information, see EKS Auto Mode compute capability in the Amazon EKS User Guide .
    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.
    kubernetesNetworkConfig Property Map
    The Kubernetes network configuration for the cluster.
    logging Property Map
    The logging configuration for your cluster.
    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.
    remoteNetworkConfig Property Map
    The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.
    resourcesVpcConfig Property Map
    The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide . You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
    storageConfig Property Map
    Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your AWS account. For more information, see EKS Auto Mode block storage capability in the Amazon EKS User Guide .
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    upgradePolicy Property Map

    This value indicates if extended support is enabled or disabled for the cluster.

    Learn more about EKS Extended Support in the Amazon EKS User Guide .

    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.
    zonalShiftConfig Property Map
    The configuration for zonal shift for the cluster.

    Supporting Types

    ClusterAccessConfig

    AuthenticationMode Pulumi.AwsNative.Eks.ClusterAccessConfigAuthenticationMode
    Specify the authentication mode that should be used to create your cluster.
    BootstrapClusterCreatorAdminPermissions bool
    Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.
    AuthenticationMode ClusterAccessConfigAuthenticationMode
    Specify the authentication mode that should be used to create your cluster.
    BootstrapClusterCreatorAdminPermissions bool
    Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.
    authenticationMode ClusterAccessConfigAuthenticationMode
    Specify the authentication mode that should be used to create your cluster.
    bootstrapClusterCreatorAdminPermissions Boolean
    Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.
    authenticationMode ClusterAccessConfigAuthenticationMode
    Specify the authentication mode that should be used to create your cluster.
    bootstrapClusterCreatorAdminPermissions boolean
    Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.
    authentication_mode ClusterAccessConfigAuthenticationMode
    Specify the authentication mode that should be used to create your cluster.
    bootstrap_cluster_creator_admin_permissions bool
    Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.
    authenticationMode "CONFIG_MAP" | "API_AND_CONFIG_MAP" | "API"
    Specify the authentication mode that should be used to create your cluster.
    bootstrapClusterCreatorAdminPermissions Boolean
    Set this value to false to avoid creating a default cluster admin Access Entry using the IAM principal used to create the cluster.

    ClusterAccessConfigAuthenticationMode

    ClusterBlockStorage

    Enabled bool
    Todo: add description
    Enabled bool
    Todo: add description
    enabled Boolean
    Todo: add description
    enabled boolean
    Todo: add description
    enabled bool
    Todo: add description
    enabled Boolean
    Todo: add description

    ClusterComputeConfig

    Enabled bool
    Todo: add description
    NodePools List<string>
    Todo: add description
    NodeRoleArn string
    Todo: add description
    Enabled bool
    Todo: add description
    NodePools []string
    Todo: add description
    NodeRoleArn string
    Todo: add description
    enabled Boolean
    Todo: add description
    nodePools List<String>
    Todo: add description
    nodeRoleArn String
    Todo: add description
    enabled boolean
    Todo: add description
    nodePools string[]
    Todo: add description
    nodeRoleArn string
    Todo: add description
    enabled bool
    Todo: add description
    node_pools Sequence[str]
    Todo: add description
    node_role_arn str
    Todo: add description
    enabled Boolean
    Todo: add description
    nodePools List<String>
    Todo: add description
    nodeRoleArn String
    Todo: add description

    ClusterElasticLoadBalancing

    Enabled bool
    Todo: add description
    Enabled bool
    Todo: add description
    enabled Boolean
    Todo: add description
    enabled boolean
    Todo: add description
    enabled bool
    Todo: add description
    enabled Boolean
    Todo: add description

    ClusterKubernetesNetworkConfig

    ElasticLoadBalancing Pulumi.AwsNative.Eks.Inputs.ClusterElasticLoadBalancing
    Todo: add description
    IpFamily Pulumi.AwsNative.Eks.ClusterKubernetesNetworkConfigIpFamily
    Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
    ServiceIpv4Cidr string
    The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
    ServiceIpv6Cidr string
    The CIDR block to assign Kubernetes service IP addresses from.
    ElasticLoadBalancing ClusterElasticLoadBalancing
    Todo: add description
    IpFamily ClusterKubernetesNetworkConfigIpFamily
    Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
    ServiceIpv4Cidr string
    The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
    ServiceIpv6Cidr string
    The CIDR block to assign Kubernetes service IP addresses from.
    elasticLoadBalancing ClusterElasticLoadBalancing
    Todo: add description
    ipFamily ClusterKubernetesNetworkConfigIpFamily
    Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
    serviceIpv4Cidr String
    The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
    serviceIpv6Cidr String
    The CIDR block to assign Kubernetes service IP addresses from.
    elasticLoadBalancing ClusterElasticLoadBalancing
    Todo: add description
    ipFamily ClusterKubernetesNetworkConfigIpFamily
    Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
    serviceIpv4Cidr string
    The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
    serviceIpv6Cidr string
    The CIDR block to assign Kubernetes service IP addresses from.
    elastic_load_balancing ClusterElasticLoadBalancing
    Todo: add description
    ip_family ClusterKubernetesNetworkConfigIpFamily
    Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
    service_ipv4_cidr str
    The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
    service_ipv6_cidr str
    The CIDR block to assign Kubernetes service IP addresses from.
    elasticLoadBalancing Property Map
    Todo: add description
    ipFamily "ipv4" | "ipv6"
    Ipv4 or Ipv6. You can only specify ipv6 for 1.21 and later clusters that use version 1.10.1 or later of the Amazon VPC CNI add-on
    serviceIpv4Cidr String
    The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not overlap with resources in other networks that are peered or connected to your VPC.
    serviceIpv6Cidr String
    The CIDR block to assign Kubernetes service IP addresses from.

    ClusterKubernetesNetworkConfigIpFamily

    ClusterLoggingEnabledTypes

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

    The enabled control plane logs for your cluster. All log types are disabled if the array is empty.

    When updating a resource, you must include this EnabledTypes property if the previous CloudFormation template of the resource had it.

    EnabledTypes []ClusterLoggingTypeConfig

    The enabled control plane logs for your cluster. All log types are disabled if the array is empty.

    When updating a resource, you must include this EnabledTypes property if the previous CloudFormation template of the resource had it.

    enabledTypes List<ClusterLoggingTypeConfig>

    The enabled control plane logs for your cluster. All log types are disabled if the array is empty.

    When updating a resource, you must include this EnabledTypes property if the previous CloudFormation template of the resource had it.

    enabledTypes ClusterLoggingTypeConfig[]

    The enabled control plane logs for your cluster. All log types are disabled if the array is empty.

    When updating a resource, you must include this EnabledTypes property if the previous CloudFormation template of the resource had it.

    enabled_types Sequence[ClusterLoggingTypeConfig]

    The enabled control plane logs for your cluster. All log types are disabled if the array is empty.

    When updating a resource, you must include this EnabledTypes property if the previous CloudFormation template of the resource had it.

    enabledTypes List<Property Map>

    The enabled control plane logs for your cluster. All log types are disabled if the array is empty.

    When updating a resource, you must include this EnabledTypes property if the previous CloudFormation template of the resource had it.

    ClusterLoggingTypeConfig

    ClusterLoggingTypeConfigType

    ClusterRemoteNetworkConfig

    RemoteNodeNetworks List<Pulumi.AwsNative.Eks.Inputs.ClusterRemoteNodeNetwork>
    Network configuration of nodes run on-premises with EKS Hybrid Nodes.
    RemotePodNetworks List<Pulumi.AwsNative.Eks.Inputs.ClusterRemotePodNetwork>
    Network configuration of pods run on-premises with EKS Hybrid Nodes.
    RemoteNodeNetworks []ClusterRemoteNodeNetwork
    Network configuration of nodes run on-premises with EKS Hybrid Nodes.
    RemotePodNetworks []ClusterRemotePodNetwork
    Network configuration of pods run on-premises with EKS Hybrid Nodes.
    remoteNodeNetworks List<ClusterRemoteNodeNetwork>
    Network configuration of nodes run on-premises with EKS Hybrid Nodes.
    remotePodNetworks List<ClusterRemotePodNetwork>
    Network configuration of pods run on-premises with EKS Hybrid Nodes.
    remoteNodeNetworks ClusterRemoteNodeNetwork[]
    Network configuration of nodes run on-premises with EKS Hybrid Nodes.
    remotePodNetworks ClusterRemotePodNetwork[]
    Network configuration of pods run on-premises with EKS Hybrid Nodes.
    remote_node_networks Sequence[ClusterRemoteNodeNetwork]
    Network configuration of nodes run on-premises with EKS Hybrid Nodes.
    remote_pod_networks Sequence[ClusterRemotePodNetwork]
    Network configuration of pods run on-premises with EKS Hybrid Nodes.
    remoteNodeNetworks List<Property Map>
    Network configuration of nodes run on-premises with EKS Hybrid Nodes.
    remotePodNetworks List<Property Map>
    Network configuration of pods run on-premises with EKS Hybrid Nodes.

    ClusterRemoteNodeNetwork

    Cidrs List<string>
    Specifies the list of remote node CIDRs.
    Cidrs []string
    Specifies the list of remote node CIDRs.
    cidrs List<String>
    Specifies the list of remote node CIDRs.
    cidrs string[]
    Specifies the list of remote node CIDRs.
    cidrs Sequence[str]
    Specifies the list of remote node CIDRs.
    cidrs List<String>
    Specifies the list of remote node CIDRs.

    ClusterRemotePodNetwork

    Cidrs List<string>
    Specifies the list of remote pod CIDRs.
    Cidrs []string
    Specifies the list of remote pod CIDRs.
    cidrs List<String>
    Specifies the list of remote pod CIDRs.
    cidrs string[]
    Specifies the list of remote pod CIDRs.
    cidrs Sequence[str]
    Specifies the list of remote pod CIDRs.
    cidrs List<String>
    Specifies the list of remote pod CIDRs.

    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.

    ClusterStorageConfig

    BlockStorage ClusterBlockStorage
    Todo: add description
    blockStorage ClusterBlockStorage
    Todo: add description
    blockStorage ClusterBlockStorage
    Todo: add description
    block_storage ClusterBlockStorage
    Todo: add description
    blockStorage Property Map
    Todo: add description

    ClusterUpgradePolicy

    SupportType Pulumi.AwsNative.Eks.ClusterUpgradePolicySupportType
    Specify the support type for your cluster.
    SupportType ClusterUpgradePolicySupportType
    Specify the support type for your cluster.
    supportType ClusterUpgradePolicySupportType
    Specify the support type for your cluster.
    supportType ClusterUpgradePolicySupportType
    Specify the support type for your cluster.
    support_type ClusterUpgradePolicySupportType
    Specify the support type for your cluster.
    supportType "STANDARD" | "EXTENDED"
    Specify the support type for your cluster.

    ClusterUpgradePolicySupportType

    ClusterZonalShiftConfig

    Enabled bool
    Set this value to true to enable zonal shift for the cluster.
    Enabled bool
    Set this value to true to enable zonal shift for the cluster.
    enabled Boolean
    Set this value to true to enable zonal shift for the cluster.
    enabled boolean
    Set this value to true to enable zonal shift for the cluster.
    enabled bool
    Set this value to true to enable zonal shift for the cluster.
    enabled Boolean
    Set this value to true to enable zonal shift for the cluster.

    Logging

    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.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native