Defines an EKS cluster that runs entirely on AWS Fargate. The cluster is created with a default Fargate Profile that matches the "default" and "kube-system" namespaces. You can add additional profiles using `addFargateProfile`.
import { FargateCluster } from 'aws-cdk-lib/aws-eks';Or use the module namespace:
import * as eks from 'aws-cdk-lib/aws-eks';
// eks.FargateClusterConfiguration passed to the constructor as FargateClusterProps.
defaultProfileOptionalFargateProfileOptionsFargate Profile to create along with the cluster.
Default: - A profile called "default" with 'default' and 'kube-system'
selectors will be created if this is left undefined.
ClusterOptionskubectlLayerRequiredinherited from ClusterOptionsILayerVersionAn AWS Lambda Layer which includes `kubectl` and Helm. This layer is used by the kubectl handler to apply manifests and install helm charts. You must pick an appropriate releases of one of the `@aws-cdk/layer-kubectl-vXX` packages, that works with the version of Kubernetes you have chosen. The handler expects the layer to include the following executables: ``` /opt/helm/helm /opt/kubectl/kubectl ```
albControllerOptionalinherited from ClusterOptionsAlbControllerOptionsInstall the AWS Load Balancer Controller onto the cluster.
Default: - The controller is not installed.
authenticationModeOptionalinherited from ClusterOptionsAuthenticationModeThe desired authentication mode for the cluster.
Default: AuthenticationMode.CONFIG_MAP
awscliLayerOptionalinherited from ClusterOptionsILayerVersionAn AWS Lambda layer that contains the `aws` CLI. The handler expects the layer to include the following executables: ``` /opt/awscli/aws ```
Default: - a default layer with the AWS CLI 1.x
clusterHandlerEnvironmentOptionalinherited from ClusterOptions{ [key: string]: string }Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
Default: - No environment variables.
clusterHandlerSecurityGroupOptionalinherited from ClusterOptionsISecurityGroupA 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.
Default: - No security group.
clusterLoggingOptionalinherited from ClusterOptionsClusterLoggingTypes[]The cluster log types which you want to enable.
Default: - none
coreDnsComputeTypeOptionalinherited from ClusterOptionsCoreDnsComputeTypeControls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.
Default: CoreDnsComputeType.EC2 (for `FargateCluster` the default is FARGATE)
endpointAccessOptionalinherited from ClusterOptionsEndpointAccessConfigure access to the Kubernetes API server endpoint..
Default: EndpointAccess.PUBLIC_AND_PRIVATE
ipFamilyOptionalinherited from ClusterOptionsIpFamilySpecify which IP family is used to assign Kubernetes pod and service IP addresses.
Default: - IpFamily.IP_V4
kubectlEnvironmentOptionalinherited from ClusterOptions{ [key: string]: string }Environment variables for the kubectl execution. Only relevant for kubectl enabled clusters.
Default: - No environment variables.
kubectlMemoryOptionalinherited from ClusterOptionsSizeAmount of memory to allocate to the provider's lambda function.
Default: Size.gibibytes(1)
mastersRoleOptionalinherited from ClusterOptionsIRoleAn IAM role that will be added to the `system:masters` Kubernetes RBAC group.
Default: - no masters role.
onEventLayerOptionalinherited from ClusterOptionsILayerVersionAn 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: ```ts const layer = new lambda.LayerVersion(this, 'proxy-agent-layer', { code: lambda.Code.fromAsset(`${__dirname}/layer.zip`), compatibleRuntimes: [lambda.Runtime.NODEJS_LATEST], }); ```
Default: - a layer bundled with this module.
outputMastersRoleArnOptionalinherited from ClusterOptionsbooleanDetermines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if `mastersRole` is specified).
Default: false
placeClusterHandlerInVpcOptionalinherited from ClusterOptionsbooleanIf set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the `vpcSubnets` selection strategy.
Default: false
pruneOptionalinherited from ClusterOptionsbooleanIndicates 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.
Default: true
remoteNodeNetworksOptionalinherited from ClusterOptionsRemoteNodeNetwork[]IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.
Default: - none
remotePodNetworksOptionalinherited from ClusterOptionsRemotePodNetwork[]IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.
Default: - none
removalPolicyOptionalinherited from ClusterOptionsRemovalPolicyThe removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation. This can happen in one of three situations: - The resource is removed from the template, so CloudFormation stops managing it; - A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it; - The stack is deleted, so CloudFormation stops managing all resources in it. This affects the EKS cluster itself, associated IAM roles, node groups, security groups, VPC and any other CloudFormation resources managed by this construct.
Default: - Resources will be deleted.
secretsEncryptionKeyOptionalinherited from ClusterOptionsIKeyRefKMS secret for envelope encryption for Kubernetes secrets.
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.
serviceIpv4CidrOptionalinherited from ClusterOptionsstringThe CIDR block to assign Kubernetes service IP addresses from.
Default: - Kubernetes assigns addresses from either the
10.100.0.0/16 or 172.20.0.0/16 CIDR blocks
CommonClusterOptionsversionRequiredinherited from CommonClusterOptionsKubernetesVersionThe Kubernetes version to run in the cluster.
clusterNameOptionalinherited from CommonClusterOptionsstringName for the cluster.
Default: - Automatically generated name
outputClusterNameOptionalinherited from CommonClusterOptionsbooleanDetermines whether a CloudFormation output with the name of the cluster will be synthesized.
Default: false
outputConfigCommandOptionalinherited from CommonClusterOptionsbooleanDetermines whether a CloudFormation output with the `aws eks update-kubeconfig` command will be synthesized. This command will include the cluster name and the ARN of the masters IAM role. Note: If mastersRole is not specified, this property will be ignored and no config command will be emitted.
Default: true
roleOptionalinherited from CommonClusterOptionsIRoleRole that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
Default: - A role is automatically created for you
securityGroupOptionalinherited from CommonClusterOptionsISecurityGroupSecurity Group to use for Control Plane ENIs.
Default: - A security group is automatically created
vpcOptionalinherited from CommonClusterOptionsIVpcThe VPC in which to create the Cluster.
Default: - a VPC with default configuration will be created and can be accessed through `cluster.vpc`.
vpcSubnetsOptionalinherited from CommonClusterOptionsSubnetSelection[]Where to place EKS Control Plane ENIs. For example, to only select private subnets, supply the following: `vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]`
Default: - All public and private subnets
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-eks