software.amazon.awscdk.services.eks.legacy

Class ClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.legacy.ClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ClusterProps>

Enclosing interface:

ClusterProps

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

A builder for ClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ClusterProps	build() Builds the configured instance.
ClusterProps.Builder	clusterName(String clusterName) Sets the value of ClusterProps.getClusterName()
ClusterProps.Builder	defaultCapacity(Number defaultCapacity) Sets the value of ClusterProps.getDefaultCapacity()
ClusterProps.Builder	defaultCapacityInstance(InstanceType defaultCapacityInstance) Sets the value of ClusterProps.getDefaultCapacityInstance()
ClusterProps.Builder	kubectlEnabled(Boolean kubectlEnabled) Sets the value of ClusterProps.getKubectlEnabled()
ClusterProps.Builder	mastersRole(IRole mastersRole) Sets the value of ClusterProps.getMastersRole()
ClusterProps.Builder	outputClusterName(Boolean outputClusterName) Sets the value of ClusterProps.getOutputClusterName()
ClusterProps.Builder	outputConfigCommand(Boolean outputConfigCommand) Sets the value of ClusterProps.getOutputConfigCommand()
ClusterProps.Builder	outputMastersRoleArn(Boolean outputMastersRoleArn) Sets the value of ClusterProps.getOutputMastersRoleArn()
ClusterProps.Builder	role(IRole role) Sets the value of ClusterProps.getRole()
ClusterProps.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of ClusterProps.getSecurityGroup()
ClusterProps.Builder	version(String version) Sets the value of ClusterProps.getVersion()
ClusterProps.Builder	vpc(IVpc vpc) Sets the value of ClusterProps.getVpc()
ClusterProps.Builder	vpcSubnets(List<? extends SubnetSelection> vpcSubnets) Sets the value of ClusterProps.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

clusterName

@Stability(value=Experimental)
public ClusterProps.Builder clusterName(String clusterName)

Sets the value of ClusterProps.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

defaultCapacity

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

Sets the value of ClusterProps.getDefaultCapacity()

Parameters:

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.addCapacity to add additional customized capacity. Set this to 0 is you wish to avoid the initial capacity allocation.

Returns:

this

defaultCapacityInstance

@Stability(value=Experimental)
public ClusterProps.Builder defaultCapacityInstance(InstanceType defaultCapacityInstance)

Sets the value of ClusterProps.getDefaultCapacityInstance()

Parameters:

defaultCapacityInstance - The instance type to use for the default capacity. This will only be taken into account if defaultCapacity is > 0.

Returns:

this

kubectlEnabled

@Stability(value=Experimental)
public ClusterProps.Builder kubectlEnabled(Boolean kubectlEnabled)

Sets the value of ClusterProps.getKubectlEnabled()

Parameters:

kubectlEnabled - Allows defining `kubectrl`-related resources on this cluster. If this is disabled, it will not be possible to use the following capabilities:

• addResource
• addRoleMapping
• addUserMapping
• addMastersRole and props.mastersRole

If this is disabled, the cluster can only be managed by issuing kubectl commands from a session that uses the IAM role/user that created the account.

NOTE: changing this value will destoy the cluster. This is because a managable cluster must be created using an AWS CloudFormation custom resource which executes with an IAM role owned by the CDK app.

Returns:

this

mastersRole

@Stability(value=Experimental)
public ClusterProps.Builder mastersRole(IRole mastersRole)

Sets the value of ClusterProps.getMastersRole()

Parameters:

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

Returns:

this

outputClusterName

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

Sets the value of ClusterProps.getOutputClusterName()

Parameters:

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

Returns:

this

outputConfigCommand

@Stability(value=Experimental)
public ClusterProps.Builder outputConfigCommand(Boolean outputConfigCommand)

Sets the value of ClusterProps.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

outputMastersRoleArn

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

Sets the value of ClusterProps.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

role

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

Sets the value of ClusterProps.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 ClusterProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of ClusterProps.getSecurityGroup()

Parameters:

securityGroup - Security Group to use for Control Plane ENIs.

Returns:

this

version

@Stability(value=Experimental)
public ClusterProps.Builder version(String version)

Sets the value of ClusterProps.getVersion()

Parameters:

version - The Kubernetes version to run in the cluster.

Returns:

this

vpc

@Stability(value=Experimental)
public ClusterProps.Builder vpc(IVpc vpc)

Sets the value of ClusterProps.getVpc()

Parameters:

vpc - The VPC in which to create the Cluster.

Returns:

this

vpcSubnets

@Stability(value=Experimental)
public ClusterProps.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets)

Sets the value of ClusterProps.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:

                   Map<String, SubnetType>[] vpcSubnets = List.of(Map.of("subnetType", SubnetType.PRIVATE_WITH_NAT));
                   

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ClusterProps

Throws:

NullPointerException - if any required attribute was not provided