VpcConfigRequest
An object representing the VPC configuration to use for an Amazon EKS cluster.
Contents
- endpointPrivateAccess
-
Set this value to
trueto 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 isfalse, 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 thatpublicAccessCidrsincludes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .Type: Boolean
Required: No
- endpointPublicAccess
-
Set this value to
falseto 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 istrue, which enables public access for your Kubernetes API server. The endpoint domain name and IP address family depends on the value of theipFamilyfor the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .Type: Boolean
Required: No
- 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/0and additionally::/0for 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 FargatePodin the cluster. For more information, see Cluster API server endpoint in the Amazon EKS User Guide .Note that the public endpoints are dual-stack for only
IPv6clusters that are made after October 2024. You can't addIPv6CIDR blocks toIPv4clusters orIPv6clusters that were made before October 2024.Type: Array of strings
Required: No
- 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 .
Type: Array of strings
Required: No
- 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.
Type: Array of strings
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: