software.amazon.awscdk.services.eks

Class LegacyCluster

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.LegacyCluster

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.14.1 (build 828de8a)",
           date="2020-11-24T22:28:23.744Z")
 @Stability(value=Experimental)
public class LegacyCluster
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.

Nested Class Summary

Nested Classes

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

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.ICluster

ICluster.Jsii$Default, ICluster.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	LegacyCluster(software.constructs.Construct scope, String id, LegacyClusterProps props) (experimental) Initiates an EKS Cluster with the supplied arguments.
protected	LegacyCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LegacyCluster(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, AutoScalingGroupCapacityOptions options) (experimental) Add nodes to this EKS cluster.
KubernetesManifest	addCdk8sChart(String _id, software.constructs.Construct _chart) (experimental) Defines a CDK8s chart in this cluster.
HelmChart	addHelmChart(String _id, HelmChartOptions _options) (experimental) Defines a Helm chart in this cluster.
KubernetesManifest	addManifest(String _id, Object... _manifest) (experimental) Defines a Kubernetes resource in this cluster.
Nodegroup	addNodegroup(String id) (experimental) Add managed nodegroup to this Amazon EKS cluster.
Nodegroup	addNodegroup(String id, NodegroupOptions options) (experimental) Add managed nodegroup to this Amazon EKS cluster.
ServiceAccount	addServiceAccount(String _id) (experimental) Creates a new service account with corresponding IAM Role (IRSA).
ServiceAccount	addServiceAccount(String _id, ServiceAccountOptions _options) (experimental) Creates a new service account with corresponding IAM Role (IRSA).
static ICluster	fromClusterAttributes(software.constructs.Construct scope, String id, ClusterAttributes attrs) (experimental) Import an existing cluster.
String	getClusterArn() (experimental) The AWS generated ARN for the Cluster resource.
String	getClusterCertificateAuthorityData() (experimental) The certificate-authority-data for your cluster.
String	getClusterEncryptionConfigKeyArn() (experimental) Amazon Resource Name (ARN) or alias of the customer master key (CMK).
String	getClusterEndpoint() (experimental) The endpoint URL for the Cluster.
String	getClusterName() (experimental) The Name of the created EKS Cluster.
String	getClusterSecurityGroupId() (experimental) The cluster security group that was created by Amazon EKS for the 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.
Nodegroup	getDefaultNodegroup() (experimental) The node group that hosts the default capacity for this cluster.
IOpenIdConnectProvider	getOpenIdConnectProvider() (experimental) Since we dont really want to make it required on the top-level ICluster we do this trick here in return type to match interface type.
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

generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

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.services.eks.ICluster

getKubectlEnvironment, getKubectlLayer, getKubectlPrivateSubnets, getKubectlRole, getKubectlSecurityGroup

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

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LegacyCluster

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

LegacyCluster

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

LegacyCluster

@Stability(value=Experimental)
public LegacyCluster(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    LegacyClusterProps 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. This parameter is required.

Method Detail

fromClusterAttributes

@Stability(value=Experimental)
 @NotNull
public static ICluster fromClusterAttributes(@NotNull
                                                                                      software.constructs.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
                                                                             AutoScalingGroupCapacityOptions 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.

Parameters:

id - This parameter is required.

options - This parameter is required.

addCdk8sChart

@Stability(value=Experimental)
 @NotNull
public KubernetesManifest addCdk8sChart(@NotNull
                                                                                 String _id,
                                                                                 @NotNull
                                                                                 software.constructs.Construct _chart)

(experimental) Defines a CDK8s chart in this cluster.

Specified by:

addCdk8sChart in interface ICluster

Parameters:

_id - This parameter is required.

_chart - This parameter is required.

Returns:

a `KubernetesManifest` construct representing the chart.

addHelmChart

@Stability(value=Experimental)
 @NotNull
public HelmChart addHelmChart(@NotNull
                                                                       String _id,
                                                                       @NotNull
                                                                       HelmChartOptions _options)

(experimental) Defines a Helm chart in this cluster.

Specified by:

addHelmChart in interface ICluster

Parameters:

_id - This parameter is required.

_options - This parameter is required.

Returns:

a `HelmChart` construct

addManifest

@Stability(value=Experimental)
 @NotNull
public KubernetesManifest addManifest(@NotNull
                                                                               String _id,
                                                                               @NotNull
                                                                               Object... _manifest)

(experimental) Defines a Kubernetes resource in this cluster.

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

Specified by:

addManifest in interface ICluster

Parameters:

_id - This parameter is required.

_manifest - This parameter is required.

Returns:

a `KubernetesManifest` object.

addNodegroup

@Stability(value=Experimental)
 @NotNull
public Nodegroup addNodegroup(@NotNull
                                                                       String id,
                                                                       @Nullable
                                                                       NodegroupOptions options)

(experimental) Add managed nodegroup to this Amazon EKS cluster.

This method will create a new managed nodegroup and add into the capacity.

Parameters:

id - The ID of the nodegroup. This parameter is required.

options - options for creating a new nodegroup.

See Also:

https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html

addNodegroup

@Stability(value=Experimental)
 @NotNull
public Nodegroup addNodegroup(@NotNull
                                                                       String id)

(experimental) Add managed nodegroup to this Amazon EKS cluster.

This method will create a new managed nodegroup and add into the capacity.

Parameters:

id - The ID of the nodegroup. This parameter is required.

See Also:

https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html

addServiceAccount

@Stability(value=Experimental)
 @NotNull
public ServiceAccount addServiceAccount(@NotNull
                                                                                 String _id,
                                                                                 @Nullable
                                                                                 ServiceAccountOptions _options)

(experimental) Creates a new service account with corresponding IAM Role (IRSA).

Specified by:

addServiceAccount in interface ICluster

Parameters:

_id - This parameter is required.

_options -

addServiceAccount

@Stability(value=Experimental)
 @NotNull
public ServiceAccount addServiceAccount(@NotNull
                                                                                 String _id)

(experimental) Creates a new service account with corresponding IAM Role (IRSA).

Specified by:

addServiceAccount in interface ICluster

Parameters:

_id - This parameter is required.

getClusterArn

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

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

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 arn:aws:eks:us-west-2666666666666;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

getClusterEncryptionConfigKeyArn

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

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

Specified by:

getClusterEncryptionConfigKeyArn 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

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 https:

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

getClusterSecurityGroupId

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

(experimental) The cluster security group that was created by Amazon EKS for the cluster.

Specified by:

getClusterSecurityGroupId 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

getOpenIdConnectProvider

@Stability(value=Experimental)
 @NotNull
public IOpenIdConnectProvider getOpenIdConnectProvider()

(experimental) Since we dont really want to make it required on the top-level ICluster we do this trick here in return type to match interface type.

Specified by:

getOpenIdConnectProvider in interface ICluster

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 defaultCapacityType is not EC2 or defaultCapacityType is EC2 but default capacity is set to 0.

getDefaultNodegroup

@Stability(value=Experimental)
 @Nullable
public Nodegroup getDefaultNodegroup()

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

This will be undefined if the defaultCapacityType is EC2 or defaultCapacityType is NODEGROUP but default capacity is set to 0.