software.amazon.awscdk.services.eks

Interface CfnCluster.ResourcesVpcConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.ResourcesVpcConfigProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(value=Stable)
public static interface CfnCluster.ResourcesVpcConfigProperty
extends software.amazon.jsii.JsiiSerializable

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

When updating a resource, you must include these properties if the previous CloudFormation template of the resource had them:

• EndpointPublicAccess
• EndpointPrivateAccess
• PublicAccessCidrs

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 ResourcesVpcConfigProperty resourcesVpcConfigProperty = ResourcesVpcConfigProperty.builder()
         .subnetIds(List.of("subnetIds"))
         // the properties below are optional
         .endpointPrivateAccess(false)
         .endpointPublicAccess(false)
         .publicAccessCidrs(List.of("publicAccessCidrs"))
         .securityGroupIds(List.of("securityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCluster.ResourcesVpcConfigProperty.Builder A builder for CfnCluster.ResourcesVpcConfigProperty
static class	CfnCluster.ResourcesVpcConfigProperty.Jsii$Proxy An implementation for CfnCluster.ResourcesVpcConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnCluster.ResourcesVpcConfigProperty.Builder	builder()
default Object	getEndpointPrivateAccess() Set this value to `true` to enable private access for your cluster's Kubernetes API server endpoint.
default Object	getEndpointPublicAccess() Set this value to `false` to disable public access to your cluster's Kubernetes API server endpoint.
default List<String>	getPublicAccessCidrs() The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.
default List<String>	getSecurityGroupIds() 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.
List<String>	getSubnetIds() Specify subnets for your Amazon EKS nodes.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSubnetIds

@Stability(value=Stable)
 @NotNull
List<String> getSubnetIds()

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.

getEndpointPrivateAccess

@Stability(value=Stable)
 @Nullable
default Object getEndpointPrivateAccess()

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 .

getEndpointPublicAccess

@Stability(value=Stable)
 @Nullable
default Object getEndpointPublicAccess()

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 .

getPublicAccessCidrs

@Stability(value=Stable)
 @Nullable
default List<String> getPublicAccessCidrs()

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.

Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is 0.0.0.0/0 . If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

getSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getSecurityGroupIds()

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 .

builder

@Stability(value=Stable)
static CfnCluster.ResourcesVpcConfigProperty.Builder builder()

Returns:

a CfnCluster.ResourcesVpcConfigProperty.Builder of CfnCluster.ResourcesVpcConfigProperty