AWS::EKS::Cluster ResourcesVpcConfig

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

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

JSON

{
  "EndpointPrivateAccess" : Boolean,
  "EndpointPublicAccess" : Boolean,
  "PublicAccessCidrs" : [ String, ... ],
  "SecurityGroupIds" : [ String, ... ],
  "SubnetIds" : [ String, ... ]
}

YAML

  EndpointPrivateAccess: Boolean
  EndpointPublicAccess: Boolean
  PublicAccessCidrs: 
    - String
  SecurityGroupIds: 
    - String
  SubnetIds: 
    - String

Properties

EndpointPrivateAccess

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 Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

Required: No

Type: Boolean

Update requires: No interruption

EndpointPublicAccess

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. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

Required: No

Type: Boolean

Update requires: No interruption

PublicAccessCidrs

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0. If you've disabled private endpoint access, make sure that you specify the necessary CIDR blocks for every node and AWS Fargate Pod in the cluster. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

Required: No

Type: Array of String

Update requires: No interruption

SecurityGroupIds

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 in the Amazon EKS User Guide .

Required: No

Type: Array of String

Update requires: No interruption

SubnetIds

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