software.amazon.awscdk.services.eks

Class ClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.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 CommonClusterOptions.getClusterName()
ClusterProps.Builder	coreDnsComputeType(CoreDnsComputeType coreDnsComputeType) Sets the value of ClusterOptions.getCoreDnsComputeType()
ClusterProps.Builder	defaultCapacity(Number defaultCapacity) Sets the value of ClusterProps.getDefaultCapacity()
ClusterProps.Builder	defaultCapacityInstance(InstanceType defaultCapacityInstance) Sets the value of ClusterProps.getDefaultCapacityInstance()
ClusterProps.Builder	defaultCapacityType(DefaultCapacityType defaultCapacityType) Sets the value of ClusterProps.getDefaultCapacityType()
ClusterProps.Builder	endpointAccess(EndpointAccess endpointAccess) Sets the value of ClusterOptions.getEndpointAccess()
ClusterProps.Builder	kubectlEnabled(Boolean kubectlEnabled) Deprecated. `eks.LegacyCluster` is __temporarily__ provided as a drop-in replacement until you are able to migrate to `eks.Cluster`.
ClusterProps.Builder	kubectlEnvironment(Map<String,String> kubectlEnvironment) Sets the value of ClusterOptions.getKubectlEnvironment()
ClusterProps.Builder	kubectlLayer(ILayerVersion kubectlLayer) Sets the value of ClusterOptions.getKubectlLayer()
ClusterProps.Builder	mastersRole(IRole mastersRole) Sets the value of ClusterOptions.getMastersRole()
ClusterProps.Builder	outputClusterName(Boolean outputClusterName) Sets the value of CommonClusterOptions.getOutputClusterName()
ClusterProps.Builder	outputConfigCommand(Boolean outputConfigCommand) Sets the value of CommonClusterOptions.getOutputConfigCommand()
ClusterProps.Builder	outputMastersRoleArn(Boolean outputMastersRoleArn) Sets the value of ClusterOptions.getOutputMastersRoleArn()
ClusterProps.Builder	role(IRole role) Sets the value of CommonClusterOptions.getRole()
ClusterProps.Builder	secretsEncryptionKey(IKey secretsEncryptionKey) Sets the value of ClusterProps.getSecretsEncryptionKey()
ClusterProps.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of CommonClusterOptions.getSecurityGroup()
ClusterProps.Builder	version(KubernetesVersion version) Sets the value of CommonClusterOptions.getVersion()
ClusterProps.Builder	vpc(IVpc vpc) Sets the value of CommonClusterOptions.getVpc()
ClusterProps.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 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.addAutoScalingGroupCapacity 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

defaultCapacityType

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

Sets the value of ClusterProps.getDefaultCapacityType()

Parameters:

defaultCapacityType - The default capacity type for the cluster.

Returns:

this

kubectlEnabled

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

Deprecated. `eks.LegacyCluster` is __temporarily__ provided as a drop-in replacement until you are able to migrate to `eks.Cluster`.

Sets the value of ClusterProps.getKubectlEnabled()

Parameters:

kubectlEnabled - NOT SUPPORTED: We no longer allow disabling kubectl-support. Setting this option to `false` will throw an error. To temporary allow you to retain existing clusters created with kubectlEnabled: false, you can use eks.LegacyCluster class, which is a drop-in replacement for eks.Cluster with kubectlEnabled: false.

Bear in mind that this is a temporary workaround. We have plans to remove eks.LegacyCluster. If you have a use case for using eks.LegacyCluster, please add a comment here https://github.com/aws/aws-cdk/issues/9332 and let us know so we can make sure to continue to support your use case with eks.Cluster. This issue also includes additional context into why this class is being removed.

Returns:

this

secretsEncryptionKey

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

Sets the value of ClusterProps.getSecretsEncryptionKey()

Parameters:

secretsEncryptionKey - KMS secret for envelope encryption for Kubernetes secrets.

Returns:

this

coreDnsComputeType

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

Sets the value of ClusterOptions.getCoreDnsComputeType()

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.

Returns:

this

endpointAccess

@Stability(value=Experimental)
public ClusterProps.Builder endpointAccess(EndpointAccess endpointAccess)

Sets the value of ClusterOptions.getEndpointAccess()

Parameters:

endpointAccess - Configure access to the Kubernetes API server endpoint..

Returns:

this

kubectlEnvironment

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

Sets the value of ClusterOptions.getKubectlEnvironment()

Parameters:

kubectlEnvironment - Environment variables for the kubectl execution. Only relevant for kubectl enabled clusters.

Returns:

this

kubectlLayer

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

Sets the value of ClusterOptions.getKubectlLayer()

Parameters:

kubectlLayer - 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
                     var layer = LayerVersion.Builder.create(this, "kubectl-layer")
                             .code(lambda.Code.fromAsset(__dirname + "/layer.zip"))
                             .build();
                     var compatibleRuntimes = ;
                     

Returns:

this

mastersRole

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

Sets the value of ClusterOptions.getMastersRole()

Parameters:

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

Returns:

this

outputMastersRoleArn

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

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

version

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

Sets the value of CommonClusterOptions.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

outputClusterName

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