Package software.amazon.awscdk.services.eks.v2.alpha

Class FargateClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.v2.alpha.FargateClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateClusterProps>

Enclosing interface:

FargateClusterProps

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

A builder for FargateClusterProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FargateClusterProps.Builder	albController(AlbControllerOptions albController)	Sets the value of ClusterCommonOptions.getAlbController()
FargateClusterProps	build()	Builds the configured instance.
FargateClusterProps.Builder	clusterLogging(List<? extends ClusterLoggingTypes> clusterLogging)	Sets the value of ClusterCommonOptions.getClusterLogging()
FargateClusterProps.Builder	clusterName(String clusterName)	Sets the value of ClusterCommonOptions.getClusterName()
FargateClusterProps.Builder	coreDnsComputeType(CoreDnsComputeType coreDnsComputeType)	Sets the value of ClusterCommonOptions.getCoreDnsComputeType()
FargateClusterProps.Builder	defaultProfile(FargateProfileOptions defaultProfile)	Sets the value of FargateClusterProps.getDefaultProfile()
FargateClusterProps.Builder	endpointAccess(EndpointAccess endpointAccess)	Sets the value of ClusterCommonOptions.getEndpointAccess()
FargateClusterProps.Builder	ipFamily(IpFamily ipFamily)	Sets the value of ClusterCommonOptions.getIpFamily()
FargateClusterProps.Builder	kubectlProviderOptions(KubectlProviderOptions kubectlProviderOptions)	Sets the value of ClusterCommonOptions.getKubectlProviderOptions()
FargateClusterProps.Builder	mastersRole(IRole mastersRole)	Sets the value of ClusterCommonOptions.getMastersRole()
FargateClusterProps.Builder	prune(Boolean prune)	Sets the value of ClusterCommonOptions.getPrune()
FargateClusterProps.Builder	role(IRole role)	Sets the value of ClusterCommonOptions.getRole()
FargateClusterProps.Builder	secretsEncryptionKey(IKey secretsEncryptionKey)	Sets the value of ClusterCommonOptions.getSecretsEncryptionKey()
FargateClusterProps.Builder	securityGroup(ISecurityGroup securityGroup)	Sets the value of ClusterCommonOptions.getSecurityGroup()
FargateClusterProps.Builder	serviceIpv4Cidr(String serviceIpv4Cidr)	Sets the value of ClusterCommonOptions.getServiceIpv4Cidr()
FargateClusterProps.Builder	tags(Map<String,String> tags)	Sets the value of ClusterCommonOptions.getTags()
FargateClusterProps.Builder	version(KubernetesVersion version)	Sets the value of ClusterCommonOptions.getVersion()
FargateClusterProps.Builder	vpc(IVpc vpc)	Sets the value of ClusterCommonOptions.getVpc()
FargateClusterProps.Builder	vpcSubnets(List<? extends SubnetSelection> vpcSubnets)	Sets the value of ClusterCommonOptions.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

defaultProfile

@Stability(Experimental)
public FargateClusterProps.Builder defaultProfile(FargateProfileOptions defaultProfile)

Sets the value of FargateClusterProps.getDefaultProfile()

Parameters:

defaultProfile - Fargate Profile to create along with the cluster.

Returns:

this

version

@Stability(Experimental)
public FargateClusterProps.Builder version(KubernetesVersion version)

Sets the value of ClusterCommonOptions.getVersion()

Parameters:

version - The Kubernetes version to run in the cluster. This parameter is required.

Returns:

this

albController

@Stability(Experimental)
public FargateClusterProps.Builder albController(AlbControllerOptions albController)

Sets the value of ClusterCommonOptions.getAlbController()

Parameters:

albController - Install the AWS Load Balancer Controller onto the cluster.

Returns:

this

clusterLogging

@Stability(Experimental)
public FargateClusterProps.Builder clusterLogging(List<? extends ClusterLoggingTypes> clusterLogging)

