Package software.amazon.awscdk.services.eks

Class ClusterOptions.Builder

java.lang.Object

software.amazon.awscdk.services.eks.ClusterOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ClusterOptions>

Enclosing interface:

ClusterOptions

@Stability(Stable)
public static final class ClusterOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ClusterOptions>

A builder for ClusterOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterOptions.Builder	albController(AlbControllerOptions albController)	Sets the value of ClusterOptions.getAlbController()
ClusterOptions.Builder	authenticationMode(AuthenticationMode authenticationMode)	Sets the value of ClusterOptions.getAuthenticationMode()
ClusterOptions.Builder	awscliLayer(ILayerVersion awscliLayer)	Sets the value of ClusterOptions.getAwscliLayer()
ClusterOptions	build()	Builds the configured instance.
ClusterOptions.Builder	clusterHandlerEnvironment(Map<String,String> clusterHandlerEnvironment)	Sets the value of ClusterOptions.getClusterHandlerEnvironment()
ClusterOptions.Builder	clusterHandlerSecurityGroup(ISecurityGroup clusterHandlerSecurityGroup)	Sets the value of ClusterOptions.getClusterHandlerSecurityGroup()
ClusterOptions.Builder	clusterLogging(List<? extends ClusterLoggingTypes> clusterLogging)	Sets the value of ClusterOptions.getClusterLogging()
ClusterOptions.Builder	clusterName(String clusterName)	Sets the value of CommonClusterOptions.getClusterName()
ClusterOptions.Builder	coreDnsComputeType(CoreDnsComputeType coreDnsComputeType)	Sets the value of ClusterOptions.getCoreDnsComputeType()
ClusterOptions.Builder	endpointAccess(EndpointAccess endpointAccess)	Sets the value of ClusterOptions.getEndpointAccess()
ClusterOptions.Builder	ipFamily(IpFamily ipFamily)	Sets the value of ClusterOptions.getIpFamily()
ClusterOptions.Builder	kubectlEnvironment(Map<String,String> kubectlEnvironment)	Sets the value of ClusterOptions.getKubectlEnvironment()
ClusterOptions.Builder	kubectlLayer(ILayerVersion kubectlLayer)	Sets the value of ClusterOptions.getKubectlLayer()
ClusterOptions.Builder	kubectlMemory(Size kubectlMemory)	Sets the value of ClusterOptions.getKubectlMemory()
ClusterOptions.Builder	mastersRole(IRole mastersRole)	Sets the value of ClusterOptions.getMastersRole()
ClusterOptions.Builder	onEventLayer(ILayerVersion onEventLayer)	Sets the value of ClusterOptions.getOnEventLayer()
ClusterOptions.Builder	outputClusterName(Boolean outputClusterName)	Sets the value of CommonClusterOptions.getOutputClusterName()
ClusterOptions.Builder	outputConfigCommand(Boolean outputConfigCommand)	Sets the value of CommonClusterOptions.getOutputConfigCommand()
ClusterOptions.Builder	outputMastersRoleArn(Boolean outputMastersRoleArn)	Sets the value of ClusterOptions.getOutputMastersRoleArn()
ClusterOptions.Builder	placeClusterHandlerInVpc(Boolean placeClusterHandlerInVpc)	Sets the value of ClusterOptions.getPlaceClusterHandlerInVpc()
ClusterOptions.Builder	prune(Boolean prune)	Sets the value of ClusterOptions.getPrune()
ClusterOptions.Builder	role(IRole role)	Sets the value of CommonClusterOptions.getRole()
ClusterOptions.Builder	secretsEncryptionKey(IKey secretsEncryptionKey)	Sets the value of ClusterOptions.getSecretsEncryptionKey()
ClusterOptions.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of CommonClusterOptions.getSecurityGroup()
ClusterOptions.Builder	serviceIpv4Cidr(String serviceIpv4Cidr)	Sets the value of ClusterOptions.getServiceIpv4Cidr()
ClusterOptions.Builder	version(KubernetesVersion version)	Sets the value of CommonClusterOptions.getVersion()
ClusterOptions.Builder	vpc(IVpc vpc)	Sets the value of CommonClusterOptions.getVpc()
ClusterOptions.Builder	vpcSubnets(List<? extends SubnetSelection> vpcSubnets)	Sets the value of CommonClusterOptions.getVpcSubnets()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

albController

@Stability(Stable)
public ClusterOptions.Builder albController(AlbControllerOptions albController)

Sets the value of ClusterOptions.getAlbController()

Parameters:

albController - Install the AWS Load Balancer Controller onto the cluster.

Returns:

this

authenticationMode

@Stability(Stable)
public ClusterOptions.Builder authenticationMode(AuthenticationMode authenticationMode)

Sets the value of ClusterOptions.getAuthenticationMode()

Parameters:

authenticationMode - The desired authentication mode for the cluster.

Returns:

this

awscliLayer

@Stability(Stable)
public ClusterOptions.Builder awscliLayer(ILayerVersion awscliLayer)

Sets the value of ClusterOptions.getAwscliLayer()

Parameters:

awscliLayer - An AWS Lambda layer that contains the aws CLI. The handler expects the layer to include the following executables:

                    /opt/awscli/aws
                    

Returns:

this

clusterHandlerEnvironment

@Stability(Stable)
public ClusterOptions.Builder clusterHandlerEnvironment(Map<String,String> clusterHandlerEnvironment)

Sets the value of ClusterOptions.getClusterHandlerEnvironment()

Parameters:

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

Returns:

this

clusterHandlerSecurityGroup

@Stability(Stable)
public ClusterOptions.Builder clusterHandlerSecurityGroup(ISecurityGroup clusterHandlerSecurityGroup)

