Package software.amazon.awscdk.services.eks

Class CommonClusterOptions.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CommonClusterOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CommonClusterOptions>

Enclosing interface:

CommonClusterOptions

@Stability(Stable)
public static final class CommonClusterOptions.Builder
extends Object
implements software.amazon.jsii.Builder<CommonClusterOptions>

A builder for CommonClusterOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CommonClusterOptions	build()	Builds the configured instance.
CommonClusterOptions.Builder	clusterName(String clusterName)	Sets the value of CommonClusterOptions.getClusterName()
CommonClusterOptions.Builder	outputClusterName(Boolean outputClusterName)	Sets the value of CommonClusterOptions.getOutputClusterName()
CommonClusterOptions.Builder	outputConfigCommand(Boolean outputConfigCommand)	Sets the value of CommonClusterOptions.getOutputConfigCommand()
CommonClusterOptions.Builder	role(IRole role)	Sets the value of CommonClusterOptions.getRole()
CommonClusterOptions.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of CommonClusterOptions.getSecurityGroup()
CommonClusterOptions.Builder	version(KubernetesVersion version)	Sets the value of CommonClusterOptions.getVersion()
CommonClusterOptions.Builder	vpc(IVpc vpc)	Sets the value of CommonClusterOptions.getVpc()
CommonClusterOptions.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 Details

Builder

public Builder()

Method Details

version

@Stability(Stable)
public CommonClusterOptions.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(Stable)
public CommonClusterOptions.Builder clusterName(String clusterName)

Sets the value of CommonClusterOptions.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

outputClusterName

@Stability(Stable)
public CommonClusterOptions.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(Stable)
public CommonClusterOptions.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 the ARN of the masters IAM role.

Note: If mastersRole is not specified, this property will be ignored and no config command will be emitted.

Returns:

this

role

@Stability(Stable)
public CommonClusterOptions.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(Stable)
public CommonClusterOptions.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of CommonClusterOptions.getSecurityGroup()

Parameters:

securityGroup - Security Group to use for Control Plane ENIs.

Returns:

this

vpc

@Stability(Stable)
public CommonClusterOptions.Builder vpc(IVpc vpc)

Sets the value of CommonClusterOptions.getVpc()

Parameters:

vpc - The VPC in which to create the Cluster.

Returns:

this

vpcSubnets

@Stability(Stable)
public CommonClusterOptions.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets)

Sets the value of CommonClusterOptions.getVpcSubnets()

Parameters:

vpcSubnets - Where to place EKS Control Plane ENIs. For example, to only select private subnets, supply the following:

vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]

Returns:

this

build

@Stability(Stable)
public CommonClusterOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CommonClusterOptions

Throws:

NullPointerException - if any required attribute was not provided