Class Cluster.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<Cluster>
- Enclosing class:
Cluster
Cluster
.-
Method Summary
Modifier and TypeMethodDescriptionalbController
(AlbControllerOptions albController) Install the AWS Load Balancer Controller onto the cluster.authenticationMode
(AuthenticationMode authenticationMode) The desired authentication mode for the cluster.awscliLayer
(ILayerVersion awscliLayer) An AWS Lambda layer that contains theaws
CLI.bootstrapClusterCreatorAdminPermissions
(Boolean bootstrapClusterCreatorAdminPermissions) Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.build()
clusterHandlerEnvironment
(Map<String, String> clusterHandlerEnvironment) Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.clusterHandlerSecurityGroup
(ISecurityGroup clusterHandlerSecurityGroup) A security group to associate with the Cluster Handler's Lambdas.clusterLogging
(List<? extends ClusterLoggingTypes> clusterLogging) The cluster log types which you want to enable.clusterName
(String clusterName) Name for the cluster.coreDnsComputeType
(CoreDnsComputeType coreDnsComputeType) Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.static Cluster.Builder
defaultCapacity
(Number defaultCapacity) Number of instances to allocate as an initial capacity for this cluster.defaultCapacityInstance
(InstanceType defaultCapacityInstance) The instance type to use for the default capacity.defaultCapacityType
(DefaultCapacityType defaultCapacityType) The default capacity type for the cluster.endpointAccess
(EndpointAccess endpointAccess) Configure access to the Kubernetes API server endpoint..Specify which IP family is used to assign Kubernetes pod and service IP addresses.kubectlEnvironment
(Map<String, String> kubectlEnvironment) Environment variables for the kubectl execution.kubectlLambdaRole
(IRole kubectlLambdaRole) The IAM role to pass to the Kubectl Lambda Handler.kubectlLayer
(ILayerVersion kubectlLayer) An AWS Lambda Layer which includeskubectl
and Helm.kubectlMemory
(Size kubectlMemory) Amount of memory to allocate to the provider's lambda function.mastersRole
(IRole mastersRole) An IAM role that will be added to thesystem:masters
Kubernetes RBAC group.onEventLayer
(ILayerVersion onEventLayer) An AWS Lambda Layer which includes the NPM dependencyproxy-agent
.outputClusterName
(Boolean outputClusterName) Determines whether a CloudFormation output with the name of the cluster will be synthesized.outputConfigCommand
(Boolean outputConfigCommand) Determines whether a CloudFormation output with theaws eks update-kubeconfig
command will be synthesized.outputMastersRoleArn
(Boolean outputMastersRoleArn) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (ifmastersRole
is specified).placeClusterHandlerInVpc
(Boolean placeClusterHandlerInVpc) If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to thevpcSubnets
selection strategy.Indicates whether Kubernetes resources added throughaddManifest()
can be automatically pruned.Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.secretsEncryptionKey
(IKey secretsEncryptionKey) KMS secret for envelope encryption for Kubernetes secrets.securityGroup
(ISecurityGroup securityGroup) Security Group to use for Control Plane ENIs.serviceIpv4Cidr
(String serviceIpv4Cidr) The CIDR block to assign Kubernetes service IP addresses from.The tags assigned to the EKS cluster.version
(KubernetesVersion version) The Kubernetes version to run in the cluster.The VPC in which to create the Cluster.vpcSubnets
(List<? extends SubnetSelection> vpcSubnets) Where to place EKS Control Plane ENIs.
-
Method Details
-
create
@Stability(Stable) public static Cluster.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- a Construct, most likely a cdk.Stack created. This parameter is required.id
- the id of the Construct to create. This parameter is required.- Returns:
- a new instance of
Cluster.Builder
.
-
version
The Kubernetes version to run in the cluster.- Parameters:
version
- The Kubernetes version to run in the cluster. This parameter is required.- Returns:
this
-
clusterName
Name for the cluster.Default: - Automatically generated name
- Parameters:
clusterName
- Name for the cluster. This parameter is required.- Returns:
this
-
outputClusterName
Determines whether a CloudFormation output with the name of the cluster will be synthesized.Default: false
- Parameters:
outputClusterName
- Determines whether a CloudFormation output with the name of the cluster will be synthesized. This parameter is required.- Returns:
this
-
outputConfigCommand
Determines whether a CloudFormation output with theaws eks update-kubeconfig
command will be synthesized.This command will include the cluster name and, if applicable, the ARN of the masters IAM role.
Default: true
- Parameters:
outputConfigCommand
- Determines whether a CloudFormation output with theaws eks update-kubeconfig
command will be synthesized. This parameter is required.- Returns:
this
-
role
Role 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
- Parameters:
role
- Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. This parameter is required.- Returns:
this
-
securityGroup
Security Group to use for Control Plane ENIs.Default: - A security group is automatically created
- Parameters:
securityGroup
- Security Group to use for Control Plane ENIs. This parameter is required.- Returns:
this
-
vpc
The VPC in which to create the Cluster.Default: - a VPC with default configuration will be created and can be accessed through `cluster.vpc`.
- Parameters:
vpc
- The VPC in which to create the Cluster. This parameter is required.- Returns:
this
-
vpcSubnets
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
- Parameters:
vpcSubnets
- Where to place EKS Control Plane ENIs. This parameter is required.- Returns:
this
-
albController
Install the AWS Load Balancer Controller onto the cluster.Default: - The controller is not installed.
- Parameters:
albController
- Install the AWS Load Balancer Controller onto the cluster. This parameter is required.- Returns:
this
- See Also:
-
authenticationMode
The desired authentication mode for the cluster.Default: AuthenticationMode.CONFIG_MAP
- Parameters:
authenticationMode
- The desired authentication mode for the cluster. This parameter is required.- Returns:
this
-
awscliLayer
An AWS Lambda layer that contains theaws
CLI.The handler expects the layer to include the following executables:
/opt/awscli/aws
Default: - a default layer with the AWS CLI 1.x
- Parameters:
awscliLayer
- An AWS Lambda layer that contains theaws
CLI. This parameter is required.- Returns:
this
-
clusterHandlerEnvironment
@Stability(Stable) public Cluster.Builder clusterHandlerEnvironment(Map<String, String> clusterHandlerEnvironment) Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.Default: - No environment variables.
- Parameters:
clusterHandlerEnvironment
- Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle. This parameter is required.- Returns:
this
-
clusterHandlerSecurityGroup
@Stability(Stable) public Cluster.Builder clusterHandlerSecurityGroup(ISecurityGroup clusterHandlerSecurityGroup) 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.Default: - No security group.
- Parameters:
clusterHandlerSecurityGroup
- A security group to associate with the Cluster Handler's Lambdas. This parameter is required.- Returns:
this
-
clusterLogging
@Stability(Stable) public Cluster.Builder clusterLogging(List<? extends ClusterLoggingTypes> clusterLogging) The cluster log types which you want to enable.Default: - none
- Parameters:
clusterLogging
- The cluster log types which you want to enable. This parameter is required.- Returns:
this
-
coreDnsComputeType
Controls 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)
- Parameters:
coreDnsComputeType
- Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS. This parameter is required.- Returns:
this
-
endpointAccess
Configure access to the Kubernetes API server endpoint..Default: EndpointAccess.PUBLIC_AND_PRIVATE
- Parameters:
endpointAccess
- Configure access to the Kubernetes API server endpoint.. This parameter is required.- Returns:
this
- See Also:
-
ipFamily
Specify which IP family is used to assign Kubernetes pod and service IP addresses.Default: - IpFamily.IP_V4
- Parameters:
ipFamily
- Specify which IP family is used to assign Kubernetes pod and service IP addresses. This parameter is required.- Returns:
this
- See Also:
-
kubectlEnvironment
Environment variables for the kubectl execution.Only relevant for kubectl enabled clusters.
Default: - No environment variables.
- Parameters:
kubectlEnvironment
- Environment variables for the kubectl execution. This parameter is required.- Returns:
this
-
kubectlLayer
An AWS Lambda Layer which includeskubectl
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. If you don't supply this valuekubectl
1.20 will be used, but that version is most likely too old.The handler expects the layer to include the following executables:
/opt/helm/helm /opt/kubectl/kubectl
Default: - a default layer with Kubectl 1.20.
- Parameters:
kubectlLayer
- An AWS Lambda Layer which includeskubectl
and Helm. This parameter is required.- Returns:
this
-
kubectlMemory
Amount of memory to allocate to the provider's lambda function.Default: Size.gibibytes(1)
- Parameters:
kubectlMemory
- Amount of memory to allocate to the provider's lambda function. This parameter is required.- Returns:
this
-
mastersRole
An IAM role that will be added to thesystem:masters
Kubernetes RBAC group.Default: - no masters role.
- Parameters:
mastersRole
- An IAM role that will be added to thesystem:masters
Kubernetes RBAC group. This parameter is required.- Returns:
this
- See Also:
-
onEventLayer
An AWS Lambda Layer which includes the NPM dependencyproxy-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:
LayerVersion layer = LayerVersion.Builder.create(this, "proxy-agent-layer") .code(Code.fromAsset(String.format("%s/layer.zip", __dirname))) .compatibleRuntimes(List.of(Runtime.NODEJS_LATEST)) .build();
Default: - a layer bundled with this module.
- Parameters:
onEventLayer
- An AWS Lambda Layer which includes the NPM dependencyproxy-agent
. This parameter is required.- Returns:
this
-
outputMastersRoleArn
Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (ifmastersRole
is specified).Default: false
- Parameters:
outputMastersRoleArn
- Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (ifmastersRole
is specified). This parameter is required.- Returns:
this
-
placeClusterHandlerInVpc
@Stability(Stable) public Cluster.Builder placeClusterHandlerInVpc(Boolean placeClusterHandlerInVpc) If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to thevpcSubnets
selection strategy.Default: false
- Parameters:
placeClusterHandlerInVpc
- If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to thevpcSubnets
selection strategy. This parameter is required.- Returns:
this
-
prune
Indicates whether Kubernetes resources added throughaddManifest()
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
- Parameters:
prune
- Indicates whether Kubernetes resources added throughaddManifest()
can be automatically pruned. This parameter is required.- Returns:
this
-
secretsEncryptionKey
KMS 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.
- Parameters:
secretsEncryptionKey
- KMS secret for envelope encryption for Kubernetes secrets. This parameter is required.- Returns:
this
-
serviceIpv4Cidr
The 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
- Parameters:
serviceIpv4Cidr
- The CIDR block to assign Kubernetes service IP addresses from. This parameter is required.- Returns:
this
- See Also:
-
bootstrapClusterCreatorAdminPermissions
@Stability(Stable) public Cluster.Builder bootstrapClusterCreatorAdminPermissions(Boolean bootstrapClusterCreatorAdminPermissions) Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.Changing this value after the cluster has been created will result in the cluster being replaced.
Default: true
- Parameters:
bootstrapClusterCreatorAdminPermissions
- Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time. This parameter is required.- Returns:
this
-
defaultCapacity
Number of instances to allocate as an initial capacity for this cluster.Instance type can be configured through
defaultCapacityInstanceType
, which defaults tom5.large
.Use
cluster.addAutoScalingGroupCapacity
to add additional customized capacity. Set this to0
is you wish to avoid the initial capacity allocation.Default: 2
- Parameters:
defaultCapacity
- Number of instances to allocate as an initial capacity for this cluster. This parameter is required.- Returns:
this
-
defaultCapacityInstance
@Stability(Stable) public Cluster.Builder defaultCapacityInstance(InstanceType defaultCapacityInstance) The instance type to use for the default capacity.This will only be taken into account if
defaultCapacity
is > 0.Default: m5.large
- Parameters:
defaultCapacityInstance
- The instance type to use for the default capacity. This parameter is required.- Returns:
this
-
defaultCapacityType
@Stability(Stable) public Cluster.Builder defaultCapacityType(DefaultCapacityType defaultCapacityType) The default capacity type for the cluster.Default: NODEGROUP
- Parameters:
defaultCapacityType
- The default capacity type for the cluster. This parameter is required.- Returns:
this
-
kubectlLambdaRole
The IAM role to pass to the Kubectl Lambda Handler.Default: - Default Lambda IAM Execution Role
- Parameters:
kubectlLambdaRole
- The IAM role to pass to the Kubectl Lambda Handler. This parameter is required.- Returns:
this
-
tags
The tags assigned to the EKS cluster.Default: - none
- Parameters:
tags
- The tags assigned to the EKS cluster. This parameter is required.- Returns:
this
-
build
-