Sets the value of ClusterCommonOptions.getClusterLogging()

Parameters:

clusterLogging - The cluster log types which you want to enable.

Returns:

this

clusterName

@Stability(Experimental)
public FargateClusterProps.Builder clusterName(String clusterName)

Sets the value of ClusterCommonOptions.getClusterName()

Parameters:

clusterName - Name for the cluster.

Returns:

this

coreDnsComputeType

@Stability(Experimental)
public FargateClusterProps.Builder coreDnsComputeType(CoreDnsComputeType coreDnsComputeType)

Sets the value of ClusterCommonOptions.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(Experimental)
public FargateClusterProps.Builder endpointAccess(EndpointAccess endpointAccess)

Sets the value of ClusterCommonOptions.getEndpointAccess()

Parameters:

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

Returns:

this

ipFamily

@Stability(Experimental)
public FargateClusterProps.Builder ipFamily(IpFamily ipFamily)

Sets the value of ClusterCommonOptions.getIpFamily()

Parameters:

ipFamily - Specify which IP family is used to assign Kubernetes pod and service IP addresses.

Returns:

this

kubectlProviderOptions

@Stability(Experimental)
public FargateClusterProps.Builder kubectlProviderOptions(KubectlProviderOptions kubectlProviderOptions)

Sets the value of ClusterCommonOptions.getKubectlProviderOptions()

Parameters:

kubectlProviderOptions - Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster. If defined, kubectlLayer is a required property.

If not defined, kubectl provider will not be created by default.

Returns:

this

mastersRole

@Stability(Experimental)
public FargateClusterProps.Builder mastersRole(IRole mastersRole)

Sets the value of ClusterCommonOptions.getMastersRole()

Parameters:

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

Returns:

this

prune

@Stability(Experimental)
public FargateClusterProps.Builder prune(Boolean prune)

Sets the value of ClusterCommonOptions.getPrune()

Parameters:

prune - Indicates whether Kubernetes resources added through addManifest() can be automatically pruned. When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

Returns:

this

role

@Stability(Experimental)
public FargateClusterProps.Builder role(IRole role)

Sets the value of ClusterCommonOptions.getRole()

Parameters:

role - Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

Returns:

this

secretsEncryptionKey

@Stability(Experimental)
public FargateClusterProps.Builder secretsEncryptionKey(IKey secretsEncryptionKey)

Sets the value of ClusterCommonOptions.getSecretsEncryptionKey()

Parameters:

secretsEncryptionKey - KMS secret for envelope encryption for Kubernetes secrets.

Returns:

this

securityGroup

@Stability(Experimental)
public FargateClusterProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of ClusterCommonOptions.getSecurityGroup()

Parameters:

securityGroup - Security Group to use for Control Plane ENIs.

Returns:

this

serviceIpv4Cidr

@Stability(Experimental)
public FargateClusterProps.Builder serviceIpv4Cidr(String serviceIpv4Cidr)

Sets the value of ClusterCommonOptions.getServiceIpv4Cidr()

Parameters:

serviceIpv4Cidr - The CIDR block to assign Kubernetes service IP addresses from.

Returns:

this

tags

@Stability(Experimental)
public FargateClusterProps.Builder tags(Map<String,String> tags)

Sets the value of ClusterCommonOptions.getTags()

Parameters:

tags - The tags assigned to the EKS cluster.

Returns:

this

vpc

@Stability(Experimental)
public FargateClusterProps.Builder vpc(IVpc vpc)

Sets the value of ClusterCommonOptions.getVpc()

Parameters:

vpc - The VPC in which to create the Cluster.

Returns:

this

vpcSubnets

@Stability(Experimental)
public FargateClusterProps.Builder vpcSubnets(List<? extends SubnetSelection> vpcSubnets)

Sets the value of ClusterCommonOptions.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(Experimental)
public FargateClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of FargateClusterProps

Throws:

NullPointerException - if any required attribute was not provided