This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::EKS::Cluster
<a name="aws-resource-eks-cluster"></a>

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 AWS, 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 AWS 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](https://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*.

## Syntax
<a name="aws-resource-eks-cluster-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-eks-cluster-syntax.json"></a>

```
{
  "Type" : "AWS::EKS::Cluster",
  "Properties" : {
      "[AccessConfig](#cfn-eks-cluster-accessconfig)" : AccessConfig,
      "[BootstrapSelfManagedAddons](#cfn-eks-cluster-bootstrapselfmanagedaddons)" : Boolean,
      "[ComputeConfig](#cfn-eks-cluster-computeconfig)" : ComputeConfig,
      "[ControlPlaneScalingConfig](#cfn-eks-cluster-controlplanescalingconfig)" : ControlPlaneScalingConfig,
      "[DeletionProtection](#cfn-eks-cluster-deletionprotection)" : Boolean,
      "[EncryptionConfig](#cfn-eks-cluster-encryptionconfig)" : [ EncryptionConfig, ... ],
      "[Force](#cfn-eks-cluster-force)" : Boolean,
      "[KubernetesNetworkConfig](#cfn-eks-cluster-kubernetesnetworkconfig)" : KubernetesNetworkConfig,
      "[Logging](#cfn-eks-cluster-logging)" : Logging,
      "[Name](#cfn-eks-cluster-name)" : String,
      "[OutpostConfig](#cfn-eks-cluster-outpostconfig)" : OutpostConfig,
      "[RemoteNetworkConfig](#cfn-eks-cluster-remotenetworkconfig)" : RemoteNetworkConfig,
      "[ResourcesVpcConfig](#cfn-eks-cluster-resourcesvpcconfig)" : ResourcesVpcConfig,
      "[RoleArn](#cfn-eks-cluster-rolearn)" : String,
      "[StorageConfig](#cfn-eks-cluster-storageconfig)" : StorageConfig,
      "[Tags](#cfn-eks-cluster-tags)" : [ Tag, ... ],
      "[UpgradePolicy](#cfn-eks-cluster-upgradepolicy)" : UpgradePolicy,
      "[Version](#cfn-eks-cluster-version)" : String,
      "[ZonalShiftConfig](#cfn-eks-cluster-zonalshiftconfig)" : ZonalShiftConfig
    }
}
```

### YAML
<a name="aws-resource-eks-cluster-syntax.yaml"></a>

```
Type: AWS::EKS::Cluster
Properties:
  [AccessConfig](#cfn-eks-cluster-accessconfig): 
    AccessConfig
  [BootstrapSelfManagedAddons](#cfn-eks-cluster-bootstrapselfmanagedaddons): Boolean
  [ComputeConfig](#cfn-eks-cluster-computeconfig): 
    ComputeConfig
  [ControlPlaneScalingConfig](#cfn-eks-cluster-controlplanescalingconfig): 
    ControlPlaneScalingConfig
  [DeletionProtection](#cfn-eks-cluster-deletionprotection): Boolean
  [EncryptionConfig](#cfn-eks-cluster-encryptionconfig): 
    - EncryptionConfig
  [Force](#cfn-eks-cluster-force): Boolean
  [KubernetesNetworkConfig](#cfn-eks-cluster-kubernetesnetworkconfig): 
    KubernetesNetworkConfig
  [Logging](#cfn-eks-cluster-logging): 
    Logging
  [Name](#cfn-eks-cluster-name): String
  [OutpostConfig](#cfn-eks-cluster-outpostconfig): 
    OutpostConfig
  [RemoteNetworkConfig](#cfn-eks-cluster-remotenetworkconfig): 
    RemoteNetworkConfig
  [ResourcesVpcConfig](#cfn-eks-cluster-resourcesvpcconfig): 
    ResourcesVpcConfig
  [RoleArn](#cfn-eks-cluster-rolearn): String
  [StorageConfig](#cfn-eks-cluster-storageconfig): 
    StorageConfig
  [Tags](#cfn-eks-cluster-tags): 
    - Tag
  [UpgradePolicy](#cfn-eks-cluster-upgradepolicy): 
    UpgradePolicy
  [Version](#cfn-eks-cluster-version): String
  [ZonalShiftConfig](#cfn-eks-cluster-zonalshiftconfig): 
    ZonalShiftConfig
```

## Properties
<a name="aws-resource-eks-cluster-properties"></a>

`AccessConfig`  <a name="cfn-eks-cluster-accessconfig"></a>
The access configuration for the cluster.  
*Required*: No  
*Type*: [AccessConfig](aws-properties-eks-cluster-accessconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BootstrapSelfManagedAddons`  <a name="cfn-eks-cluster-bootstrapselfmanagedaddons"></a>
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.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ComputeConfig`  <a name="cfn-eks-cluster-computeconfig"></a>
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*.  
*Required*: No  
*Type*: [ComputeConfig](aws-properties-eks-cluster-computeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ControlPlaneScalingConfig`  <a name="cfn-eks-cluster-controlplanescalingconfig"></a>
The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.  
*Required*: No  
*Type*: [ControlPlaneScalingConfig](aws-properties-eks-cluster-controlplanescalingconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeletionProtection`  <a name="cfn-eks-cluster-deletionprotection"></a>
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.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionConfig`  <a name="cfn-eks-cluster-encryptionconfig"></a>
The encryption configuration for the cluster.  
*Required*: No  
*Type*: [Array](aws-properties-eks-cluster-encryptionconfig.md) of [EncryptionConfig](aws-properties-eks-cluster-encryptionconfig.md)  
*Maximum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Force`  <a name="cfn-eks-cluster-force"></a>
Set this value to `true` to override upgrade-blocking readiness checks when updating a cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KubernetesNetworkConfig`  <a name="cfn-eks-cluster-kubernetesnetworkconfig"></a>
The Kubernetes network configuration for the cluster.  
*Required*: No  
*Type*: [KubernetesNetworkConfig](aws-properties-eks-cluster-kubernetesnetworkconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Logging`  <a name="cfn-eks-cluster-logging"></a>
The logging configuration for your cluster.  
*Required*: No  
*Type*: [Logging](aws-properties-eks-cluster-logging.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-eks-cluster-name"></a>
The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the AWS Region and AWS account that you're creating the cluster in. Note that underscores can't be used in CloudFormation.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\-_]*`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OutpostConfig`  <a name="cfn-eks-cluster-outpostconfig"></a>
An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This object isn't available for clusters on the AWS cloud.  
*Required*: No  
*Type*: [OutpostConfig](aws-properties-eks-cluster-outpostconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RemoteNetworkConfig`  <a name="cfn-eks-cluster-remotenetworkconfig"></a>
The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.  
*Required*: No  
*Type*: [RemoteNetworkConfig](aws-properties-eks-cluster-remotenetworkconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourcesVpcConfig`  <a name="cfn-eks-cluster-resourcesvpcconfig"></a>
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, but we recommend that you use a dedicated security group for your cluster control plane.  
*Required*: Yes  
*Type*: [ResourcesVpcConfig](aws-properties-eks-cluster-resourcesvpcconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-eks-cluster-rolearn"></a>
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. 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* *.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageConfig`  <a name="cfn-eks-cluster-storageconfig"></a>
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*.  
*Required*: No  
*Type*: [StorageConfig](aws-properties-eks-cluster-storageconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-eks-cluster-tags"></a>
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags don't propagate to any other resources associated with the cluster.  
You must have the `eks:TagResource` and `eks:UntagResource` permissions for your [IAM principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html) to manage the CloudFormation stack. If you don't have these permissions, there might be unexpected behavior with stack-level tags propagating to the resource during resource creation and update.
*Required*: No  
*Type*: Array of [Tag](aws-properties-eks-cluster-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UpgradePolicy`  <a name="cfn-eks-cluster-upgradepolicy"></a>
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)   
*Required*: No  
*Type*: [UpgradePolicy](aws-properties-eks-cluster-upgradepolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Version`  <a name="cfn-eks-cluster-version"></a>
The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.  
The default version might not be the latest version available.
*Required*: No  
*Type*: String  
*Pattern*: `1\.\d\d`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ZonalShiftConfig`  <a name="cfn-eks-cluster-zonalshiftconfig"></a>
The configuration for zonal shift for the cluster.  
*Required*: No  
*Type*: [ZonalShiftConfig](aws-properties-eks-cluster-zonalshiftconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-eks-cluster-return-values"></a>

### Ref
<a name="aws-resource-eks-cluster-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name. For example:

 `{ "Ref": "myCluster" }` 

For the Amazon EKS cluster `myCluster`, `Ref` returns the name of the cluster.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-eks-cluster-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-eks-cluster-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the cluster, such as `arn:aws:eks:us-west-2:666666666666:cluster/prod`.

`CertificateAuthorityData`  <a name="CertificateAuthorityData-fn::getatt"></a>
The `certificate-authority-data` for your cluster.

`ClusterSecurityGroupId`  <a name="ClusterSecurityGroupId-fn::getatt"></a>
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.  
This parameter is only returned by Amazon EKS clusters that support managed node groups. For more information, see [Managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html) in the *Amazon EKS User Guide*. 

`EncryptionConfigKeyArn`  <a name="EncryptionConfigKeyArn-fn::getatt"></a>
Amazon Resource Name (ARN) or alias of the customer master key (CMK).

`Endpoint`  <a name="Endpoint-fn::getatt"></a>
The endpoint for your Kubernetes API server, such as `https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com`.

`Id`  <a name="Id-fn::getatt"></a>
The ID of your local Amazon EKS cluster on an AWS Outpost. This property isn't available for an Amazon EKS cluster on the AWS cloud.

`KubernetesNetworkConfig.ServiceIpv6Cidr`  <a name="KubernetesNetworkConfig.ServiceIpv6Cidr-fn::getatt"></a>
The CIDR block that Kubernetes 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.

`OpenIdConnectIssuerUrl`  <a name="OpenIdConnectIssuerUrl-fn::getatt"></a>
The issuer URL for the OIDC identity provider of the cluster, 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.  
 `!Select [1, !Split ["//", !GetAtt EKSCluster.OpenIdConnectIssuerUrl]]` 

## Examples
<a name="aws-resource-eks-cluster--examples"></a>

### Create a cluster
<a name="aws-resource-eks-cluster--examples--Create_a_cluster"></a>

The following example creates an Amazon EKS cluster named `Prod`.

#### JSON
<a name="aws-resource-eks-cluster--examples--Create_a_cluster--json"></a>

```
{
    "EKSCluster": {
       "Type": "AWS::EKS::Cluster",
       "Properties": {
          "Name": "Prod",
          "Version": "1.20",
          "RoleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-EXAMPLEBQ4PI",
          "ResourcesVpcConfig": {
             "SecurityGroupIds": [
                "sg-6979fe18"
             ],
             "SubnetIds": [
                "subnet-6782e71e",
                "subnet-e7e761ac"
             ],
             "EndpointPublicAccess": false,
             "EndpointPrivateAccess": true,
             "PublicAccessCidrs": [
                "1.1.1.2/32"
             ]
          },
          "Logging": {
             "ClusterLogging": {
                "EnabledTypes": [
                   {
                      "Type": "api"
                   },
                   {
                      "Type": "audit"
                   }
                ]
             }
          },
          "Tags": [
             {
                "Key": "key",
                "Value": "val"
             }
          ]
       }
    }
 }
```

#### YAML
<a name="aws-resource-eks-cluster--examples--Create_a_cluster--yaml"></a>

```
EKSCluster:
    Type: AWS::EKS::Cluster
    Properties:
      Name: Prod
      Version: "1.20"
      RoleArn: "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-EXAMPLEBQ4PI"
      ResourcesVpcConfig:
        SecurityGroupIds:
          - sg-6979fe18
        SubnetIds:
          - subnet-6782e71e
          - subnet-e7e761ac
        EndpointPublicAccess: false
        EndpointPrivateAccess: true
        PublicAccessCidrs: [ "1.1.1.2/32" ]
      Logging:
        ClusterLogging:
          EnabledTypes:
            - Type: api
            - Type: audit
      Tags:
        - Key: "key"
          Value: "val"
```

## See also
<a name="aws-resource-eks-cluster--seealso"></a>
+ [Clusters](https://docs.aws.amazon.com/eks/latest/userguide/clusters.html) in the *Amazon EKS User Guide*.
+ [https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateCluster.html) in the *Amazon EKS API Reference*.

# AWS::EKS::Cluster AccessConfig
<a name="aws-properties-eks-cluster-accessconfig"></a>

The access configuration for the cluster.

## Syntax
<a name="aws-properties-eks-cluster-accessconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-accessconfig-syntax.json"></a>

```
{
  "[AuthenticationMode](#cfn-eks-cluster-accessconfig-authenticationmode)" : String,
  "[BootstrapClusterCreatorAdminPermissions](#cfn-eks-cluster-accessconfig-bootstrapclustercreatoradminpermissions)" : Boolean
}
```

### YAML
<a name="aws-properties-eks-cluster-accessconfig-syntax.yaml"></a>

```
  [AuthenticationMode](#cfn-eks-cluster-accessconfig-authenticationmode): String
  [BootstrapClusterCreatorAdminPermissions](#cfn-eks-cluster-accessconfig-bootstrapclustercreatoradminpermissions): Boolean
```

## Properties
<a name="aws-properties-eks-cluster-accessconfig-properties"></a>

`AuthenticationMode`  <a name="cfn-eks-cluster-accessconfig-authenticationmode"></a>
The desired authentication mode for the cluster. If you create a cluster by using the EKS API, AWS SDKs, or AWS CloudFormation, the default is `CONFIG_MAP`. If you create the cluster by using the AWS Management Console, the default value is `API_AND_CONFIG_MAP`.  
*Required*: No  
*Type*: String  
*Allowed values*: `CONFIG_MAP | API_AND_CONFIG_MAP | API`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BootstrapClusterCreatorAdminPermissions`  <a name="cfn-eks-cluster-accessconfig-bootstrapclustercreatoradminpermissions"></a>
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`.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EKS::Cluster BlockStorage
<a name="aws-properties-eks-cluster-blockstorage"></a>

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

## Syntax
<a name="aws-properties-eks-cluster-blockstorage-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-blockstorage-syntax.json"></a>

```
{
  "[Enabled](#cfn-eks-cluster-blockstorage-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-eks-cluster-blockstorage-syntax.yaml"></a>

```
  [Enabled](#cfn-eks-cluster-blockstorage-enabled): Boolean
```

## Properties
<a name="aws-properties-eks-cluster-blockstorage-properties"></a>

`Enabled`  <a name="cfn-eks-cluster-blockstorage-enabled"></a>
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 AWS account.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster ClusterLogging
<a name="aws-properties-eks-cluster-clusterlogging"></a>

The cluster control plane logging configuration for your cluster.

**Important**  
When updating a resource, you must include this `ClusterLogging` property if the previous CloudFormation template of the resource had it.

## Syntax
<a name="aws-properties-eks-cluster-clusterlogging-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-clusterlogging-syntax.json"></a>

```
{
  "[EnabledTypes](#cfn-eks-cluster-clusterlogging-enabledtypes)" : [ LoggingTypeConfig, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-clusterlogging-syntax.yaml"></a>

```
  [EnabledTypes](#cfn-eks-cluster-clusterlogging-enabledtypes): 
    - LoggingTypeConfig
```

## Properties
<a name="aws-properties-eks-cluster-clusterlogging-properties"></a>

`EnabledTypes`  <a name="cfn-eks-cluster-clusterlogging-enabledtypes"></a>
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.
*Required*: No  
*Type*: Array of [LoggingTypeConfig](aws-properties-eks-cluster-loggingtypeconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster ComputeConfig
<a name="aws-properties-eks-cluster-computeconfig"></a>

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

## Syntax
<a name="aws-properties-eks-cluster-computeconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-computeconfig-syntax.json"></a>

```
{
  "[Enabled](#cfn-eks-cluster-computeconfig-enabled)" : Boolean,
  "[NodePools](#cfn-eks-cluster-computeconfig-nodepools)" : [ String, ... ],
  "[NodeRoleArn](#cfn-eks-cluster-computeconfig-noderolearn)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-computeconfig-syntax.yaml"></a>

```
  [Enabled](#cfn-eks-cluster-computeconfig-enabled): Boolean
  [NodePools](#cfn-eks-cluster-computeconfig-nodepools): 
    - String
  [NodeRoleArn](#cfn-eks-cluster-computeconfig-noderolearn): String
```

## Properties
<a name="aws-properties-eks-cluster-computeconfig-properties"></a>

`Enabled`  <a name="cfn-eks-cluster-computeconfig-enabled"></a>
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 AWS account.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NodePools`  <a name="cfn-eks-cluster-computeconfig-nodepools"></a>
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*.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NodeRoleArn`  <a name="cfn-eks-cluster-computeconfig-noderolearn"></a>
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*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster ControlPlanePlacement
<a name="aws-properties-eks-cluster-controlplaneplacement"></a>

The placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS 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*.

## Syntax
<a name="aws-properties-eks-cluster-controlplaneplacement-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-controlplaneplacement-syntax.json"></a>

```
{
  "[GroupName](#cfn-eks-cluster-controlplaneplacement-groupname)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-controlplaneplacement-syntax.yaml"></a>

```
  [GroupName](#cfn-eks-cluster-controlplaneplacement-groupname): String
```

## Properties
<a name="aws-properties-eks-cluster-controlplaneplacement-properties"></a>

`GroupName`  <a name="cfn-eks-cluster-controlplaneplacement-groupname"></a>
The name of the placement group for the Kubernetes control plane instances. This property is only used for a local cluster on an AWS Outpost.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EKS::Cluster ControlPlaneScalingConfig
<a name="aws-properties-eks-cluster-controlplanescalingconfig"></a>

The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.

## Syntax
<a name="aws-properties-eks-cluster-controlplanescalingconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-controlplanescalingconfig-syntax.json"></a>

```
{
  "[Tier](#cfn-eks-cluster-controlplanescalingconfig-tier)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-controlplanescalingconfig-syntax.yaml"></a>

```
  [Tier](#cfn-eks-cluster-controlplanescalingconfig-tier): String
```

## Properties
<a name="aws-properties-eks-cluster-controlplanescalingconfig-properties"></a>

`Tier`  <a name="cfn-eks-cluster-controlplanescalingconfig-tier"></a>
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.  
*Required*: No  
*Type*: String  
*Allowed values*: `standard | tier-xl | tier-2xl | tier-4xl | tier-8xl | tier-ultra`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster ElasticLoadBalancing
<a name="aws-properties-eks-cluster-elasticloadbalancing"></a>

Indicates the current configuration of the load balancing capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. For more information, see EKS Auto Mode load balancing capability in the *Amazon EKS User Guide*.

## Syntax
<a name="aws-properties-eks-cluster-elasticloadbalancing-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-elasticloadbalancing-syntax.json"></a>

```
{
  "[Enabled](#cfn-eks-cluster-elasticloadbalancing-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-eks-cluster-elasticloadbalancing-syntax.yaml"></a>

```
  [Enabled](#cfn-eks-cluster-elasticloadbalancing-enabled): Boolean
```

## Properties
<a name="aws-properties-eks-cluster-elasticloadbalancing-properties"></a>

`Enabled`  <a name="cfn-eks-cluster-elasticloadbalancing-enabled"></a>
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 AWS account.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster EncryptionConfig
<a name="aws-properties-eks-cluster-encryptionconfig"></a>

The encryption configuration for the cluster.

## Syntax
<a name="aws-properties-eks-cluster-encryptionconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-encryptionconfig-syntax.json"></a>

```
{
  "[Provider](#cfn-eks-cluster-encryptionconfig-provider)" : Provider,
  "[Resources](#cfn-eks-cluster-encryptionconfig-resources)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-encryptionconfig-syntax.yaml"></a>

```
  [Provider](#cfn-eks-cluster-encryptionconfig-provider): 
    Provider
  [Resources](#cfn-eks-cluster-encryptionconfig-resources): 
    - String
```

## Properties
<a name="aws-properties-eks-cluster-encryptionconfig-properties"></a>

`Provider`  <a name="cfn-eks-cluster-encryptionconfig-provider"></a>
The encryption provider for the cluster.  
*Required*: No  
*Type*: [Provider](aws-properties-eks-cluster-provider.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Resources`  <a name="cfn-eks-cluster-encryptionconfig-resources"></a>
Specifies the resources to be encrypted. The only supported value is `secrets`.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EKS::Cluster KubernetesNetworkConfig
<a name="aws-properties-eks-cluster-kubernetesnetworkconfig"></a>

The Kubernetes network configuration for the cluster.

## Syntax
<a name="aws-properties-eks-cluster-kubernetesnetworkconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-kubernetesnetworkconfig-syntax.json"></a>

```
{
  "[ElasticLoadBalancing](#cfn-eks-cluster-kubernetesnetworkconfig-elasticloadbalancing)" : ElasticLoadBalancing,
  "[IpFamily](#cfn-eks-cluster-kubernetesnetworkconfig-ipfamily)" : String,
  "[ServiceIpv4Cidr](#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv4cidr)" : String,
  "[ServiceIpv6Cidr](#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv6cidr)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-kubernetesnetworkconfig-syntax.yaml"></a>

```
  [ElasticLoadBalancing](#cfn-eks-cluster-kubernetesnetworkconfig-elasticloadbalancing): 
    ElasticLoadBalancing
  [IpFamily](#cfn-eks-cluster-kubernetesnetworkconfig-ipfamily): String
  [ServiceIpv4Cidr](#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv4cidr): String
  [ServiceIpv6Cidr](#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv6cidr): String
```

## Properties
<a name="aws-properties-eks-cluster-kubernetesnetworkconfig-properties"></a>

`ElasticLoadBalancing`  <a name="cfn-eks-cluster-kubernetesnetworkconfig-elasticloadbalancing"></a>
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*.  
*Required*: No  
*Type*: [ElasticLoadBalancing](aws-properties-eks-cluster-elasticloadbalancing.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IpFamily`  <a name="cfn-eks-cluster-kubernetesnetworkconfig-ipfamily"></a>
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.  
*Required*: No  
*Type*: String  
*Allowed values*: `ipv4 | ipv6`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ServiceIpv4Cidr`  <a name="cfn-eks-cluster-kubernetesnetworkconfig-serviceipv4cidr"></a>
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`.
You can only specify a custom CIDR block when you create a cluster. You can't change this value after the cluster is created.
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ServiceIpv6Cidr`  <a name="cfn-eks-cluster-kubernetesnetworkconfig-serviceipv6cidr"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster Logging
<a name="aws-properties-eks-cluster-logging"></a>

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

**Important**  
When updating a resource, you must include this `Logging` property if the previous CloudFormation template of the resource had it.

**Note**  
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing](https://aws.amazon.com/cloudwatch/pricing/).

## Syntax
<a name="aws-properties-eks-cluster-logging-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-logging-syntax.json"></a>

```
{
  "[ClusterLogging](#cfn-eks-cluster-logging-clusterlogging)" : ClusterLogging
}
```

### YAML
<a name="aws-properties-eks-cluster-logging-syntax.yaml"></a>

```
  [ClusterLogging](#cfn-eks-cluster-logging-clusterlogging): 
    ClusterLogging
```

## Properties
<a name="aws-properties-eks-cluster-logging-properties"></a>

`ClusterLogging`  <a name="cfn-eks-cluster-logging-clusterlogging"></a>
The cluster control plane logging configuration for your cluster.  
*Required*: No  
*Type*: [ClusterLogging](aws-properties-eks-cluster-clusterlogging.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster LoggingTypeConfig
<a name="aws-properties-eks-cluster-loggingtypeconfig"></a>

The enabled logging type. For a list of the valid logging types, see the [`types` property of `LogSetup`](https://docs.aws.amazon.com/eks/latest/APIReference/API_LogSetup.html#AmazonEKS-Type-LogSetup-types) in the *Amazon EKS API Reference*.

## Syntax
<a name="aws-properties-eks-cluster-loggingtypeconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-loggingtypeconfig-syntax.json"></a>

```
{
  "[Type](#cfn-eks-cluster-loggingtypeconfig-type)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-loggingtypeconfig-syntax.yaml"></a>

```
  [Type](#cfn-eks-cluster-loggingtypeconfig-type): String
```

## Properties
<a name="aws-properties-eks-cluster-loggingtypeconfig-properties"></a>

`Type`  <a name="cfn-eks-cluster-loggingtypeconfig-type"></a>
The name of the log type.  
*Required*: No  
*Type*: String  
*Allowed values*: `api | audit | authenticator | controllerManager | scheduler`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster OutpostConfig
<a name="aws-properties-eks-cluster-outpostconfig"></a>

The configuration of your local Amazon EKS cluster on an AWS Outpost. Before creating a cluster on an Outpost, review [Creating a local cluster on an Outpost](https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-create.html) in the *Amazon EKS User Guide*. This API isn't available for Amazon EKS clusters on the AWS cloud.

## Syntax
<a name="aws-properties-eks-cluster-outpostconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-outpostconfig-syntax.json"></a>

```
{
  "[ControlPlaneInstanceType](#cfn-eks-cluster-outpostconfig-controlplaneinstancetype)" : String,
  "[ControlPlanePlacement](#cfn-eks-cluster-outpostconfig-controlplaneplacement)" : ControlPlanePlacement,
  "[OutpostArns](#cfn-eks-cluster-outpostconfig-outpostarns)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-outpostconfig-syntax.yaml"></a>

```
  [ControlPlaneInstanceType](#cfn-eks-cluster-outpostconfig-controlplaneinstancetype): String
  [ControlPlanePlacement](#cfn-eks-cluster-outpostconfig-controlplaneplacement): 
    ControlPlanePlacement
  [OutpostArns](#cfn-eks-cluster-outpostconfig-outpostarns): 
    - String
```

## Properties
<a name="aws-properties-eks-cluster-outpostconfig-properties"></a>

`ControlPlaneInstanceType`  <a name="cfn-eks-cluster-outpostconfig-controlplaneinstancetype"></a>
The Amazon EC2 instance type that you want to use for your local Amazon EKS cluster on Outposts. Choose an instance type based on the number of nodes that your cluster will have. 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*.  
The instance type that you specify is used for all Kubernetes control plane instances. The instance type can't be changed after cluster creation. The control plane is not automatically scaled by Amazon EKS.  
  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ControlPlanePlacement`  <a name="cfn-eks-cluster-outpostconfig-controlplaneplacement"></a>
An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an AWS 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*.  
*Required*: No  
*Type*: [ControlPlanePlacement](aws-properties-eks-cluster-controlplaneplacement.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OutpostArns`  <a name="cfn-eks-cluster-outpostconfig-outpostarns"></a>
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.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EKS::Cluster Provider
<a name="aws-properties-eks-cluster-provider"></a>

Identifies the AWS Key Management Service (AWS KMS) key used to encrypt the secrets.

## Syntax
<a name="aws-properties-eks-cluster-provider-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-provider-syntax.json"></a>

```
{
  "[KeyArn](#cfn-eks-cluster-provider-keyarn)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-provider-syntax.yaml"></a>

```
  [KeyArn](#cfn-eks-cluster-provider-keyarn): String
```

## Properties
<a name="aws-properties-eks-cluster-provider-properties"></a>

`KeyArn`  <a name="cfn-eks-cluster-provider-keyarn"></a>
Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same AWS 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 *AWS Key Management Service Developer Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EKS::Cluster RemoteNetworkConfig
<a name="aws-properties-eks-cluster-remotenetworkconfig"></a>

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

## Syntax
<a name="aws-properties-eks-cluster-remotenetworkconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-remotenetworkconfig-syntax.json"></a>

```
{
  "[RemoteNodeNetworks](#cfn-eks-cluster-remotenetworkconfig-remotenodenetworks)" : [ RemoteNodeNetwork, ... ],
  "[RemotePodNetworks](#cfn-eks-cluster-remotenetworkconfig-remotepodnetworks)" : [ RemotePodNetwork, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-remotenetworkconfig-syntax.yaml"></a>

```
  [RemoteNodeNetworks](#cfn-eks-cluster-remotenetworkconfig-remotenodenetworks): 
    - RemoteNodeNetwork
  [RemotePodNetworks](#cfn-eks-cluster-remotenetworkconfig-remotepodnetworks): 
    - RemotePodNetwork
```

## Properties
<a name="aws-properties-eks-cluster-remotenetworkconfig-properties"></a>

`RemoteNodeNetworks`  <a name="cfn-eks-cluster-remotenetworkconfig-remotenodenetworks"></a>
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 AWS Transit Gateway, AWS Site-to-Site VPN, or AWS 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.
*Required*: No  
*Type*: Array of [RemoteNodeNetwork](aws-properties-eks-cluster-remotenodenetwork.md)  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RemotePodNetworks`  <a name="cfn-eks-cluster-remotenetworkconfig-remotepodnetworks"></a>
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.
*Required*: No  
*Type*: Array of [RemotePodNetwork](aws-properties-eks-cluster-remotepodnetwork.md)  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster RemoteNodeNetwork
<a name="aws-properties-eks-cluster-remotenodenetwork"></a>

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 AWS Transit Gateway, AWS Site-to-Site VPN, or AWS 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.

## Syntax
<a name="aws-properties-eks-cluster-remotenodenetwork-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-remotenodenetwork-syntax.json"></a>

```
{
  "[Cidrs](#cfn-eks-cluster-remotenodenetwork-cidrs)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-remotenodenetwork-syntax.yaml"></a>

```
  [Cidrs](#cfn-eks-cluster-remotenodenetwork-cidrs): 
    - String
```

## Properties
<a name="aws-properties-eks-cluster-remotenodenetwork-properties"></a>

`Cidrs`  <a name="cfn-eks-cluster-remotenodenetwork-cidrs"></a>
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 AWS Transit Gateway, AWS Site-to-Site VPN, or AWS 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.
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster RemotePodNetwork
<a name="aws-properties-eks-cluster-remotepodnetwork"></a>

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.

## Syntax
<a name="aws-properties-eks-cluster-remotepodnetwork-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-remotepodnetwork-syntax.json"></a>

```
{
  "[Cidrs](#cfn-eks-cluster-remotepodnetwork-cidrs)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-remotepodnetwork-syntax.yaml"></a>

```
  [Cidrs](#cfn-eks-cluster-remotepodnetwork-cidrs): 
    - String
```

## Properties
<a name="aws-properties-eks-cluster-remotepodnetwork-properties"></a>

`Cidrs`  <a name="cfn-eks-cluster-remotepodnetwork-cidrs"></a>
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.
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster ResourcesVpcConfig
<a name="aws-properties-eks-cluster-resourcesvpcconfig"></a>

An object representing the VPC configuration to use for an Amazon EKS cluster.

**Important**  
When updating a resource, you must include these properties if the previous CloudFormation template of the resource had them:  
 `EndpointPublicAccess` 
 `EndpointPrivateAccess` 
 `PublicAccessCidrs` 

## Syntax
<a name="aws-properties-eks-cluster-resourcesvpcconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-resourcesvpcconfig-syntax.json"></a>

```
{
  "[EndpointPrivateAccess](#cfn-eks-cluster-resourcesvpcconfig-endpointprivateaccess)" : Boolean,
  "[EndpointPublicAccess](#cfn-eks-cluster-resourcesvpcconfig-endpointpublicaccess)" : Boolean,
  "[PublicAccessCidrs](#cfn-eks-cluster-resourcesvpcconfig-publicaccesscidrs)" : [ String, ... ],
  "[SecurityGroupIds](#cfn-eks-cluster-resourcesvpcconfig-securitygroupids)" : [ String, ... ],
  "[SubnetIds](#cfn-eks-cluster-resourcesvpcconfig-subnetids)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-eks-cluster-resourcesvpcconfig-syntax.yaml"></a>

```
  [EndpointPrivateAccess](#cfn-eks-cluster-resourcesvpcconfig-endpointprivateaccess): Boolean
  [EndpointPublicAccess](#cfn-eks-cluster-resourcesvpcconfig-endpointpublicaccess): Boolean
  [PublicAccessCidrs](#cfn-eks-cluster-resourcesvpcconfig-publicaccesscidrs): 
    - String
  [SecurityGroupIds](#cfn-eks-cluster-resourcesvpcconfig-securitygroupids): 
    - String
  [SubnetIds](#cfn-eks-cluster-resourcesvpcconfig-subnetids): 
    - String
```

## Properties
<a name="aws-properties-eks-cluster-resourcesvpcconfig-properties"></a>

`EndpointPrivateAccess`  <a name="cfn-eks-cluster-resourcesvpcconfig-endpointprivateaccess"></a>
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. 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* *.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EndpointPublicAccess`  <a name="cfn-eks-cluster-resourcesvpcconfig-endpointpublicaccess"></a>
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* *.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PublicAccessCidrs`  <a name="cfn-eks-cluster-resourcesvpcconfig-publicaccesscidrs"></a>
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 AWS 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.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecurityGroupIds`  <a name="cfn-eks-cluster-resourcesvpcconfig-securitygroupids"></a>
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* *.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubnetIds`  <a name="cfn-eks-cluster-resourcesvpcconfig-subnetids"></a>
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.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster StorageConfig
<a name="aws-properties-eks-cluster-storageconfig"></a>

Request to update the configuration of the storage capability of your EKS Auto Mode cluster. For example, enable the capability. For more information, see EKS Auto Mode block storage capability in the *Amazon EKS User Guide*.

## Syntax
<a name="aws-properties-eks-cluster-storageconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-storageconfig-syntax.json"></a>

```
{
  "[BlockStorage](#cfn-eks-cluster-storageconfig-blockstorage)" : BlockStorage
}
```

### YAML
<a name="aws-properties-eks-cluster-storageconfig-syntax.yaml"></a>

```
  [BlockStorage](#cfn-eks-cluster-storageconfig-blockstorage): 
    BlockStorage
```

## Properties
<a name="aws-properties-eks-cluster-storageconfig-properties"></a>

`BlockStorage`  <a name="cfn-eks-cluster-storageconfig-blockstorage"></a>
Request to configure EBS Block Storage settings for your EKS Auto Mode cluster.  
*Required*: No  
*Type*: [BlockStorage](aws-properties-eks-cluster-blockstorage.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster Tag
<a name="aws-properties-eks-cluster-tag"></a>

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:
+ Maximum number of tags per resource – 50
+ For each resource, each tag key must be unique, and each tag key can have only one value.
+ Maximum key length – 128 Unicode characters in UTF-8
+ Maximum value length – 256 Unicode characters in UTF-8
+ If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: \$1 - = . \$1 : / @.
+ Tag keys and values are case-sensitive.
+ Do not use `aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

## Syntax
<a name="aws-properties-eks-cluster-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-tag-syntax.json"></a>

```
{
  "[Key](#cfn-eks-cluster-tag-key)" : String,
  "[Value](#cfn-eks-cluster-tag-value)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-tag-syntax.yaml"></a>

```
  [Key](#cfn-eks-cluster-tag-key): String
  [Value](#cfn-eks-cluster-tag-value): String
```

## Properties
<a name="aws-properties-eks-cluster-tag-properties"></a>

`Key`  <a name="cfn-eks-cluster-tag-key"></a>
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.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-eks-cluster-tag-value"></a>
The optional part of a key-value pair that make up a tag. A `value` acts as a descriptor within a tag category (key).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-eks-cluster-tag--examples"></a>

### 
<a name="aws-properties-eks-cluster-tag--examples--"></a>



#### JSON
<a name="aws-properties-eks-cluster-tag--examples----json"></a>

```
"Tags" : [
   {
      "Key" : "keyname1",
      "Value" : "value1"
   },
   {
      "Key" : "keyname2",
      "Value" : "value2"
   }
]
```

#### YAML
<a name="aws-properties-eks-cluster-tag--examples----yaml"></a>

```
Tags: 
  - Key: "keyname1"
    Value: "value1"
  - Key: "keyname2"
    Value: "value2"
```

## See also
<a name="aws-properties-eks-cluster-tag--seealso"></a>
+  [Setting CloudFormation stack options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html) 
+  [Viewing CloudFormation stack data and resources on the AWS Management Console](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-view-stack-data-resources.html) 

# AWS::EKS::Cluster UpgradePolicy
<a name="aws-properties-eks-cluster-upgradepolicy"></a>

The support policy to use for the cluster. Extended support allows you to remain on specific Kubernetes versions for longer. Clusters in extended support have higher costs. The default value is `EXTENDED`. Use `STANDARD` to disable extended 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) 

## Syntax
<a name="aws-properties-eks-cluster-upgradepolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-upgradepolicy-syntax.json"></a>

```
{
  "[SupportType](#cfn-eks-cluster-upgradepolicy-supporttype)" : String
}
```

### YAML
<a name="aws-properties-eks-cluster-upgradepolicy-syntax.yaml"></a>

```
  [SupportType](#cfn-eks-cluster-upgradepolicy-supporttype): String
```

## Properties
<a name="aws-properties-eks-cluster-upgradepolicy-properties"></a>

`SupportType`  <a name="cfn-eks-cluster-upgradepolicy-supporttype"></a>
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)   
*Required*: No  
*Type*: String  
*Allowed values*: `STANDARD | EXTENDED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::EKS::Cluster ZonalShiftConfig
<a name="aws-properties-eks-cluster-zonalshiftconfig"></a>

The configuration for zonal shift for the cluster.

## Syntax
<a name="aws-properties-eks-cluster-zonalshiftconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-eks-cluster-zonalshiftconfig-syntax.json"></a>

```
{
  "[Enabled](#cfn-eks-cluster-zonalshiftconfig-enabled)" : Boolean
}
```

### YAML
<a name="aws-properties-eks-cluster-zonalshiftconfig-syntax.yaml"></a>

```
  [Enabled](#cfn-eks-cluster-zonalshiftconfig-enabled): Boolean
```

## Properties
<a name="aws-properties-eks-cluster-zonalshiftconfig-properties"></a>

`Enabled`  <a name="cfn-eks-cluster-zonalshiftconfig-enabled"></a>
If zonal shift is enabled, AWS configures zonal autoshift for the cluster.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)