software.amazon.awscdk.services.eks

Class LegacyCluster.Builder

java.lang.Object

software.amazon.awscdk.services.eks.LegacyCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LegacyCluster>

Enclosing class:

LegacyCluster

@Stability(value=Experimental)
public static final class LegacyCluster.Builder
extends Object
implements software.amazon.jsii.Builder<LegacyCluster>

(experimental) A fluent builder for LegacyCluster.

Method Summary

Modifier and Type	Method and Description
LegacyCluster	build()
LegacyCluster.Builder	clusterName(String clusterName) (experimental) Name for the cluster.
static LegacyCluster.Builder	create(software.constructs.Construct scope, String id)
LegacyCluster.Builder	defaultCapacity(Number defaultCapacity) (experimental) Number of instances to allocate as an initial capacity for this cluster.
LegacyCluster.Builder	defaultCapacityInstance(InstanceType defaultCapacityInstance) (experimental) The instance type to use for the default capacity.
LegacyCluster.Builder	defaultCapacityType(DefaultCapacityType defaultCapacityType) (experimental) The default capacity type for the cluster.
LegacyCluster.Builder	outputClusterName(Boolean outputClusterName) (experimental) Determines whether a CloudFormation output with the name of the cluster will be synthesized.
LegacyCluster.Builder	outputConfigCommand(Boolean outputConfigCommand) (experimental) Determines whether a CloudFormation output with the `aws eks update-kubeconfig` command will be synthesized.
LegacyCluster.Builder	role(IRole role) (experimental) Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
LegacyCluster.Builder	secretsEncryptionKey(IKey secretsEncryptionKey) (experimental) KMS secret for envelope encryption for Kubernetes secrets.
LegacyCluster.Builder	securityGroup(ISecurityGroup securityGroup) (experimental) Security Group to use for Control Plane ENIs.
LegacyCluster.Builder	version(KubernetesVersion version) (experimental) The Kubernetes version to run in the cluster.
LegacyCluster.Builder	vpc(IVpc vpc) (experimental) The VPC in which to create the Cluster.
LegacyCluster.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 LegacyCluster.Builder create(software.constructs.Construct scope,
                                                                          String id)

Parameters:

scope - a Construct, most likely a cdk.Stack created. This parameter is required.

id - This parameter is required.

Returns:

a new instance of LegacyCluster.Builder.

version

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

defaultCapacity

@Stability(value=Experimental)
public LegacyCluster.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.addCapacity 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 LegacyCluster.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 LegacyCluster.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

secretsEncryptionKey

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

build

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

Specified by:

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