Package software.amazon.awscdk.services.eks

Class ClusterAttributes.Builder

java.lang.Object

software.amazon.awscdk.services.eks.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	clusterHandlerSecurityGroupId(String clusterHandlerSecurityGroupId)	Sets the value of ClusterAttributes.getClusterHandlerSecurityGroupId()
ClusterAttributes.Builder	clusterName(String clusterName)	Sets the value of ClusterAttributes.getClusterName()
ClusterAttributes.Builder	clusterSecurityGroupId(String clusterSecurityGroupId)	Sets the value of ClusterAttributes.getClusterSecurityGroupId()
ClusterAttributes.Builder	kubectlEnvironment(Map<String,String> kubectlEnvironment)	Sets the value of ClusterAttributes.getKubectlEnvironment()
ClusterAttributes.Builder	kubectlLambdaRole(IRole kubectlLambdaRole)	Sets the value of ClusterAttributes.getKubectlLambdaRole()
ClusterAttributes.Builder	kubectlLayer(ILayerVersion kubectlLayer)	Sets the value of ClusterAttributes.getKubectlLayer()
ClusterAttributes.Builder	kubectlMemory(Size kubectlMemory)	Sets the value of ClusterAttributes.getKubectlMemory()
ClusterAttributes.Builder	kubectlPrivateSubnetIds(List<String> kubectlPrivateSubnetIds)	Sets the value of ClusterAttributes.getKubectlPrivateSubnetIds()
ClusterAttributes.Builder	kubectlProvider(IKubectlProvider kubectlProvider)	Sets the value of ClusterAttributes.getKubectlProvider()
ClusterAttributes.Builder	kubectlRoleArn(String kubectlRoleArn)	Sets the value of ClusterAttributes.getKubectlRoleArn()
ClusterAttributes.Builder	kubectlSecurityGroupId(String kubectlSecurityGroupId)	Sets the value of ClusterAttributes.getKubectlSecurityGroupId()
ClusterAttributes.Builder	onEventLayer(ILayerVersion onEventLayer)	Sets the value of ClusterAttributes.getOnEventLayer()
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

clusterHandlerSecurityGroupId

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

Sets the value of ClusterAttributes.getClusterHandlerSecurityGroupId()

Parameters:

clusterHandlerSecurityGroupId - A security group id to associate with the Cluster Handler's Lambdas. The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.

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

kubectlEnvironment

@Stability(Stable)
public ClusterAttributes.Builder kubectlEnvironment(Map<String,String> kubectlEnvironment)

Sets the value of ClusterAttributes.getKubectlEnvironment()

Parameters:

kubectlEnvironment - Environment variables to use when running kubectl against this cluster.

Returns:

this

kubectlLambdaRole

@Stability(Stable)
public ClusterAttributes.Builder kubectlLambdaRole(IRole kubectlLambdaRole)

Sets the value of ClusterAttributes.getKubectlLambdaRole()

Parameters:

kubectlLambdaRole - An IAM role that can perform kubectl operations against this cluster. The role should be mapped to the system:masters Kubernetes RBAC role.

This role is directly passed to the lambda handler that sends Kube Ctl commands to the cluster.

Returns:

this

kubectlLayer

@Stability(Stable)
public ClusterAttributes.Builder kubectlLayer(ILayerVersion kubectlLayer)

Sets the value of ClusterAttributes.getKubectlLayer()

Parameters:

kubectlLayer - An AWS Lambda Layer which includes kubectl, Helm and the AWS CLI. This layer is used by the kubectl handler to apply manifests and install helm charts.

The handler expects the layer to include the following executables:

                     helm/helm
                     kubectl/kubectl
                     awscli/aws
                     

Returns:

this

kubectlMemory

@Stability(Stable)
public ClusterAttributes.Builder kubectlMemory(Size kubectlMemory)

Sets the value of ClusterAttributes.getKubectlMemory()

Parameters:

kubectlMemory - Amount of memory to allocate to the provider's lambda function.

Returns:

this

kubectlPrivateSubnetIds

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

Sets the value of ClusterAttributes.getKubectlPrivateSubnetIds()

Parameters:

kubectlPrivateSubnetIds - Subnets to host the kubectl compute resources. If not specified, the k8s endpoint is expected to be accessible publicly.

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

kubectlRoleArn

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

Sets the value of ClusterAttributes.getKubectlRoleArn()

Parameters:

kubectlRoleArn - An IAM role with cluster administrator and "system:masters" permissions.

Returns:

this

kubectlSecurityGroupId

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

Sets the value of ClusterAttributes.getKubectlSecurityGroupId()

Parameters:

kubectlSecurityGroupId - A security group to use for kubectl execution. If not specified, the k8s endpoint is expected to be accessible publicly.

Returns:

this

onEventLayer

@Stability(Stable)
public ClusterAttributes.Builder onEventLayer(ILayerVersion onEventLayer)

Sets the value of ClusterAttributes.getOnEventLayer()

Parameters:

onEventLayer - An AWS Lambda Layer which includes the NPM dependency proxy-agent. This layer is used by the onEvent handler to route AWS SDK requests through a proxy.

The handler expects the layer to include the following node_modules:

                     proxy-agent
                     

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