Sets the value of ClusterOptions.getClusterHandlerSecurityGroup()

Parameters:

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.

Returns:

this

clusterLogging

@Stability(Stable)
public ClusterOptions.Builder clusterLogging(List<? extends ClusterLoggingTypes> clusterLogging)

Sets the value of ClusterOptions.getClusterLogging()

Parameters:

clusterLogging - The cluster log types which you want to enable.

Returns:

this

coreDnsComputeType

@Stability(Stable)
public ClusterOptions.Builder coreDnsComputeType(CoreDnsComputeType coreDnsComputeType)

Sets the value of ClusterOptions.getCoreDnsComputeType()

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.

Returns:

this

endpointAccess

@Stability(Stable)
public ClusterOptions.Builder endpointAccess(EndpointAccess endpointAccess)

Sets the value of ClusterOptions.getEndpointAccess()

Parameters:

endpointAccess - Configure access to the Kubernetes API server endpoint..

Returns:

this

ipFamily

@Stability(Stable)
public ClusterOptions.Builder ipFamily(IpFamily ipFamily)

Sets the value of ClusterOptions.getIpFamily()

Parameters:

ipFamily - Specify which IP family is used to assign Kubernetes pod and service IP addresses.

Returns:

this

kubectlEnvironment

@Stability(Stable)
public ClusterOptions.Builder kubectlEnvironment(Map<String,String> kubectlEnvironment)

Sets the value of ClusterOptions.getKubectlEnvironment()

Parameters:

kubectlEnvironment - Environment variables for the kubectl execution. Only relevant for kubectl enabled clusters.

Returns:

this

kubectlLayer

@Stability(Stable)
public ClusterOptions.Builder kubectlLayer(ILayerVersion kubectlLayer)

Sets the value of ClusterOptions.getKubectlLayer()

Parameters:

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. If you don't supply this value kubectl 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
                     

Returns:

this

kubectlMemory

@Stability(Stable)
public ClusterOptions.Builder kubectlMemory(Size kubectlMemory)

Sets the value of ClusterOptions.getKubectlMemory()

Parameters:

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

Returns:

this

mastersRole

@Stability(Stable)
public ClusterOptions.Builder mastersRole(IRole mastersRole)

Sets the value of ClusterOptions.getMastersRole()

Parameters:

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

Returns:

this

onEventLayer

@Stability(Stable)
public ClusterOptions.Builder onEventLayer(ILayerVersion onEventLayer)

Sets the value of ClusterOptions.getOnEventLayer()

Parameters:

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();
                     

Returns:

this

outputMastersRoleArn

@Stability(Stable)
public ClusterOptions.Builder outputMastersRoleArn(Boolean outputMastersRoleArn)

Sets the value of ClusterOptions.getOutputMastersRoleArn()

Parameters:

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

Returns:

this

placeClusterHandlerInVpc

@Stability(Stable)
public ClusterOptions.Builder placeClusterHandlerInVpc(Boolean placeClusterHandlerInVpc)

Sets the value of ClusterOptions.getPlaceClusterHandlerInVpc()

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.

Returns:

this

prune

@Stability(Stable)
public ClusterOptions.Builder prune(Boolean prune)

Sets the value of ClusterOptions.getPrune()

Parameters:

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.

Returns:

this

secretsEncryptionKey

@Stability(Stable)
public ClusterOptions.Builder secretsEncryptionKey(IKey secretsEncryptionKey)

Sets the value of ClusterOptions.getSecretsEncryptionKey()

Parameters:

secretsEncryptionKey - KMS secret for envelope encryption for Kubernetes secrets.

Returns:

this

serviceIpv4Cidr

@Stability(Stable)
public ClusterOptions.Builder serviceIpv4Cidr(String serviceIpv4Cidr)

Sets the value of ClusterOptions.getServiceIpv4Cidr()

Parameters:

serviceIpv4Cidr - The CIDR block to assign Kubernetes service IP addresses from.

Returns:

this

version

@Stability(Stable)
public ClusterOptions.Builder version(KubernetesVersion version)

Sets the value of CommonClusterOptions.getVersion()

Parameters:

version - The Kubernetes version to run in the cluster. This parameter is required.

Returns:

this

clusterName

@Stability(Stable)
public ClusterOptions.Builder clusterName(String clusterName)

Sets the value of CommonClusterOptions.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

outputClusterName

@Stability(Stable)
public ClusterOptions.Builder outputClusterName(Boolean outputClusterName)

Sets the value of CommonClusterOptions.getOutputClusterName()

Parameters:

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

Returns:

this

outputConfigCommand

@Stability(Stable)
public ClusterOptions.Builder outputConfigCommand(Boolean outputConfigCommand)

Sets the value of CommonClusterOptions.getOutputConfigCommand()

Parameters:

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.

Returns:

this

role

@Stability(Stable)
public ClusterOptions.Builder role(IRole role)

Sets the value of CommonClusterOptions.getRole()

Parameters:

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

Returns:

this

securityGroup

@Stability(Stable)
public ClusterOptions.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of CommonClusterOptions.getSecurityGroup()

Parameters:

securityGroup - Security Group to use for Control Plane ENIs.

Returns:

this

vpc

@Stability(Stable)
public ClusterOptions.Builder vpc(IVpc vpc)

Sets the value of CommonClusterOptions.getVpc()

Parameters:

vpc - The VPC in which to create the Cluster.

Returns:

this

vpcSubnets

@Stability(Stable)
public ClusterOptions.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets)

Sets the value of CommonClusterOptions.getVpcSubnets()

Parameters:

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 }]

Returns:

this

build

@Stability(Stable)
public ClusterOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ClusterOptions>

Returns:

a new instance of ClusterOptions

Throws:

NullPointerException - if any required attribute was not provided