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(value=Experimental)
public static final class ClusterOptions.Builder
extends Object
implements software.amazon.jsii.Builder<ClusterOptions>

A builder for ClusterOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ClusterOptions	build() Builds the configured instance.
ClusterOptions.Builder	clusterHandlerEnvironment(Map<String,String> clusterHandlerEnvironment) Sets the value of ClusterOptions.getClusterHandlerEnvironment()
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	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	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	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 Detail

Builder

public Builder()

Method Detail

clusterHandlerEnvironment

@Stability(value=Experimental)
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

coreDnsComputeType

@Stability(value=Experimental)
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(value=Experimental)
public ClusterOptions.Builder endpointAccess(EndpointAccess endpointAccess)

Sets the value of ClusterOptions.getEndpointAccess()

Parameters:

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

Returns:

this

kubectlEnvironment

@Stability(value=Experimental)
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(value=Experimental)
public ClusterOptions.Builder kubectlLayer(ILayerVersion kubectlLayer)

Sets the value of ClusterOptions.getKubectlLayer()

Parameters:

kubectlLayer - An AWS Lambda Layer which includes `kubectl`, Helm and the AWS CLI. By default, the provider will use the layer included in the "aws-lambda-layer-kubectl" SAR application which is available in all commercial regions.

To deploy the layer locally, visit https://github.com/aws-samples/aws-lambda-layer-kubectl/blob/master/cdk/README.md for instructions on how to prepare the .zip file and then define it in your app as follows:

                     // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
                     LayerVersion layer = new LayerVersion(this, "kubectl-layer", new LayerVersionProps()
                             .code(lambda.Code.fromAsset(String.format("%s/layer.zip", __dirname))));
                     Object compatibleRuntimes;
                     

Returns:

this

kubectlMemory

@Stability(value=Experimental)
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(value=Experimental)
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

outputMastersRoleArn

@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
public ClusterOptions.Builder secretsEncryptionKey(IKey secretsEncryptionKey)

Sets the value of ClusterOptions.getSecretsEncryptionKey()

Parameters:

secretsEncryptionKey - KMS secret for envelope encryption for Kubernetes secrets.

Returns:

this

version

@Stability(value=Experimental)
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(value=Experimental)
public ClusterOptions.Builder clusterName(String clusterName)

Sets the value of CommonClusterOptions.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

outputClusterName

@Stability(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
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(value=Experimental)
public ClusterOptions.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets)

Sets the value of CommonClusterOptions.getVpcSubnets()

Parameters:

vpcSubnets - Where to place EKS Control Plane ENIs. If you want to create public load balancers, this must include public subnets.

For example, to only select private subnets, supply the following:

                   // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
                   vpcSubnets: [
                      { subnetType: ec2.SubnetType.Private }
                   ]
                   

Returns:

this

build

@Stability(value=Experimental)
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