1.204.0

interface ClusterOptions

LanguageType name
.NETAmazon.CDK.AWS.EKS.ClusterOptions
Javasoftware.amazon.awscdk.services.eks.ClusterOptions
Pythonaws_cdk.aws_eks.ClusterOptions
TypeScript (source)@aws-cdk/aws-eks » ClusterOptions

Options for EKS clusters.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';
import * as eks from '@aws-cdk/aws-eks';
import * as iam from '@aws-cdk/aws-iam';
import * as kms from '@aws-cdk/aws-kms';
import * as lambda from '@aws-cdk/aws-lambda';
import * as cdk from '@aws-cdk/core';

declare const albControllerVersion: eks.AlbControllerVersion;
declare const endpointAccess: eks.EndpointAccess;
declare const key: kms.Key;
declare const kubernetesVersion: eks.KubernetesVersion;
declare const layerVersion: lambda.LayerVersion;
declare const policy: any;
declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const size: cdk.Size;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const clusterOptions: eks.ClusterOptions = {
  version: kubernetesVersion,

  // the properties below are optional
  albController: {
    version: albControllerVersion,

    // the properties below are optional
    policy: policy,
    repository: 'repository',
  },
  clusterHandlerEnvironment: {
    clusterHandlerEnvironmentKey: 'clusterHandlerEnvironment',
  },
  clusterHandlerSecurityGroup: securityGroup,
  clusterName: 'clusterName',
  coreDnsComputeType: eks.CoreDnsComputeType.EC2,
  endpointAccess: endpointAccess,
  kubectlEnvironment: {
    kubectlEnvironmentKey: 'kubectlEnvironment',
  },
  kubectlLayer: layerVersion,
  kubectlMemory: size,
  mastersRole: role,
  onEventLayer: layerVersion,
  outputClusterName: false,
  outputConfigCommand: false,
  outputMastersRoleArn: false,
  placeClusterHandlerInVpc: false,
  prune: false,
  role: role,
  secretsEncryptionKey: key,
  securityGroup: securityGroup,
  serviceIpv4Cidr: 'serviceIpv4Cidr',
  vpc: vpc,
  vpcSubnets: [{
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnetName: 'subnetName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.ISOLATED,
  }],
};

Properties

NameTypeDescription
versionKubernetesVersionThe Kubernetes version to run in the cluster.
albController?AlbControllerOptionsInstall the AWS Load Balancer Controller onto the cluster.
clusterHandlerEnvironment?{ [string]: string }Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
clusterHandlerSecurityGroup?ISecurityGroupA security group to associate with the Cluster Handler's Lambdas.
clusterName?stringName for the cluster.
coreDnsComputeType?CoreDnsComputeTypeControls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.
endpointAccess?EndpointAccessConfigure access to the Kubernetes API server endpoint..
kubectlEnvironment?{ [string]: string }Environment variables for the kubectl execution.
kubectlLayer?ILayerVersionAn AWS Lambda Layer which includes kubectl, Helm and the AWS CLI.
kubectlMemory?SizeAmount of memory to allocate to the provider's lambda function.
mastersRole?IRoleAn IAM role that will be added to the system:masters Kubernetes RBAC group.
onEventLayer?ILayerVersionAn AWS Lambda Layer which includes the NPM dependency proxy-agent.
outputClusterName?booleanDetermines whether a CloudFormation output with the name of the cluster will be synthesized.
outputConfigCommand?booleanDetermines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.
outputMastersRoleArn?booleanDetermines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).
placeClusterHandlerInVpc?booleanIf set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.
prune?booleanIndicates whether Kubernetes resources added through addManifest() can be automatically pruned.
role?IRoleRole that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
secretsEncryptionKey?IKeyKMS secret for envelope encryption for Kubernetes secrets.
securityGroup?ISecurityGroupSecurity Group to use for Control Plane ENIs.
serviceIpv4Cidr?stringThe CIDR block to assign Kubernetes service IP addresses from.
vpc?IVpcThe VPC in which to create the Cluster.
vpcSubnets?SubnetSelection[]Where to place EKS Control Plane ENIs.

version

Type: KubernetesVersion

The Kubernetes version to run in the cluster.

