software.amazon.awscdk.services.eks.legacy

Class Cluster

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

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

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, ICluster

Deprecated.

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:38.444Z")
 @Deprecated
public class Cluster
extends Resource
implements ICluster

(deprecated) 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 Deprecated.

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, java.lang.String id) Deprecated.
	Cluster(Construct scope, java.lang.String id, ClusterProps props) Deprecated.
protected	Cluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.
protected	Cluster(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAutoScalingGroup(AutoScalingGroup autoScalingGroup, AutoScalingGroupOptions options) Deprecated.
AutoScalingGroup	addCapacity(java.lang.String id, CapacityOptions options) Deprecated.
HelmChart	addChart(java.lang.String id, HelmChartOptions options) Deprecated.
KubernetesResource	addResource(java.lang.String id, java.lang.Object... manifest) Deprecated.
static ICluster	fromClusterAttributes(Construct scope, java.lang.String id, ClusterAttributes attrs) Deprecated.
AwsAuth	getAwsAuth() Deprecated.
java.lang.String	getClusterArn() Deprecated.
java.lang.String	getClusterCertificateAuthorityData() Deprecated.
java.lang.String	getClusterEndpoint() Deprecated.
java.lang.String	getClusterName() Deprecated.
Connections	getConnections() Deprecated.
AutoScalingGroup	getDefaultCapacity() Deprecated.
java.lang.Boolean	getKubectlEnabled() Deprecated.
IRole	getRole() Deprecated.
IVpc	getVpc() Deprecated.

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

Cluster

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

Deprecated.

Cluster

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

Deprecated.

Cluster

@Deprecated
public Cluster(Construct scope,
                           java.lang.String id,
                           ClusterProps props)

Deprecated.

(deprecated) 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

@Deprecated
public Cluster(Construct scope,
                           java.lang.String id)

Deprecated.

(deprecated) 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

@Deprecated
public static ICluster fromClusterAttributes(Construct scope,
                                                         java.lang.String id,
                                                         ClusterAttributes attrs)

Deprecated.

(deprecated) 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

@Deprecated
public void addAutoScalingGroup(AutoScalingGroup autoScalingGroup,
                                            AutoScalingGroupOptions options)

Deprecated.

(deprecated) 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

@Deprecated
public AutoScalingGroup addCapacity(java.lang.String id,
                                                CapacityOptions options)

Deprecated.

(deprecated) 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

@Deprecated
public HelmChart addChart(java.lang.String id,
                                      HelmChartOptions options)

Deprecated.

(deprecated) 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

@Deprecated
public KubernetesResource addResource(java.lang.String id,
                                                  java.lang.Object... manifest)

Deprecated.

(deprecated) 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

@Deprecated
public AwsAuth getAwsAuth()

Deprecated.

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

getClusterArn

@Deprecated
public java.lang.String getClusterArn()

Deprecated.

(deprecated) 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

@Deprecated
public java.lang.String getClusterCertificateAuthorityData()

Deprecated.

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

Specified by:

getClusterCertificateAuthorityData in interface ICluster

getClusterEndpoint

@Deprecated
public java.lang.String getClusterEndpoint()

Deprecated.

(deprecated) 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

@Deprecated
public java.lang.String getClusterName()

Deprecated.

(deprecated) The Name of the created EKS Cluster.

Specified by:

getClusterName in interface ICluster

getConnections

@Deprecated
public Connections getConnections()

Deprecated.

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

Specified by:

getConnections in interface IConnectable

getKubectlEnabled

@Deprecated
public java.lang.Boolean getKubectlEnabled()

Deprecated.

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

getRole

@Deprecated
public IRole getRole()

Deprecated.

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

getVpc

@Deprecated
public IVpc getVpc()

Deprecated.

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

Specified by:

getVpc in interface ICluster

getDefaultCapacity

@Deprecated
public AutoScalingGroup getDefaultCapacity()

Deprecated.

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

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