Package software.amazon.awscdk.services.eks_v2

Class Cluster.Builder

java.lang.Object
software.amazon.awscdk.services.eks_v2.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

    • 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:

    • 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

    • 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

    • 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:

    • kubectlProviderOptions

      @Stability(Stable) public Cluster.Builder kubectlProviderOptions(KubectlProviderOptions kubectlProviderOptions)
      Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster.

      If defined, kubectlLayer is a required property.

      Default: - kubectl provider will not be created

      Parameters:
      kubectlProviderOptions - Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster. 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:

    • 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

    • 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

    • 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

    • 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

    • 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:

    • 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

    • 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

    • 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 if the mode is not EKS Auto Mode

      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

    • compute

      @Stability(Stable) public Cluster.Builder compute(ComputeConfig compute)
      Configuration for compute settings in Auto Mode.

      When enabled, EKS will automatically manage compute resources.

      Default: - Auto Mode compute disabled

      Parameters:
      compute - Configuration for compute settings in Auto Mode. 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: AUTOMODE

      Parameters:
      defaultCapacityType - The default capacity type for the cluster. 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, if applicable, the ARN of the masters IAM role.

      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

    • build

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