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

(experimental) A fluent builder for Cluster.

Method Summary

Modifier and Type	Method and Description
Cluster	build()
Cluster.Builder	clusterHandlerEnvironment(Map<String,String> clusterHandlerEnvironment) (experimental) Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
Cluster.Builder	clusterName(String clusterName) (experimental) Name for the cluster.
Cluster.Builder	coreDnsComputeType(CoreDnsComputeType coreDnsComputeType) (experimental) 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	create(software.constructs.Construct scope, String id)
Cluster.Builder	defaultCapacity(Number defaultCapacity) (experimental) Number of instances to allocate as an initial capacity for this cluster.
Cluster.Builder	defaultCapacityInstance(InstanceType defaultCapacityInstance) (experimental) The instance type to use for the default capacity.
Cluster.Builder	defaultCapacityType(DefaultCapacityType defaultCapacityType) (experimental) The default capacity type for the cluster.
Cluster.Builder	endpointAccess(EndpointAccess endpointAccess) (experimental) Configure access to the Kubernetes API server endpoint..
Cluster.Builder	kubectlEnvironment(Map<String,String> kubectlEnvironment) (experimental) Environment variables for the kubectl execution.
Cluster.Builder	kubectlLayer(ILayerVersion kubectlLayer) (experimental) An AWS Lambda Layer which includes `kubectl`, Helm and the AWS CLI.
Cluster.Builder	kubectlMemory(Size kubectlMemory) (experimental) Amount of memory to allocate to the provider's lambda function.
Cluster.Builder	mastersRole(IRole mastersRole) (experimental) An IAM role that will be added to the `system:masters` Kubernetes RBAC group.
Cluster.Builder	outputClusterName(Boolean outputClusterName) (experimental) Determines whether a CloudFormation output with the name of the cluster will be synthesized.
Cluster.Builder	outputConfigCommand(Boolean outputConfigCommand) (experimental) Determines whether a CloudFormation output with the `aws eks update-kubeconfig` command will be synthesized.
Cluster.Builder	outputMastersRoleArn(Boolean outputMastersRoleArn) (experimental) Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if `mastersRole` is specified).
Cluster.Builder	placeClusterHandlerInVpc(Boolean placeClusterHandlerInVpc) (experimental) 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.
Cluster.Builder	prune(Boolean prune) (experimental) Indicates whether Kubernetes resources added through `addManifest()` can be automatically pruned.
Cluster.Builder	role(IRole role) (experimental) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
Cluster.Builder	secretsEncryptionKey(IKey secretsEncryptionKey) (experimental) KMS secret for envelope encryption for Kubernetes secrets.
Cluster.Builder	securityGroup(ISecurityGroup securityGroup) (experimental) Security Group to use for Control Plane ENIs.
Cluster.Builder	version(KubernetesVersion version) (experimental) The Kubernetes version to run in the cluster.
Cluster.Builder	vpc(IVpc vpc) (experimental) The VPC in which to create the Cluster.
Cluster.Builder	vpcSubnets(List<? extends SubnetSelection> vpcSubnets) (experimental) Where to place EKS Control Plane ENIs.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

(experimental) 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(value=Experimental)
public Cluster.Builder clusterName(String clusterName)

(experimental) Name for the cluster.

Default: - Automatically generated name

Parameters:

clusterName - Name for the cluster. This parameter is required.

Returns:

this

outputClusterName

@Stability(value=Experimental)
public Cluster.Builder outputClusterName(Boolean outputClusterName)

(experimental) 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(value=Experimental)
public Cluster.Builder outputConfigCommand(Boolean outputConfigCommand)

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

role

@Stability(value=Experimental)
public Cluster.Builder role(IRole role)

(experimental) 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(value=Experimental)
public Cluster.Builder securityGroup(ISecurityGroup securityGroup)

(experimental) 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(value=Experimental)
public Cluster.Builder vpc(IVpc vpc)

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

(experimental) 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 }
 ]
 

Default: - All public and private subnets

Parameters:

vpcSubnets - Where to place EKS Control Plane ENIs. This parameter is required.

Returns:

this

clusterHandlerEnvironment

@Stability(value=Experimental)
public Cluster.Builder clusterHandlerEnvironment(Map<String,String> clusterHandlerEnvironment)

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

coreDnsComputeType

@Stability(value=Experimental)
public Cluster.Builder coreDnsComputeType(CoreDnsComputeType coreDnsComputeType)

(experimental) 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(value=Experimental)
public Cluster.Builder endpointAccess(EndpointAccess endpointAccess)

(experimental) 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:

https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

kubectlEnvironment

@Stability(value=Experimental)
public Cluster.Builder kubectlEnvironment(Map<String,String> kubectlEnvironment)

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

@Stability(value=Experimental)
public Cluster.Builder kubectlLayer(ILayerVersion kubectlLayer)

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

Default: - the layer provided by the `aws-lambda-layer-kubectl` SAR app.

Parameters:

kubectlLayer - An AWS Lambda Layer which includes `kubectl`, Helm and the AWS CLI. This parameter is required.

Returns:

this

See Also:

https://github.com/aws-samples/aws-lambda-layer-kubectl

kubectlMemory

@Stability(value=Experimental)
public Cluster.Builder kubectlMemory(Size kubectlMemory)

(experimental) 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(value=Experimental)
public Cluster.Builder mastersRole(IRole mastersRole)

(experimental) An IAM role that will be added to the `system:masters` Kubernetes RBAC group.

Default: - a role that assumable by anyone with permissions in the same account will automatically be defined

Parameters:

mastersRole - An IAM role that will be added to the `system:masters` Kubernetes RBAC group. This parameter is required.

Returns:

this

See Also:

https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings

outputMastersRoleArn

@Stability(value=Experimental)
public Cluster.Builder outputMastersRoleArn(Boolean outputMastersRoleArn)

(experimental) 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(value=Experimental)
public Cluster.Builder placeClusterHandlerInVpc(Boolean placeClusterHandlerInVpc)

(experimental) 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(value=Experimental)
public Cluster.Builder prune(Boolean prune)

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

secretsEncryptionKey

@Stability(value=Experimental)
public Cluster.Builder secretsEncryptionKey(IKey secretsEncryptionKey)

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

defaultCapacity

@Stability(value=Experimental)
public Cluster.Builder defaultCapacity(Number defaultCapacity)

(experimental) 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(value=Experimental)
public Cluster.Builder defaultCapacityInstance(InstanceType defaultCapacityInstance)

(experimental) 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(value=Experimental)
public Cluster.Builder defaultCapacityType(DefaultCapacityType defaultCapacityType)

(experimental) The default capacity type for the cluster.

Default: NODEGROUP

Parameters:

defaultCapacityType - The default capacity type for the cluster. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Cluster build()

Specified by:

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