albController?

Type: AlbControllerOptions (optional, default: The controller is not installed.)

Install the AWS Load Balancer Controller onto the cluster.

See also: https://kubernetes-sigs.github.io/aws-load-balancer-controller

clusterHandlerEnvironment?

Type: { [string]: string } (optional, default: No environment variables.)

Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.

clusterHandlerSecurityGroup?

Type: ISecurityGroup (optional, default: No security group.)

A security group to associate with the Cluster Handler's Lambdas.

The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.

Requires placeClusterHandlerInVpc to be set to true.

clusterName?

Type: string (optional, default: Automatically generated name)

Name for the cluster.

coreDnsComputeType?

Type: CoreDnsComputeType (optional, default: CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE))

Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

endpointAccess?

Type: EndpointAccess (optional, default: EndpointAccess.PUBLIC_AND_PRIVATE)

Configure access to the Kubernetes API server endpoint..

See also: https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

kubectlEnvironment?

Type: { [string]: string } (optional, default: No environment variables.)

Environment variables for the kubectl execution.

Only relevant for kubectl enabled clusters.

kubectlLayer?

Type: ILayerVersion (optional, default: the layer provided by the aws-lambda-layer-kubectl SAR app.)

An AWS Lambda Layer which includes kubectl, Helm and the AWS CLI.

By default, the provider will use the layer included in the "aws-lambda-layer-kubectl" SAR application which is available in all commercial regions.

To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows:

const layer = new lambda.LayerVersion(this, 'kubectl-layer', {
   code: lambda.Code.fromAsset(`${__dirname}/layer.zip`),
   compatibleRuntimes: [lambda.Runtime.PROVIDED],
});

See also: https://github.com/aws-samples/aws-lambda-layer-kubectl

kubectlMemory?

Type: Size (optional, default: Size.gibibytes(1))

Amount of memory to allocate to the provider's lambda function.

mastersRole?

Type: IRole (optional, default: a role that assumable by anyone with permissions in the same account will automatically be defined)

An IAM role that will be added to the system:masters Kubernetes RBAC group.

See also: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings

onEventLayer?

Type: ILayerVersion (optional, default: a layer bundled with this module.)

An AWS Lambda Layer which includes the NPM dependency proxy-agent.

This layer is used by the onEvent handler to route AWS SDK requests through a proxy.

By default, the provider will use the layer included in the "aws-lambda-layer-node-proxy-agent" SAR application which is available in all commercial regions.

To deploy the layer locally define it in your app as follows:

const layer = new lambda.LayerVersion(this, 'proxy-agent-layer', {
   code: lambda.Code.fromAsset(`${__dirname}/layer.zip`),
   compatibleRuntimes: [lambda.Runtime.NODEJS_14_X],
});

outputClusterName?

Type: boolean (optional, default: false)

Determines whether a CloudFormation output with the name of the cluster will be synthesized.

outputConfigCommand?

Type: boolean (optional, default: true)

Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.

This command will include the cluster name and, if applicable, the ARN of the masters IAM role.

outputMastersRoleArn?

Type: boolean (optional, default: false)

Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).

placeClusterHandlerInVpc?

Type: boolean (optional, default: false)

If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.

prune?

Type: boolean (optional, default: true)

Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.

When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

role?

Type: IRole (optional, default: A role is automatically created for you)

Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

secretsEncryptionKey?

Type: IKey (optional, default: By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys.)

KMS secret for envelope encryption for Kubernetes secrets.

securityGroup?

Type: ISecurityGroup (optional, default: A security group is automatically created)

Security Group to use for Control Plane ENIs.

serviceIpv4Cidr?

Type: string (optional, default: Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks)

The CIDR block to assign Kubernetes service IP addresses from.

See also: https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-serviceIpv4Cidr

vpc?

Type: IVpc (optional, default: a VPC with default configuration will be created and can be accessed through cluster.vpc.)

The VPC in which to create the Cluster.

vpcSubnets?

Type: SubnetSelection[] (optional, default: All public and private subnets)

Where to place EKS Control Plane ENIs.

If you want to create public load balancers, this must include public subnets.

For example, to only select private subnets, supply the following:

vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_NAT }]

← PreviousNext →