# create-cluster ## Description Creates an Amazon EKS control plane. The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as `etcd` and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances. The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support `kubectl exec` , `logs` , and `proxy` data flows). Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster’s control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster. You can use the `endpointPublicAccess` and `endpointPrivateAccess` parameters to enable or disable public and private access to your cluster’s Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. The endpoint domain name and IP address family depends on the value of the `ipFamily` for the cluster. For more information, see [Amazon EKS Cluster Endpoint Access Control](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the \* *Amazon EKS User Guide* \* . You can use the `logging` parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren’t exported to CloudWatch Logs. For more information, see [Amazon EKS Cluster Control Plane Logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the \* *Amazon EKS User Guide* \* . #### NOTE CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/) . In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see [Allowing users to access your cluster](https://docs.aws.amazon.com/eks/latest/userguide/cluster-auth.html) and [Launching Amazon EKS nodes](https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html) in the *Amazon EKS User Guide* . See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/CreateCluster) ## Synopsis ``` create-cluster --name --role-arn --resources-vpc-config [--kubernetes-network-config ] [--logging ] [--client-request-token ] [--tags ] [--encryption-config ] [--outpost-config ] [--access-config ] [--bootstrap-self-managed-addons | --no-bootstrap-self-managed-addons] [--upgrade-policy ] [--zonal-shift-config ] [--remote-network-config ] [--compute-config ] [--storage-config ] [--deletion-protection | --no-deletion-protection] [--control-plane-scaling-config ] [--kube-api-server-config ] [--kube-scheduler-config ] [--kube-controller-manager-config ] [--kubernetes-version ] [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton ] [--debug] [--endpoint-url ] [--no-verify-ssl] [--no-paginate] [--output ] [--query ] [--profile ] [--region ] [--version ] [--color ] [--no-sign-request] [--ca-bundle ] [--cli-read-timeout ] [--cli-connect-timeout ] [--cli-binary-format ] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt] [--cli-error-format ] [--help] ``` ## Options `--name` (string) [required] > The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can’t be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you’re creating the cluster in. > Constraints: > * min: `1` > * max: `100` > * pattern: `^[0-9A-Za-z][A-Za-z0-9\-_]*` `--role-arn` (string) [required] > The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see [Amazon EKS Service IAM Role](https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html) in the \* *Amazon EKS User Guide* \* . `--resources-vpc-config` (structure) [required] > 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](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the *Amazon EKS User Guide* . You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane. > subnetIds -> (list) > > 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. > > (string) > securityGroupIds -> (list) > > Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes control plane. If you don’t specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes. For more information, see [Amazon EKS security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the \* *Amazon EKS User Guide* \* . > > (string) > 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. The endpoint domain name and IP address family depends on the value of the `ipFamily` for the cluster. For more information, see [Cluster API server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the \* *Amazon EKS User Guide* \* . > 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 Fargate pods in the cluster, then ensure that `publicAccessCidrs` includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see [Cluster API server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the \* *Amazon EKS User Guide* \* . > publicAccessCidrs -> (list) > > 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` and additionally `::/0` for dual-stack IPv6 clusters. If you’ve disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate `Pod` in the cluster. For more information, see [Cluster API server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the \* *Amazon EKS User Guide* \* . > > Note that the public endpoints are dual-stack for only `IPv6` clusters that are made after October 2024. You can’t add `IPv6` CIDR blocks to `IPv4` clusters or `IPv6` clusters that were made before October 2024. > > (string) > controlPlaneEgressMode -> (string) > > Specifies the control plane egress routing mode for the cluster. If the cluster is set to `AWS_MANAGED` , Amazon EKS manages the egress path from the control plane and you don’t need to configure NAT gateways or other routing infrastructure for control plane traffic. If the cluster is set to `CUSTOMER_ROUTED` , you manage the egress path from the control plane in your VPC subnets. You are responsible for ensuring that the control plane can reach required endpoints such as webhook servers and OIDC providers. The default value is `AWS_MANAGED` . Once set to `CUSTOMER_ROUTED` , this setting cannot be changed back to `AWS_MANAGED` on the same cluster. > > > [Learn more about control plane egress routing in the \*Amazon EKS User Guide\* .](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-egress.html) > > Possible values: > > * `AWS_MANAGED` > > * `CUSTOMER_ROUTED` > > * `CUSTOMER_ISOLATED` Shorthand Syntax: ``` subnetIds=string,string,securityGroupIds=string,string,endpointPublicAccess=boolean,endpointPrivateAccess=boolean,publicAccessCidrs=string,string,controlPlaneEgressMode=string ``` JSON Syntax: ```json { "subnetIds": ["string", ...], "securityGroupIds": ["string", ...], "endpointPublicAccess": true|false, "endpointPrivateAccess": true|false, "publicAccessCidrs": ["string", ...], "controlPlaneEgressMode": "AWS_MANAGED"|"CUSTOMER_ROUTED"|"CUSTOMER_ISOLATED" } ``` `--kubernetes-network-config` (structure) > The Kubernetes network configuration for the cluster. > serviceIpv4Cidr -> (string) > > Don’t specify a value if you select `ipv6` for **ipFamily** . 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. The block must meet the following requirements: > > * Within one of the following private IP address blocks: `10.0.0.0/8` , `172.16.0.0/12` , or `192.168.0.0/16` . > > * Doesn’t overlap with any CIDR block assigned to the VPC that you selected for VPC. > > * Between `/24` and `/12` . > > #### WARNING > > You can only specify a custom CIDR block when you create a cluster. You can’t change this value after the cluster is created. > ipFamily -> (string) > > Specify which IP family is used to assign Kubernetes pod and service IP addresses. If you don’t specify a value, `ipv4` is used by default. You can only specify an IP family when you create a cluster and can’t change this value once the cluster is created. If you specify `ipv6` , the VPC and subnets that you specify for cluster creation must have both `IPv4` and `IPv6` CIDR blocks assigned to them. You can’t specify `ipv6` for clusters in China Regions. > > 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. If you specify `ipv6` , then ensure that your VPC meets the requirements listed in the considerations listed in [Assigning IPv6 addresses to pods and services](https://docs.aws.amazon.com/eks/latest/userguide/cni-ipv6.html) in the *Amazon EKS User Guide* . Kubernetes assigns services `IPv6` addresses from the unique local address range `(fc00::/7)` . You can’t specify a custom `IPv6` CIDR block. Pod addresses are assigned from the subnet’s `IPv6` CIDR. > > Possible values: > > * `ipv4` > > * `ipv6` > elasticLoadBalancing -> (structure) > > Request to enable or disable the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide* . > > enabled -> (boolean) > > > Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. > > gatewayApi -> (structure) > > > Indicates the current configuration of the Kubernetes Gateway API for the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide* . > > > crds -> (structure) > > > > Indicates the current configuration of Gateway API custom resource definition (CRD) management on your EKS Auto Mode cluster. For example, if CRD management is enabled or disabled. > > > > managed -> (boolean) > > > > > Indicates if Gateway API CRD management is enabled on your EKS Auto Mode cluster. If CRD management is enabled, EKS Auto Mode will create and update the Gateway API CRDs in your EKS Auto Mode cluster. JSON Syntax: ```json { "serviceIpv4Cidr": "string", "ipFamily": "ipv4"|"ipv6", "elasticLoadBalancing": { "enabled": true|false, "gatewayApi": { "crds": { "managed": true|false } } } } ``` `--logging` (structure) > Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren’t exported to CloudWatch Logs . For more information, see [Amazon EKS Cluster control plane logs](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) in the \* *Amazon EKS User Guide* \* . > #### NOTE > CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](http://aws.amazon.com/cloudwatch/pricing/) . > clusterLogging -> (list) > > The cluster control plane logging configuration for your cluster. > > (structure) > > > An object representing the enabled or disabled Kubernetes control plane logs for your cluster. > > > types -> (list) > > > > The available cluster control plane log types. > > > > (string) > > > > > Possible values: > > > > > * `api` > > > > > * `audit` > > > > > * `authenticator` > > > > > * `controllerManager` > > > > > * `scheduler` > > > enabled -> (boolean) > > > > If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs . If a log type isn’t enabled, that log type doesn’t export its control plane logs. Each individual log type can be enabled or disabled independently. JSON Syntax: ```json { "clusterLogging": [ { "types": ["api"|"audit"|"authenticator"|"controllerManager"|"scheduler", ...], "enabled": true|false } ... ] } ``` `--client-request-token` (string) > A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. `--tags` (map) > Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don’t propagate to any other cluster or Amazon Web Services resources. > Constraints: > * min: `1` > * max: `50` > key -> (string) > > One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values. > > Constraints: > > * min: `1` > > * max: `128` > value -> (string) > > The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key). > > Constraints: > > * max: `256` Shorthand Syntax: ``` KeyName1=string,KeyName2=string ``` JSON Syntax: ```json {"string": "string" ...} ``` `--encryption-config` (list) > The encryption configuration for the cluster. > Constraints: > * max: `1` > (structure) > > The encryption configuration for the cluster. > > resources -> (list) > > > #### WARNING > > > Amazon EKS encrypts all Kubernetes API data with envelope encryption by default for clusters running Kubernetes version 1.28 or higher, so this field no longer affects which resources are encrypted. > > > Specifies the resources to be encrypted. The only supported value is `secrets` . > > > (string) > > provider -> (structure) > > > Key Management Service (KMS) key. Either the ARN or the alias can be used. > > > keyArn -> (string) > > > > Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) must have access to the KMS key. For more information, see [Allowing users in other accounts to use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) in the *Key Management Service Developer Guide* . Shorthand Syntax: ``` resources=string,string,provider={keyArn=string} ... ``` JSON Syntax: ```json [ { "resources": ["string", ...], "provider": { "keyArn": "string" } } ... ] ``` `--outpost-config` (structure) > An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review [Local clusters for Amazon EKS on Amazon Web Services Outposts](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html) in the *Amazon EKS User Guide* . This object isn’t available for creating Amazon EKS clusters on the Amazon Web Services cloud. > outpostArns -> (list) [required] > > The ARN of the Outpost that you want to use for your local Amazon EKS cluster on Outposts. Only a single Outpost ARN is supported. > > (string) > controlPlaneInstanceType -> (string) [required] > > The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. This instance type applies to all control plane instances and cannot be changed after cluster creation. > > For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide* . > controlPlanePlacement -> (structure) > > An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide* . > > groupName -> (string) > > > The name of the placement group for the Kubernetes control plane instances. This setting can’t be changed after cluster creation. > > spreadLevel -> (string) > > > Optional parameter to specify the placement group spread level for control plane instances. If not provided, Amazon EKS will deploy control plane instances without a placement group. > > > Possible values: > > > * `host` > > > * `rack` > etcdInstanceType -> (string) > > The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. This instance type applies to all etcd instances and cannot be changed after cluster creation. > etcdPlacement -> (structure) > > An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide* . > > spreadLevel -> (string) > > > Optional parameter to specify the placement group spread level for etcd instances. If not provided, Amazon EKS will deploy etcd instances without a placement group. > > > Possible values: > > > * `host` > > > * `rack` Shorthand Syntax: ``` outpostArns=string,string,controlPlaneInstanceType=string,controlPlanePlacement={groupName=string,spreadLevel=string},etcdInstanceType=string,etcdPlacement={spreadLevel=string} ``` JSON Syntax: ```json { "outpostArns": ["string", ...], "controlPlaneInstanceType": "string", "controlPlanePlacement": { "groupName": "string", "spreadLevel": "host"|"rack" }, "etcdInstanceType": "string", "etcdPlacement": { "spreadLevel": "host"|"rack" } } ``` `--access-config` (structure) > The access configuration for the cluster. > bootstrapClusterCreatorAdminPermissions -> (boolean) > > Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time. The default value is `true` . > authenticationMode -> (string) > > The desired authentication mode for the cluster. If you create a cluster by using the EKS API, Amazon Web Services SDKs, or CloudFormation, the default is `CONFIG_MAP` . If you create the cluster by using the Amazon Web Services Management Console, the default value is `API_AND_CONFIG_MAP` . > > Possible values: > > * `API` > > * `API_AND_CONFIG_MAP` > > * `CONFIG_MAP` Shorthand Syntax: ``` bootstrapClusterCreatorAdminPermissions=boolean,authenticationMode=string ``` JSON Syntax: ```json { "bootstrapClusterCreatorAdminPermissions": true|false, "authenticationMode": "API"|"API_AND_CONFIG_MAP"|"CONFIG_MAP" } ``` `--bootstrap-self-managed-addons` | `--no-bootstrap-self-managed-addons` (boolean) > If you set this value to `False` when creating a cluster, the default networking add-ons will not be installed. > The default networking add-ons include `vpc-cni` , `coredns` , and `kube-proxy` . > Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons. `--upgrade-policy` (structure) > New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to `STANDARD` . > supportType -> (string) > > If the cluster is set to `EXTENDED` , it will enter extended support at the end of standard support. If the cluster is set to `STANDARD` , it will be automatically upgraded at the end of standard support. > > > [Learn more about EKS Extended Support in the \*Amazon EKS User Guide\* .](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html) > > Possible values: > > * `STANDARD` > > * `EXTENDED` Shorthand Syntax: ``` supportType=string ``` JSON Syntax: ```json { "supportType": "STANDARD"|"EXTENDED" } ``` `--zonal-shift-config` (structure) > Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. > Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary. > You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling *zonal autoshift* . This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see [Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS](https://docs.aws.amazon.com/eks/latest/userguide/zone-shift.html) in the \* *Amazon EKS User Guide* \* . > enabled -> (boolean) > > If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster. Shorthand Syntax: ``` enabled=boolean ``` JSON Syntax: ```json { "enabled": true|false } ``` `--remote-network-config` (structure) > The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. > remoteNodeNetworks -> (list) > > The list of network CIDRs that can contain hybrid nodes. > > These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > It must satisfy the following requirements: > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. > > * Each host must allow outbound connection to the EKS cluster control plane on TCP ports `443` and `10250` . > > * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. > > * Each host must allow TCP and UDP network connectivity to and from other hosts that are running `CoreDNS` on UDP port `53` for service and pod DNS names. > > Constraints: > > * max: `1` > > (structure) > > > A network CIDR that can contain hybrid nodes. > > > These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > It must satisfy the following requirements: > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. > > > * Each host must allow outbound connection to the EKS cluster control plane on TCP ports `443` and `10250` . > > > * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. > > > * Each host must allow TCP and UDP network connectivity to and from other hosts that are running `CoreDNS` on UDP port `53` for service and pod DNS names. > > > cidrs -> (list) > > > > A network CIDR that can contain hybrid nodes. > > > > These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. > > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > > It must satisfy the following requirements: > > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > > * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. > > > > * Each host must allow outbound connection to the EKS cluster control plane on TCP ports `443` and `10250` . > > > > * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. > > > > * Each host must allow TCP and UDP network connectivity to and from other hosts that are running `CoreDNS` on UDP port `53` for service and pod DNS names. > > > > (string) > remotePodNetworks -> (list) > > The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. > > These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn’t available for on-premises and edge locations. > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > It must satisfy the following requirements: > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > Constraints: > > * max: `1` > > (structure) > > > A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. > > > These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn’t available for on-premises and edge locations. > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > It must satisfy the following requirements: > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > cidrs -> (list) > > > > A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. > > > > These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn’t available for on-premises and edge locations. > > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > > It must satisfy the following requirements: > > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > > (string) JSON Syntax: ```json { "remoteNodeNetworks": [ { "cidrs": ["string", ...] } ... ], "remotePodNetworks": [ { "cidrs": ["string", ...] } ... ] } ``` `--compute-config` (structure) > Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account > enabled -> (boolean) > > Request to enable or disable the compute capability on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. > nodePools -> (list) > > Configuration for node pools that defines the compute resources for your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide* . > > (string) > nodeRoleArn -> (string) > > The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. This value cannot be changed after the compute capability of EKS Auto Mode is enabled. For more information, see the IAM Reference in the *Amazon EKS User Guide* . Shorthand Syntax: ``` enabled=boolean,nodePools=string,string,nodeRoleArn=string ``` JSON Syntax: ```json { "enabled": true|false, "nodePools": ["string", ...], "nodeRoleArn": "string" } ``` `--storage-config` (structure) > Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. > blockStorage -> (structure) > > Request to configure EBS Block Storage settings for your EKS Auto Mode cluster. > > enabled -> (boolean) > > > Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. Shorthand Syntax: ``` blockStorage={enabled=boolean} ``` JSON Syntax: ```json { "blockStorage": { "enabled": true|false } } ``` `--deletion-protection` | `--no-deletion-protection` (boolean) > Indicates whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. This helps prevent accidental cluster deletion. Default value is `false` . `--control-plane-scaling-config` (structure) > The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. > tier -> (string) > > The control plane scaling tier configuration. Available options are `standard` , `tier-xl` , `tier-2xl` , `tier-4xl, or tier-8xl` . For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. > > Possible values: > > * `standard` > > * `tier-xl` > > * `tier-2xl` > > * `tier-4xl` > > * `tier-8xl` Shorthand Syntax: ``` tier=string ``` JSON Syntax: ```json { "tier": "standard"|"tier-xl"|"tier-2xl"|"tier-4xl"|"tier-8xl" } ``` `--kube-api-server-config` (structure) > The Kubernetes API server configuration for the new cluster. > eventTtl -> (string) > > The duration that Kubernetes events are retained. Valid values are single-unit durations such as `30m` or `1h` . > serviceNodePortRange -> (structure) > > The port range for NodePort services. > > minPort -> (integer) > > > The minimum port number in the range. > > maxPort -> (integer) > > > The maximum port number in the range. Shorthand Syntax: ``` eventTtl=string,serviceNodePortRange={minPort=integer,maxPort=integer} ``` JSON Syntax: ```json { "eventTtl": "string", "serviceNodePortRange": { "minPort": integer, "maxPort": integer } } ``` `--kube-scheduler-config` (structure) > The Kubernetes scheduler configuration for the new cluster. > nodeResourcesFit -> (structure) > > The node resource fit scoring configuration for the scheduler. > > scoringStrategy -> (structure) > > > The scoring strategy used to rank nodes during scheduling. > > > type -> (string) > > > > The scoring strategy type. Valid values are `LeastAllocated` or `MostAllocated` . > > > > Possible values: > > > > * `LeastAllocated` > > > > * `MostAllocated` > > > resources -> (list) > > > > The resource weights used for scoring nodes. > > > > Constraints: > > > > * max: `100` > > > > (structure) > > > > > A resource weight entry for the scheduler scoring strategy. > > > > > name -> (string) > > > > > > The name of the resource (for example, `cpu` or `memory` ). > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `253` > > > > > weight -> (integer) > > > > > > The weight assigned to the resource for scoring. Must be between 1 and 100. > > > > > > Constraints: > > > > > > * min: `1` > > > > > > * max: `100` JSON Syntax: ```json { "nodeResourcesFit": { "scoringStrategy": { "type": "LeastAllocated"|"MostAllocated", "resources": [ { "name": "string", "weight": integer } ... ] } } } ``` `--kube-controller-manager-config` (structure) > The Kubernetes controller manager configuration for the new cluster. > podGcControllerConfig -> (structure) > > The pod garbage collection controller configuration. > > terminatedPodGcThreshold -> (integer) > > > The number of terminated pods that can exist before the garbage collector starts deleting them. > > > Constraints: > > > * min: `1` > > > * max: `1000000` > horizontalPodAutoscalerControllerConfig -> (structure) > > The horizontal pod autoscaler controller configuration. > > horizontalPodAutoscalerSyncPeriod -> (string) > > > The interval between each sync of the horizontal pod autoscaler. Valid values are single-unit durations such as `15s` or `1m` . Shorthand Syntax: ``` podGcControllerConfig={terminatedPodGcThreshold=integer},horizontalPodAutoscalerControllerConfig={horizontalPodAutoscalerSyncPeriod=string} ``` JSON Syntax: ```json { "podGcControllerConfig": { "terminatedPodGcThreshold": integer }, "horizontalPodAutoscalerControllerConfig": { "horizontalPodAutoscalerSyncPeriod": "string" } } ``` `--kubernetes-version` (string) > The desired Kubernetes version for your cluster. If you don’t specify a value here, the default version available in Amazon EKS is used. > #### NOTE > The default version might not be the latest version available. `--cli-input-json` | `--cli-input-yaml` (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`. `--generate-cli-skeleton` (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated. ## Global Options `--debug` (boolean) Turn on debug logging. `--endpoint-url` (string) Override command’s default URL with the given URL. `--no-verify-ssl` (boolean) By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates. `--no-paginate` (boolean) Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results. `--output` (string) The formatting style for command output. * json * text * table * yaml * yaml-stream * off `--query` (string) A JMESPath query to use in filtering the response data. `--profile` (string) Use a specific profile from your credential file. `--region` (string) The region to use. Overrides config/env settings. `--version` (string) Display the version of this tool. `--color` (string) Turn on/off color output. * on * off * auto `--no-sign-request` (boolean) Do not sign requests. Credentials will not be loaded if this argument is provided. `--ca-bundle` (string) The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings. `--cli-read-timeout` (int) The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds. `--cli-connect-timeout` (int) The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds. `--cli-binary-format` (string) The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`. * base64 * raw-in-base64-out `--no-cli-pager` (boolean) Disable cli pager for output. `--cli-auto-prompt` (boolean) Automatically prompt for CLI input parameters. `--no-cli-auto-prompt` (boolean) Disable automatically prompt for CLI input parameters. `--cli-error-format` (string) The formatting style for error output. By default, errors are displayed in enhanced format. * legacy * json * yaml * text * table * enhanced `--help` (boolean) Display help for the command/subcommand. ## Examples #### NOTE To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information. Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* . **Example 1: To create a new cluster** The following `create-cluster` example creates a cluster named `prod` in your default region. ```bash aws eks create-cluster \ --name prod \ --role-arn arn:aws:iam::123456789012:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI \ --resources-vpc-config subnetIds=subnet-6782e71e,subnet-e7e761ac,securityGroupIds=sg-6979fe18 ``` Output: ```json { "cluster": { "name": "prod", "arn": "arn:aws:eks:us-west-2:123456789012:cluster/prod", "createdAt": 1527808069.147, "version": "1.10", "roleArn": "arn:aws:iam::123456789012:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", "resourcesVpcConfig": { "subnetIds": [ "subnet-6782e71e", "subnet-e7e761ac" ], "securityGroupIds": [ "sg-6979fe18" ], "vpcId": "vpc-950809ec" }, "status": "CREATING", "certificateAuthority": {} } } ``` For more information, see [Create an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html) in the *Amazon EKS User Guide*. **Example 2: To create a new cluster with private endpoint access and logging enabled** The following `create-cluster` example creates a cluster named `example` in your default region with public endpoint access disabled, private endpoint access enabled, and all logging types enabled. ```bash aws eks create-cluster \ --name example \ --kubernetes-version 1.12 \ --role-arn arn:aws:iam::123456789012:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q \ --resources-vpc-config subnetIds=subnet-0a188dccd2f9a632f,subnet-09290d93da4278664,subnet-0f21dd86e0e91134a,subnet-0173dead68481a583,subnet-051f70a57ed6fcab6,subnet-01322339c5c7de9b4,securityGroupIds=sg-0c5b580845a031c10,endpointPublicAccess=false,endpointPrivateAccess=true \ --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' ``` Output: ```json { "cluster": { "name": "example", "arn": "arn:aws:eks:us-west-2:123456789012:cluster/example", "createdAt": 1565804921.901, "version": "1.12", "roleArn": "arn:aws:iam::123456789012:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q", "resourcesVpcConfig": { "subnetIds": [ "subnet-0a188dccd2f9a632f", "subnet-09290d93da4278664", "subnet-0f21dd86e0e91134a", "subnet-0173dead68481a583", "subnet-051f70a57ed6fcab6", "subnet-01322339c5c7de9b4" ], "securityGroupIds": [ "sg-0c5b580845a031c10" ], "vpcId": "vpc-0f622c01f68d4afec", "endpointPublicAccess": false, "endpointPrivateAccess": true }, "logging": { "clusterLogging": [ { "types": [ "api", "audit", "authenticator", "controllerManager", "scheduler" ], "enabled": true } ] }, "status": "CREATING", "certificateAuthority": {}, "platformVersion": "eks.3" } } ``` For more information, see [Create an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html) in the *Amazon EKS User Guide*. ## Output cluster -> (structure) > The full description of your new cluster. > name -> (string) > > The name of your cluster. > arn -> (string) > > The Amazon Resource Name (ARN) of the cluster. > createdAt -> (timestamp) > > The Unix epoch timestamp at object creation. > version -> (string) > > The Kubernetes server version for the cluster. > endpoint -> (string) > > The endpoint for your Kubernetes API server. > roleArn -> (string) > > The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. > resourcesVpcConfig -> (structure) > > The VPC configuration 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](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster security group considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the *Amazon EKS User Guide* . > > subnetIds -> (list) > > > The subnets associated with your cluster. > > > (string) > > securityGroupIds -> (list) > > > The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane. > > > (string) > > 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. > > vpcId -> (string) > > > The VPC associated with your cluster. > > endpointPublicAccess -> (boolean) > > > Whether the public API server endpoint is enabled. > > endpointPrivateAccess -> (boolean) > > > This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster’s VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that `publicAccessCidrs` includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see [Cluster API server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the \* *Amazon EKS User Guide* \* . > > publicAccessCidrs -> (list) > > > 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` and additionally `::/0` for dual-stack IPv6 clusters. If you’ve disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and Fargate `Pod` in the cluster. For more information, see [Cluster API server endpoint](https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html) in the \* *Amazon EKS User Guide* \* . > > > Note that the public endpoints are dual-stack for only `IPv6` clusters that are made after October 2024. You can’t add `IPv6` CIDR blocks to `IPv4` clusters or `IPv6` clusters that were made before October 2024. > > > (string) > > controlPlaneEgressMode -> (string) > > > The current control plane egress routing mode for the cluster. If the cluster is set to `AWS_MANAGED` , Amazon EKS manages the egress path from the control plane. If the cluster is set to `CUSTOMER_ROUTED` , you manage the egress path from the control plane in your VPC subnets. > > > > [Learn more about control plane egress routing in the \*Amazon EKS User Guide\* .](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-egress.html) > > > Possible values: > > > * `AWS_MANAGED` > > > * `CUSTOMER_ROUTED` > > > * `CUSTOMER_ISOLATED` > kubernetesNetworkConfig -> (structure) > > The Kubernetes network configuration for the cluster. > > serviceIpv4Cidr -> (string) > > > The CIDR block that Kubernetes `Pod` and `Service` object IP addresses are assigned from. Kubernetes assigns addresses from an `IPv4` CIDR block assigned to a subnet that the node is in. If you didn’t specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the `10.100.0.0/16` or `172.20.0.0/16` CIDR blocks. If this was specified, then it was specified when the cluster was created and it can’t be changed. > > serviceIpv6Cidr -> (string) > > > The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified `ipv6` for **ipFamily** when you created the cluster. 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. > > ipFamily -> (string) > > > The IP family used to assign Kubernetes `Pod` and `Service` objects IP addresses. The IP family is always `ipv4` , unless you have a `1.21` or later cluster running version `1.10.1` or later of the Amazon VPC CNI plugin for Kubernetes and specified `ipv6` when you created the cluster. > > > Possible values: > > > * `ipv4` > > > * `ipv6` > > elasticLoadBalancing -> (structure) > > > Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. > > > enabled -> (boolean) > > > > Indicates if the load balancing capability is enabled on your EKS Auto Mode cluster. If the load balancing capability is enabled, EKS Auto Mode will create and delete load balancers in your Amazon Web Services account. > > > gatewayApi -> (structure) > > > > Indicates the current configuration of the Kubernetes Gateway API for the load balancing capability on your EKS Auto Mode cluster. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide* . > > > > crds -> (structure) > > > > > Indicates the current configuration of Gateway API custom resource definition (CRD) management on your EKS Auto Mode cluster. For example, if CRD management is enabled or disabled. > > > > > managed -> (boolean) > > > > > > Indicates if Gateway API CRD management is enabled on your EKS Auto Mode cluster. If CRD management is enabled, EKS Auto Mode will create and update the Gateway API CRDs in your EKS Auto Mode cluster. > logging -> (structure) > > The logging configuration for your cluster. > > clusterLogging -> (list) > > > The cluster control plane logging configuration for your cluster. > > > (structure) > > > > An object representing the enabled or disabled Kubernetes control plane logs for your cluster. > > > > types -> (list) > > > > > The available cluster control plane log types. > > > > > (string) > > > > > > Possible values: > > > > > > * `api` > > > > > > * `audit` > > > > > > * `authenticator` > > > > > > * `controllerManager` > > > > > > * `scheduler` > > > > enabled -> (boolean) > > > > > If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs . If a log type isn’t enabled, that log type doesn’t export its control plane logs. Each individual log type can be enabled or disabled independently. > identity -> (structure) > > The identity provider information for the cluster. > > oidc -> (structure) > > > An object representing the [OpenID Connect](https://openid.net/connect/) identity provider information. > > > issuer -> (string) > > > > The issuer URL for the OIDC identity provider. > status -> (string) > > The current status of the cluster. > > Possible values: > > * `CREATING` > > * `ACTIVE` > > * `DELETING` > > * `FAILED` > > * `UPDATING` > > * `PENDING` > certificateAuthority -> (structure) > > The `certificate-authority-data` 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. > > active -> (structure) > > > An object identifying the certificate authority that is currently signing certificates for the cluster. > > > id -> (string) > > > > The unique identifier of the certificate authority that is currently signing certificates for the cluster. > > > activatedBy -> (string) > > > > The entity that activated the current signing certificate authority, either `CUSTOMER` or `EKS` . > > > > Possible values: > > > > * `EKS` > > > > * `CUSTOMER` > clientRequestToken -> (string) > > A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. > platformVersion -> (string) > > The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see [Platform versions](https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) in the \* *Amazon EKS User Guide* \* . For more information about local clusters deployed on an Outpost, see [Amazon EKS local cluster platform versions](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html) in the \* *Amazon EKS User Guide* \* . > tags -> (map) > > Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don’t propagate to any other cluster or Amazon Web Services resources. > > Constraints: > > * min: `1` > > * max: `50` > > key -> (string) > > > One part of a key-value pair that make up a tag. A `key` is a general label that acts like a category for more specific tag values. > > > Constraints: > > > * min: `1` > > > * max: `128` > > value -> (string) > > > The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key). > > > Constraints: > > > * max: `256` > encryptionConfig -> (list) > > The encryption configuration for the cluster. > > Constraints: > > * max: `1` > > (structure) > > > The encryption configuration for the cluster. > > > resources -> (list) > > > > #### WARNING > > > > Amazon EKS encrypts all Kubernetes API data with envelope encryption by default for clusters running Kubernetes version 1.28 or higher, so this field no longer affects which resources are encrypted. > > > > Specifies the resources to be encrypted. The only supported value is `secrets` . > > > > (string) > > > provider -> (structure) > > > > Key Management Service (KMS) key. Either the ARN or the alias can be used. > > > > keyArn -> (string) > > > > > Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) must have access to the KMS key. For more information, see [Allowing users in other accounts to use a KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html) in the *Key Management Service Developer Guide* . > connectorConfig -> (structure) > > The configuration used to connect to a cluster for registration. > > activationId -> (string) > > > A unique ID associated with the cluster for registration purposes. > > activationCode -> (string) > > > A unique code associated with the cluster for registration purposes. > > activationExpiry -> (timestamp) > > > The expiration time of the connected cluster. The cluster’s YAML file must be applied through the native provider. > > provider -> (string) > > > The cluster’s cloud service provider. > > roleArn -> (string) > > > The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster. > id -> (string) > > The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn’t available for an Amazon EKS cluster on the Amazon Web Services cloud. > health -> (structure) > > An object representing the health of your Amazon EKS cluster. > > issues -> (list) > > > An object representing the health issues of your Amazon EKS cluster. > > > (structure) > > > > An issue with your Amazon EKS cluster. > > > > code -> (string) > > > > > The error code of the issue. > > > > > Possible values: > > > > > * `AccessDenied` > > > > > * `ClusterUnreachable` > > > > > * `ConfigurationConflict` > > > > > * `InternalFailure` > > > > > * `ResourceLimitExceeded` > > > > > * `ResourceNotFound` > > > > > * `IamRoleNotFound` > > > > > * `VpcNotFound` > > > > > * `InsufficientFreeAddresses` > > > > > * `Ec2ServiceNotSubscribed` > > > > > * `Ec2SubnetNotFound` > > > > > * `Ec2SecurityGroupNotFound` > > > > > * `KmsGrantRevoked` > > > > > * `KmsKeyNotFound` > > > > > * `KmsKeyMarkedForDeletion` > > > > > * `KmsKeyDisabled` > > > > > * `StsRegionalEndpointDisabled` > > > > > * `UnsupportedVersion` > > > > > * `Other` > > > > message -> (string) > > > > > A description of the issue. > > > > resourceIds -> (list) > > > > > The resource IDs that the issue relates to. > > > > > (string) > outpostConfig -> (structure) > > An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn’t available for clusters on the Amazon Web Services cloud. > > outpostArns -> (list) [required] > > > The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts. > > > (string) > > controlPlaneInstanceType -> (string) [required] > > > The Amazon EC2 instance type for the Kubernetes control plane instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all control plane instances. > > controlPlanePlacement -> (structure) > > > An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide* . > > > groupName -> (string) > > > > The name of the placement group for the Kubernetes control plane instances. > > > spreadLevel -> (string) > > > > The spread level used with the placement group for control plane instances on your local Amazon EKS cluster on Amazon Web Services Outposts. > > > > Possible values: > > > > * `host` > > > > * `rack` > > etcdInstanceType -> (string) > > > The Amazon EC2 instance type for etcd instances of your local Amazon EKS cluster on Amazon Web Services Outposts. The instance type is the same for all etcd instances. > > etcdPlacement -> (structure) > > > An object representing the placement configuration for the etcd instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see [Capacity considerations](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html) in the *Amazon EKS User Guide* . > > > spreadLevel -> (string) > > > > The spread level used with the placement group for etcd instances on your local Amazon EKS cluster on Amazon Web Services Outposts. > > > > Possible values: > > > > * `host` > > > > * `rack` > accessConfig -> (structure) > > The access configuration for the cluster. > > bootstrapClusterCreatorAdminPermissions -> (boolean) > > > Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time. > > authenticationMode -> (string) > > > The current authentication mode of the cluster. > > > Possible values: > > > * `API` > > > * `API_AND_CONFIG_MAP` > > > * `CONFIG_MAP` > upgradePolicy -> (structure) > > 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\* .](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html) > > supportType -> (string) > > > If the cluster is set to `EXTENDED` , it will enter extended support at the end of standard support. If the cluster is set to `STANDARD` , it will be automatically upgraded at the end of standard support. > > > > [Learn more about EKS Extended Support in the \*Amazon EKS User Guide\* .](https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html) > > > Possible values: > > > * `STANDARD` > > > * `EXTENDED` > zonalShiftConfig -> (structure) > > The configuration for zonal shift for the cluster. > > enabled -> (boolean) > > > Whether the zonal shift is enabled. > remoteNetworkConfig -> (structure) > > The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created. > > remoteNodeNetworks -> (list) > > > The list of network CIDRs that can contain hybrid nodes. > > > Constraints: > > > * max: `1` > > > (structure) > > > > A network CIDR that can contain hybrid nodes. > > > > These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. > > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > > It must satisfy the following requirements: > > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > > * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. > > > > * Each host must allow outbound connection to the EKS cluster control plane on TCP ports `443` and `10250` . > > > > * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. > > > > * Each host must allow TCP and UDP network connectivity to and from other hosts that are running `CoreDNS` on UDP port `53` for service and pod DNS names. > > > > cidrs -> (list) > > > > > A network CIDR that can contain hybrid nodes. > > > > > These CIDR blocks define the expected IP address range of the hybrid nodes that join the cluster. These blocks are typically determined by your network administrator. > > > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > > > It must satisfy the following requirements: > > > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > > > * Each block must have a route to the VPC that uses the VPC CIDR blocks, not public IPs or Elastic IPs. There are many options including Transit Gateway, Site-to-Site VPN, or Direct Connect. > > > > > * Each host must allow outbound connection to the EKS cluster control plane on TCP ports `443` and `10250` . > > > > > * Each host must allow inbound connection from the EKS cluster control plane on TCP port 10250 for logs, exec and port-forward operations. > > > > > * Each host must allow TCP and UDP network connectivity to and from other hosts that are running `CoreDNS` on UDP port `53` for service and pod DNS names. > > > > > (string) > > remotePodNetworks -> (list) > > > The list of network CIDRs that can contain pods that run Kubernetes webhooks on hybrid nodes. > > > Constraints: > > > * max: `1` > > > (structure) > > > > A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. > > > > These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn’t available for on-premises and edge locations. > > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > > It must satisfy the following requirements: > > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > > cidrs -> (list) > > > > > A network CIDR that can contain pods that run Kubernetes webhooks on hybrid nodes. > > > > > These CIDR blocks are determined by configuring your Container Network Interface (CNI) plugin. We recommend the Calico CNI or Cilium CNI. Note that the Amazon VPC CNI plugin for Kubernetes isn’t available for on-premises and edge locations. > > > > > Enter one or more IPv4 CIDR blocks in decimal dotted-quad notation (for example, `10.2.0.0/16` ). > > > > > It must satisfy the following requirements: > > > > > * Each block must be within an `IPv4` RFC-1918 network range. Minimum allowed size is /32, maximum allowed size is /8. Publicly-routable addresses aren’t supported. > > > > > * Each block cannot overlap with the range of the VPC CIDR blocks for your EKS resources, or the block of the Kubernetes service IP range. > > > > > (string) > computeConfig -> (structure) > > 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 Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the *Amazon EKS User Guide* . > > enabled -> (boolean) > > > Indicates if the compute capability is enabled on your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. > > nodePools -> (list) > > > Indicates the current configuration of node pools in your EKS Auto Mode cluster. For more information, see EKS Auto Mode Node Pools in the *Amazon EKS User Guide* . > > > (string) > > nodeRoleArn -> (string) > > > The ARN of the IAM Role EKS will assign to EC2 Managed Instances in your EKS Auto Mode cluster. > storageConfig -> (structure) > > 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 Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide* . > > blockStorage -> (structure) > > > Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. > > > enabled -> (boolean) > > > > Indicates if the block storage capability is enabled on your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. > deletionProtection -> (boolean) > > The current deletion protection setting for the cluster. When `true` , deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When `false` , the cluster can be deleted normally. This setting only applies to clusters in an active state. > controlPlaneScalingConfig -> (structure) > > The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. > > tier -> (string) > > > The control plane scaling tier configuration. Available options are `standard` , `tier-xl` , `tier-2xl` , `tier-4xl, or tier-8xl` . For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide. > > > Possible values: > > > * `standard` > > > * `tier-xl` > > > * `tier-2xl` > > > * `tier-4xl` > > > * `tier-8xl` > kubeApiServerConfig -> (structure) > > The Kubernetes API server configuration for the cluster. > > eventTtl -> (string) > > > The duration that Kubernetes events are retained. > > serviceNodePortRange -> (structure) > > > The port range for NodePort services. > > > minPort -> (integer) > > > > The minimum port number in the range. > > > maxPort -> (integer) > > > > The maximum port number in the range. > kubeSchedulerConfig -> (structure) > > The Kubernetes scheduler configuration for the cluster. > > nodeResourcesFit -> (structure) > > > The node resource fit scoring configuration for the scheduler. > > > scoringStrategy -> (structure) > > > > The scoring strategy used to rank nodes during scheduling. > > > > type -> (string) > > > > > The scoring strategy type. Valid values are `LeastAllocated` or `MostAllocated` . > > > > > Possible values: > > > > > * `LeastAllocated` > > > > > * `MostAllocated` > > > > resources -> (list) > > > > > The resource weights used for scoring nodes. > > > > > Constraints: > > > > > * max: `100` > > > > > (structure) > > > > > > A resource weight entry for the scheduler scoring strategy. > > > > > > name -> (string) > > > > > > > The name of the resource (for example, `cpu` or `memory` ). > > > > > > > Constraints: > > > > > > > * min: `1` > > > > > > > * max: `253` > > > > > > weight -> (integer) > > > > > > > The weight assigned to the resource for scoring. Must be between 1 and 100. > > > > > > > Constraints: > > > > > > > * min: `1` > > > > > > > * max: `100` > kubeControllerManagerConfig -> (structure) > > The Kubernetes controller manager configuration for the cluster. > > podGcControllerConfig -> (structure) > > > The pod garbage collection controller configuration. > > > terminatedPodGcThreshold -> (integer) > > > > The number of terminated pods that can exist before the garbage collector starts deleting them. > > > > Constraints: > > > > * min: `1` > > > > * max: `1000000` > > horizontalPodAutoscalerControllerConfig -> (structure) > > > The horizontal pod autoscaler controller configuration. > > > horizontalPodAutoscalerSyncPeriod -> (string) > > > > The interval between each sync of the horizontal pod autoscaler.