software.amazon.awscdk.services.eks.legacy

Class Cluster

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.eks.legacy.Cluster

All Implemented Interfaces:

IDependable, IResource, IConnectable, ICluster, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:06.272Z")
 @Stability(value=Experimental)
public class Cluster
extends Resource
implements ICluster

(experimental) A Cluster represents a managed Kubernetes Service (EKS).

This is a fully managed cluster of API Servers (control-plane) The user is still required to create the worker nodes.

Example:

 Cluster cluster;
 // option 1: use a construct
 // option 1: use a construct
 HelmChart.Builder.create(this, "NginxIngress")
         .cluster(cluster)
         .chart("nginx-ingress")
         .repository("https://helm.nginx.com/stable")
         .namespace("kube-system")
         .build();
 // or, option2: use `addChart`
 cluster.addChart("NginxIngress", HelmChartOptions.builder()
         .chart("nginx-ingress")
         .repository("https://helm.nginx.com/stable")
         .namespace("kube-system")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.Builder (experimental) A fluent builder for Cluster.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.legacy.ICluster

ICluster.Jsii$Default, ICluster.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Cluster(Construct scope, String id) (experimental) Initiates an EKS Cluster with the supplied arguments.
	Cluster(Construct scope, String id, ClusterProps props) (experimental) Initiates an EKS Cluster with the supplied arguments.
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addAutoScalingGroup(AutoScalingGroup autoScalingGroup, AutoScalingGroupOptions options) (experimental) Add compute capacity to this EKS cluster in the form of an AutoScalingGroup.
AutoScalingGroup	addCapacity(String id, CapacityOptions options) (experimental) Add nodes to this EKS cluster.
HelmChart	addChart(String id, HelmChartOptions options) (experimental) Defines a Helm chart in this cluster.
KubernetesResource	addResource(String id, Object... manifest) (experimental) Defines a Kubernetes resource in this cluster.
static ICluster	fromClusterAttributes(Construct scope, String id, ClusterAttributes attrs) (experimental) Import an existing cluster.
AwsAuth	getAwsAuth() (experimental) Lazily creates the AwsAuth resource, which manages AWS authentication mapping.
String	getClusterArn() (experimental) The AWS generated ARN for the Cluster resource.
String	getClusterCertificateAuthorityData() (experimental) The certificate-authority-data for your cluster.
String	getClusterEndpoint() (experimental) The endpoint URL for the Cluster.
String	getClusterName() (experimental) The Name of the created EKS Cluster.
Connections	getConnections() (experimental) Manages connection rules (Security Group Rules) for the cluster.
AutoScalingGroup	getDefaultCapacity() (experimental) The auto scaling group that hosts the default capacity for this cluster.
Boolean	getKubectlEnabled() (experimental) Indicates if `kubectl` related operations can be performed on this cluster.
IRole	getRole() (experimental) IAM role assumed by the EKS Control Plane.
IVpc	getVpc() (experimental) The VPC in which this Cluster was created.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Cluster

protected Cluster(software.amazon.jsii.JsiiObjectRef objRef)

Cluster

protected Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Cluster

@Stability(value=Experimental)
public Cluster(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id,
                                              @Nullable
                                              ClusterProps props)

(experimental) Initiates an EKS Cluster with the supplied arguments.

Parameters:

scope - a Construct, most likely a cdk.Stack created. This parameter is required.

id - This parameter is required.

props - properties in the IClusterProps interface.

Cluster

@Stability(value=Experimental)
public Cluster(@NotNull
                                              Construct scope,
                                              @NotNull
                                              String id)

(experimental) Initiates an EKS Cluster with the supplied arguments.

Parameters:

scope - a Construct, most likely a cdk.Stack created. This parameter is required.

id - This parameter is required.

Method Detail

fromClusterAttributes

@Stability(value=Experimental)
 @NotNull
public static ICluster fromClusterAttributes(@NotNull
                                                                                      Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      ClusterAttributes attrs)

(experimental) Import an existing cluster.

Parameters:

scope - the construct scope, in most cases 'this'. This parameter is required.

id - the id or name to import as. This parameter is required.

attrs - the cluster properties to use for importing information. This parameter is required.

addAutoScalingGroup

@Stability(value=Experimental)
public void addAutoScalingGroup(@NotNull
                                                               AutoScalingGroup autoScalingGroup,
                                                               @NotNull
                                                               AutoScalingGroupOptions options)

(experimental) Add compute capacity to this EKS cluster in the form of an AutoScalingGroup.

The AutoScalingGroup must be running an EKS-optimized AMI containing the /etc/eks/bootstrap.sh script. This method will configure Security Groups, add the right policies to the instance role, apply the right tags, and add the required user data to the instance's launch configuration.

Spot instances will be labeled lifecycle=Ec2Spot and tainted with PreferNoSchedule. If kubectl is enabled, the spot interrupt handler daemon will be installed on all spot instances to handle EC2 Spot Instance Termination Notices.

Prefer to use addCapacity if possible.

Parameters:

autoScalingGroup - [disable-awslint:ref-via-interface]. This parameter is required.

options - options for adding auto scaling groups, like customizing the bootstrap script. This parameter is required.

See Also:

https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html

addCapacity

@Stability(value=Experimental)
 @NotNull
public AutoScalingGroup addCapacity(@NotNull
                                                                             String id,
                                                                             @NotNull
                                                                             CapacityOptions options)

(experimental) Add nodes to this EKS cluster.

The nodes will automatically be configured with the right VPC and AMI for the instance type and Kubernetes version.

Spot instances will be labeled lifecycle=Ec2Spot and tainted with PreferNoSchedule. If kubectl is enabled, the spot interrupt handler daemon will be installed on all spot instances to handle EC2 Spot Instance Termination Notices.

Parameters:

id - This parameter is required.

options - This parameter is required.

addChart

@Stability(value=Experimental)
 @NotNull
public HelmChart addChart(@NotNull
                                                                   String id,
                                                                   @NotNull
                                                                   HelmChartOptions options)

(experimental) Defines a Helm chart in this cluster.

Parameters:

id - logical id of this chart. This parameter is required.

options - options of this chart. This parameter is required.

Returns:

a `HelmChart` object

addResource

@Stability(value=Experimental)
 @NotNull
public KubernetesResource addResource(@NotNull
                                                                               String id,
                                                                               @NotNull
                                                                               Object... manifest)

(experimental) Defines a Kubernetes resource in this cluster.

The manifest will be applied/deleted using kubectl as needed.

Parameters:

id - logical id of this manifest. This parameter is required.

manifest - a list of Kubernetes resource specifications. This parameter is required.

Returns:

a `KubernetesResource` object.

getAwsAuth

@Stability(value=Experimental)
 @NotNull
public AwsAuth getAwsAuth()

(experimental) Lazily creates the AwsAuth resource, which manages AWS authentication mapping.

getClusterArn

@Stability(value=Experimental)
 @NotNull
public String getClusterArn()

(experimental) The AWS generated ARN for the Cluster resource.

For example, arn:aws:eks:us-west-2:666666666666:cluster/prod

Specified by:

getClusterArn in interface ICluster

getClusterCertificateAuthorityData

@Stability(value=Experimental)
 @NotNull
public String getClusterCertificateAuthorityData()

(experimental) The certificate-authority-data for your cluster.

Specified by:

getClusterCertificateAuthorityData in interface ICluster

getClusterEndpoint

@Stability(value=Experimental)
 @NotNull
public String getClusterEndpoint()

(experimental) The endpoint URL for the Cluster.

This is the URL inside the kubeconfig file to use with kubectl

For example, https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com

Specified by:

getClusterEndpoint in interface ICluster

getClusterName

@Stability(value=Experimental)
 @NotNull
public String getClusterName()

(experimental) The Name of the created EKS Cluster.

Specified by:

getClusterName in interface ICluster

getConnections

@Stability(value=Experimental)
 @NotNull
public Connections getConnections()

(experimental) Manages connection rules (Security Group Rules) for the cluster.

Specified by:

getConnections in interface IConnectable

getKubectlEnabled

@Stability(value=Experimental)
 @NotNull
public Boolean getKubectlEnabled()

(experimental) Indicates if `kubectl` related operations can be performed on this cluster.

getRole

@Stability(value=Experimental)
 @NotNull
public IRole getRole()

(experimental) IAM role assumed by the EKS Control Plane.

getVpc

@Stability(value=Experimental)
 @NotNull
public IVpc getVpc()

(experimental) The VPC in which this Cluster was created.

Specified by:

getVpc in interface ICluster

getDefaultCapacity

@Stability(value=Experimental)
 @Nullable
public AutoScalingGroup getDefaultCapacity()

(experimental) The auto scaling group that hosts the default capacity for this cluster.

This will be undefined if the default capacity is set to 0.