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(value=Experimental)
public static final class ClusterAttributes.Builder
extends Object
implements software.amazon.jsii.Builder<ClusterAttributes>

A builder for ClusterAttributes

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and 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	kubectlEnvironment(Map<String,String> kubectlEnvironment) Sets the value of ClusterAttributes.getKubectlEnvironment()
ClusterAttributes.Builder	kubectlLayer(ILayerVersion kubectlLayer) Sets the value of ClusterAttributes.getKubectlLayer()
ClusterAttributes.Builder	kubectlPrivateSubnetIds(List<String> kubectlPrivateSubnetIds) Sets the value of ClusterAttributes.getKubectlPrivateSubnetIds()
ClusterAttributes.Builder	kubectlRoleArn(String kubectlRoleArn) Sets the value of ClusterAttributes.getKubectlRoleArn()
ClusterAttributes.Builder	kubectlSecurityGroupId(String kubectlSecurityGroupId) Sets the value of ClusterAttributes.getKubectlSecurityGroupId()
ClusterAttributes.Builder	openIdConnectProvider(IOpenIdConnectProvider openIdConnectProvider) Sets the value of ClusterAttributes.getOpenIdConnectProvider()
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 Detail

Builder

public Builder()

Method Detail

clusterName

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

Sets the value of ClusterAttributes.getClusterEndpoint()

Parameters:

clusterEndpoint - The API Server endpoint URL.

Returns:

this

clusterSecurityGroupId

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

kubectlLayer

@Stability(value=Experimental)
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. 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 = ;
                     
                     Or;you;can;use;the;standard;layer;like;this();with options
                     tocustomize;the;version;and;SAR;application;ID;
                     
                     ```ts
                     const layer = new eks.KubectlLayer(this, 'KubectlLayer');;
                     

Returns:

this

kubectlPrivateSubnetIds

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

kubectlRoleArn

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

openIdConnectProvider

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

securityGroupIds

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