AWS CDK Reference

Appearance

v2.273.0

EndpointAccess Class ​

Endpoint access characteristics.

Source
aws-eks/lib/cluster.ts

Example ​

ts
import { KubectlV36Layer } from '@aws-cdk/lambda-layer-kubectl-v36';

const cluster = new eks.Cluster(this, 'hello-eks', {
  version: eks.KubernetesVersion.V1_36,
  endpointAccess: eks.EndpointAccess.PRIVATE, // No access outside of your VPC.
  kubectlLayer: new KubectlV36Layer(this, 'kubectl'),
});

Properties ​

PRIVATEEndpointAccessprivateEndpointAccessPRIVATEEndpointAccessPRIVATEEndpointAccessPRIVATEEndpointAccessrequiredstatic#
The cluster endpoint is only accessible through your VPC.

Worker node traffic to the endpoint will stay within your VPC.

PUBLICEndpointAccesspublicEndpointAccessPUBLICEndpointAccessPUBLICEndpointAccessPUBLICEndpointAccessrequiredstatic#
The cluster endpoint is accessible from outside of your VPC.
notes

Worker node traffic will leave your VPC to connect to the endpoint.

By default, the endpoint is exposed to all addresses. You can optionally limit the CIDR blocks that can access the public endpoint using the PUBLIC.onlyFrom method. If you limit access to specific CIDR blocks, you must ensure that the CIDR blocks that you specify include the addresses that worker nodes and Fargate pods (if you use them) access the public endpoint from.

PUBLIC_AND_PRIVATEEndpointAccesspublic_and_privateEndpointAccessPUBLIC_AND_PRIVATEEndpointAccessPUBLIC_AND_PRIVATEEndpointAccessPUBLIC_AND_PRIVATEEndpointAccessrequiredstatic#
The cluster endpoint is accessible from outside of your VPC.
notes

Worker node traffic to the endpoint will stay within your VPC.

By default, the endpoint is exposed to all addresses. You can optionally limit the CIDR blocks that can access the public endpoint using the PUBLIC_AND_PRIVATE.onlyFrom method. If you limit access to specific CIDR blocks, you must ensure that the CIDR blocks that you specify include the addresses that worker nodes and Fargate pods (if you use them) access the public endpoint from.

Methods ​

onlyFrom(...cidr: string[]): EndpointAccess // chainabledef only_from(self, cidr: str) -> EndpointAccesspublic EndpointAccess onlyFrom(String cidr)public EndpointAccess OnlyFrom(string cidr)func OnlyFrom(Cidr *string) EndpointAccess#
Restrict public access to specific CIDR blocks.

If public access is disabled, this method will result in an error.

1 parameter

Parameters

  • cidrcidrcidrcidrCidr — CIDR blocks.