software.amazon.awscdk.services.eks

Class LegacyClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.LegacyClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LegacyClusterProps>

Enclosing interface:

LegacyClusterProps

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

A builder for LegacyClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LegacyClusterProps	build() Builds the configured instance.
LegacyClusterProps.Builder	clusterName(String clusterName) Sets the value of CommonClusterOptions.getClusterName()
LegacyClusterProps.Builder	defaultCapacity(Number defaultCapacity) Sets the value of LegacyClusterProps.getDefaultCapacity()
LegacyClusterProps.Builder	defaultCapacityInstance(InstanceType defaultCapacityInstance) Sets the value of LegacyClusterProps.getDefaultCapacityInstance()
LegacyClusterProps.Builder	defaultCapacityType(DefaultCapacityType defaultCapacityType) Sets the value of LegacyClusterProps.getDefaultCapacityType()
LegacyClusterProps.Builder	outputClusterName(Boolean outputClusterName) Sets the value of CommonClusterOptions.getOutputClusterName()
LegacyClusterProps.Builder	outputConfigCommand(Boolean outputConfigCommand) Sets the value of CommonClusterOptions.getOutputConfigCommand()
LegacyClusterProps.Builder	role(IRole role) Sets the value of CommonClusterOptions.getRole()
LegacyClusterProps.Builder	secretsEncryptionKey(IKey secretsEncryptionKey) Sets the value of LegacyClusterProps.getSecretsEncryptionKey()
LegacyClusterProps.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of CommonClusterOptions.getSecurityGroup()
LegacyClusterProps.Builder	version(KubernetesVersion version) Sets the value of CommonClusterOptions.getVersion()
LegacyClusterProps.Builder	vpc(IVpc vpc) Sets the value of CommonClusterOptions.getVpc()
LegacyClusterProps.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

defaultCapacity

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

Sets the value of LegacyClusterProps.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 LegacyClusterProps.Builder defaultCapacityInstance(InstanceType defaultCapacityInstance)

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

defaultCapacityType

@Stability(value=Experimental)
public LegacyClusterProps.Builder defaultCapacityType(DefaultCapacityType defaultCapacityType)

Sets the value of LegacyClusterProps.getDefaultCapacityType()

Parameters:

defaultCapacityType - The default capacity type for the cluster.

Returns:

this

secretsEncryptionKey

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

Sets the value of LegacyClusterProps.getSecretsEncryptionKey()

Parameters:

secretsEncryptionKey - KMS secret for envelope encryption for Kubernetes secrets.

Returns:

this

version

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

Sets the value of CommonClusterOptions.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

outputClusterName

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of LegacyClusterProps

Throws:

NullPointerException - if any required attribute was not provided