Package software.amazon.awscdk.services.eks_v2

Class ClusterAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.eks_v2.ClusterAttributes.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ClusterAttributes>

Enclosing interface:

ClusterAttributes

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

A builder for ClusterAttributes

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClusterAttributes	build()	Builds the configured instance.
ClusterAttributes.Builder	clusterCertificateAuthorityData(String clusterCertificateAuthorityData)	Sets the value of ClusterAttributes.getClusterCertificateAuthorityData()
ClusterAttributes.Builder	clusterEncryptionConfigKeyArn(String clusterEncryptionConfigKeyArn)	Sets the value of ClusterAttributes.getClusterEncryptionConfigKeyArn()
ClusterAttributes.Builder	clusterEndpoint(String clusterEndpoint)	Sets the value of ClusterAttributes.getClusterEndpoint()
ClusterAttributes.Builder	clusterName(String clusterName)	Sets the value of ClusterAttributes.getClusterName()
ClusterAttributes.Builder	clusterSecurityGroupId(String clusterSecurityGroupId)	Sets the value of ClusterAttributes.getClusterSecurityGroupId()
ClusterAttributes.Builder	ipFamily(IpFamily ipFamily)	Sets the value of ClusterAttributes.getIpFamily()
ClusterAttributes.Builder	kubectlProvider(IKubectlProvider kubectlProvider)	Sets the value of ClusterAttributes.getKubectlProvider()
ClusterAttributes.Builder	kubectlProviderOptions(KubectlProviderOptions kubectlProviderOptions)	Sets the value of ClusterAttributes.getKubectlProviderOptions()
ClusterAttributes.Builder	openIdConnectProvider(IOpenIdConnectProvider openIdConnectProvider)	Sets the value of ClusterAttributes.getOpenIdConnectProvider()
ClusterAttributes.Builder	prune(Boolean prune)	Sets the value of ClusterAttributes.getPrune()
ClusterAttributes.Builder	securityGroupIds(List<String> securityGroupIds)	Sets the value of ClusterAttributes.getSecurityGroupIds()
ClusterAttributes.Builder	vpc(IVpc vpc)	Sets the value of ClusterAttributes.getVpc()

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

clusterName

@Stability(Stable)
public ClusterAttributes.Builder clusterName(String clusterName)

Sets the value of ClusterAttributes.getClusterName()

Parameters:

clusterName - The physical name of the Cluster. This parameter is required.

Returns:

this

clusterCertificateAuthorityData

@Stability(Stable)
public ClusterAttributes.Builder clusterCertificateAuthorityData(String clusterCertificateAuthorityData)

Sets the value of ClusterAttributes.getClusterCertificateAuthorityData()

Parameters:

clusterCertificateAuthorityData - The certificate-authority-data for your cluster.

Returns:

this

clusterEncryptionConfigKeyArn

@Stability(Stable)
public ClusterAttributes.Builder clusterEncryptionConfigKeyArn(String clusterEncryptionConfigKeyArn)

Sets the value of ClusterAttributes.getClusterEncryptionConfigKeyArn()

Parameters:

clusterEncryptionConfigKeyArn - Amazon Resource Name (ARN) or alias of the customer master key (CMK).

Returns:

this

clusterEndpoint

@Stability(Stable)
public ClusterAttributes.Builder clusterEndpoint(String clusterEndpoint)

Sets the value of ClusterAttributes.getClusterEndpoint()

Parameters:

clusterEndpoint - The API Server endpoint URL.

Returns:

this

clusterSecurityGroupId

@Stability(Stable)
public ClusterAttributes.Builder clusterSecurityGroupId(String clusterSecurityGroupId)

Sets the value of ClusterAttributes.getClusterSecurityGroupId()

Parameters:

clusterSecurityGroupId - The cluster security group that was created by Amazon EKS for the cluster.

Returns:

this

ipFamily

@Stability(Stable)
public ClusterAttributes.Builder ipFamily(IpFamily ipFamily)

Sets the value of ClusterAttributes.getIpFamily()

Parameters:

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

Returns:

this

kubectlProvider

@Stability(Stable)
public ClusterAttributes.Builder kubectlProvider(IKubectlProvider kubectlProvider)

Sets the value of ClusterAttributes.getKubectlProvider()

Parameters:

kubectlProvider - KubectlProvider for issuing kubectl commands.

Returns:

this

kubectlProviderOptions

@Stability(Stable)
public ClusterAttributes.Builder kubectlProviderOptions(KubectlProviderOptions kubectlProviderOptions)

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

Returns:

this

openIdConnectProvider

@Stability(Stable)
public ClusterAttributes.Builder openIdConnectProvider(IOpenIdConnectProvider openIdConnectProvider)

Sets the value of ClusterAttributes.getOpenIdConnectProvider()

Parameters:

openIdConnectProvider - An Open ID Connect provider for this cluster that can be used to configure service accounts. You can either import an existing provider using iam.OpenIdConnectProvider.fromProviderArn, or create a new provider using new eks.OpenIdConnectProvider

Returns:

this

prune

@Stability(Stable)
public ClusterAttributes.Builder prune(Boolean prune)

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

securityGroupIds

@Stability(Stable)
public ClusterAttributes.Builder securityGroupIds(List<String> securityGroupIds)

Sets the value of ClusterAttributes.getSecurityGroupIds()

Parameters:

securityGroupIds - Additional security groups associated with this cluster.

Returns:

this

vpc

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

Sets the value of ClusterAttributes.getVpc()

Parameters:

vpc - The VPC in which this Cluster was created.

Returns:

this

build

@Stability(Stable)
public ClusterAttributes build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ClusterAttributes

Throws:

NullPointerException - if any required attribute was not provided