Package software.amazon.awscdk.services.eks

Class Cluster.Builder

java.lang.Object
software.amazon.awscdk.services.eks.Cluster.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Cluster>
Enclosing class:
Cluster
@Stability(Stable) public static final class Cluster.Builder extends Object implements software.amazon.jsii.Builder<Cluster>
A fluent builder for Cluster.

  • 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

      @Stability(Stable) public Cluster.Builder version(KubernetesVersion 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

      @Stability(Stable) public Cluster.Builder clusterName(String clusterName)
      Name for the cluster.

      Default: - Automatically generated name

      Parameters:
      clusterName - Name for the cluster. This parameter is required.
      Returns:
      this

    • outputClusterName

      @Stability(Stable) public Cluster.Builder outputClusterName(Boolean 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

      @Stability(Stable) public Cluster.Builder outputConfigCommand(Boolean outputConfigCommand)
      Determines 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

      Parameters:
      outputConfigCommand - Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized. This parameter is required.
      Returns:
      this
      See Also:

    • role

      @Stability(Stable) public Cluster.Builder role(IRole 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

      @Stability(Stable) public Cluster.Builder securityGroup(ISecurityGroup 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

      @Stability(Stable) public Cluster.Builder vpc(IVpc 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

      @Stability(Stable) public Cluster.Builder vpcSubnets(List<? extends SubnetSelection> 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

    • kubectlLayer

      @Stability(Stable) public Cluster.Builder kubectlLayer(ILayerVersion kubectlLayer)
      An 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

      Parameters:
      kubectlLayer - An AWS Lambda Layer which includes kubectl and Helm. This parameter is required.
      Returns:
      this

    • albController

      @Stability(Stable) public Cluster.Builder albController(AlbControllerOptions 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

      @Stability(Stable) public Cluster.Builder authenticationMode(AuthenticationMode 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

      @Stability(Stable) public Cluster.Builder awscliLayer(ILayerVersion awscliLayer)
      An 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

      Parameters:
      awscliLayer - An AWS Lambda layer that contains the aws 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

      @Stability(Stable) public Cluster.Builder 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.

      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

      @Stability(Stable) public Cluster.Builder endpointAccess(EndpointAccess 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

      @Stability(Stable) public Cluster.Builder ipFamily(IpFamily 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

      @Stability(Stable) public Cluster.Builder kubectlEnvironment(Map<String,String> 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

    • kubectlMemory

      @Stability(Stable) public Cluster.Builder kubectlMemory(Size 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

      @Stability(Stable) public Cluster.Builder mastersRole(IRole mastersRole)
      An IAM role that will be added to the system:masters Kubernetes RBAC group.

      Default: - no masters role.

      Parameters:
      mastersRole - An IAM role that will be added to the system:masters Kubernetes RBAC group. This parameter is required.
      Returns:
      this
      See Also:

    • onEventLayer

      @Stability(Stable) public Cluster.Builder onEventLayer(ILayerVersion onEventLayer)
      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: 

       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 dependency proxy-agent. This parameter is required.
      Returns:
      this

    • outputMastersRoleArn

      @Stability(Stable) public Cluster.Builder outputMastersRoleArn(Boolean outputMastersRoleArn)
      Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).

      Default: false

      Parameters:
      outputMastersRoleArn - Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole 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 the vpcSubnets 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 the vpcSubnets selection strategy. This parameter is required.
      Returns:
      this

    • prune

      @Stability(Stable) public Cluster.Builder prune(Boolean prune)
      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.

      Default: true

      Parameters:
      prune - Indicates whether Kubernetes resources added through addManifest() can be automatically pruned. This parameter is required.
      Returns:
      this

    • remoteNodeNetworks

      @Stability(Stable) public Cluster.Builder remoteNodeNetworks(List<? extends RemoteNodeNetwork> remoteNodeNetworks)
      IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.

      Default: - none

      Parameters:
      remoteNodeNetworks - IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster. This parameter is required.
      Returns:
      this

    • remotePodNetworks

      @Stability(Stable) public Cluster.Builder remotePodNetworks(List<? extends RemotePodNetwork> remotePodNetworks)
      IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.

      Default: - none

      Parameters:
      remotePodNetworks - IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Stable) public Cluster.Builder removalPolicy(RemovalPolicy removalPolicy)
      The 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.

      Parameters:
      removalPolicy - The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation. This parameter is required.
      Returns:
      this

    • secretsEncryptionKey

      @Stability(Stable) public Cluster.Builder secretsEncryptionKey(IKeyRef 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

      @Stability(Stable) public Cluster.Builder serviceIpv4Cidr(String 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

    • bootstrapSelfManagedAddons

      @Stability(Stable) public Cluster.Builder bootstrapSelfManagedAddons(Boolean bootstrapSelfManagedAddons)
      If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

      The default networking addons include vpc-cni, coredns, and kube-proxy. Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

      Changing this value after the cluster has been created will result in the cluster being replaced.

      Default: true

      Parameters:
      bootstrapSelfManagedAddons - If you set this value to False when creating a cluster, the default networking add-ons will not be installed. This parameter is required.
      Returns:
      this

    • defaultCapacity

      @Stability(Stable) public Cluster.Builder defaultCapacity(Number defaultCapacity)
      Number of instances to allocate as an initial capacity for this cluster.

      Instance type can be configured through defaultCapacityInstanceType, which defaults to m5.large.

      Use cluster.addAutoScalingGroupCapacity to add additional customized capacity. Set this to 0 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

      @Stability(Stable) public Cluster.Builder kubectlLambdaRole(IRole 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

      @Stability(Stable) public Cluster.Builder tags(Map<String,String> 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

      @Stability(Stable) public Cluster build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Cluster>
      Returns:
      a newly built instance of Cluster.