software.amazon.awscdk.services.eks

Interface ICluster

All Superinterfaces:

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

All Known Subinterfaces:

ICluster.Jsii$Default

All Known Implementing Classes:

Cluster, FargateCluster, ICluster.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:46.713Z")
 @Stability(value=Stable)
public interface ICluster
extends software.amazon.jsii.JsiiSerializable, IResource, IConnectable

An EKS cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ICluster.Jsii$Default Internal default implementation for ICluster.
static class	ICluster.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
KubernetesManifest	addCdk8sChart(String id, software.constructs.Construct chart) Defines a CDK8s chart in this cluster.
KubernetesManifest	addCdk8sChart(String id, software.constructs.Construct chart, KubernetesManifestOptions options) Defines a CDK8s chart in this cluster.
HelmChart	addHelmChart(String id, HelmChartOptions options) Defines a Helm chart in this cluster.
KubernetesManifest	addManifest(String id, Map<String,Object>... manifest) Defines a Kubernetes resource in this cluster.
ServiceAccount	addServiceAccount(String id) Creates a new service account with corresponding IAM Role (IRSA).
ServiceAccount	addServiceAccount(String id, ServiceAccountOptions options) Creates a new service account with corresponding IAM Role (IRSA).
void	connectAutoScalingGroupCapacity(AutoScalingGroup autoScalingGroup, AutoScalingGroupOptions options) Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster.
String	getClusterArn() The unique ARN assigned to the service by AWS in the form of arn:aws:eks:.
String	getClusterCertificateAuthorityData() The certificate-authority-data for your cluster.
String	getClusterEncryptionConfigKeyArn() Amazon Resource Name (ARN) or alias of the customer master key (CMK).
String	getClusterEndpoint() The API Server endpoint URL.
default ISecurityGroup	getClusterHandlerSecurityGroup() A security group to associate with the Cluster Handler's Lambdas.
String	getClusterName() The physical name of the Cluster.
ISecurityGroup	getClusterSecurityGroup() The cluster security group that was created by Amazon EKS for the cluster.
String	getClusterSecurityGroupId() The id of the cluster security group that was created by Amazon EKS for the cluster.
default Map<String,String>	getKubectlEnvironment() Custom environment variables when running `kubectl` against this cluster.
default IRole	getKubectlLambdaRole() An IAM role that can perform kubectl operations against this cluster.
default ILayerVersion	getKubectlLayer() An AWS Lambda layer that includes `kubectl`, `helm` and the `aws` CLI.
default Size	getKubectlMemory() Amount of memory to allocate to the provider's lambda function.
default List<ISubnet>	getKubectlPrivateSubnets() Subnets to host the `kubectl` compute resources.
default IKubectlProvider	getKubectlProvider() Kubectl Provider for issuing kubectl commands against it.
default IRole	getKubectlRole() An IAM role that can perform kubectl operations against this cluster.
default ISecurityGroup	getKubectlSecurityGroup() A security group to use for `kubectl` execution.
default ILayerVersion	getOnEventLayer() An AWS Lambda layer that includes the NPM dependency `proxy-agent`.
IOpenIdConnectProvider	getOpenIdConnectProvider() The Open ID Connect Provider of the cluster used to configure Service Accounts.
Boolean	getPrune() Indicates whether Kubernetes resources can be automatically pruned.
IVpc	getVpc() The VPC in which this Cluster was created.

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

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Method Detail

getClusterArn

@Stability(value=Stable)
 @NotNull
String getClusterArn()

The unique ARN assigned to the service by AWS in the form of arn:aws:eks:.

getClusterCertificateAuthorityData

@Stability(value=Stable)
 @NotNull
String getClusterCertificateAuthorityData()

The certificate-authority-data for your cluster.

getClusterEncryptionConfigKeyArn

@Stability(value=Stable)
 @NotNull
String getClusterEncryptionConfigKeyArn()

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

getClusterEndpoint

@Stability(value=Stable)
 @NotNull
String getClusterEndpoint()

The API Server endpoint URL.

getClusterName

@Stability(value=Stable)
 @NotNull
String getClusterName()

The physical name of the Cluster.

getClusterSecurityGroup

@Stability(value=Stable)
 @NotNull
ISecurityGroup getClusterSecurityGroup()

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

getClusterSecurityGroupId

@Stability(value=Stable)
 @NotNull
String getClusterSecurityGroupId()

The id of the cluster security group that was created by Amazon EKS for the cluster.

getOpenIdConnectProvider

@Stability(value=Stable)
 @NotNull
IOpenIdConnectProvider getOpenIdConnectProvider()

The Open ID Connect Provider of the cluster used to configure Service Accounts.

getPrune

@Stability(value=Stable)
 @NotNull
Boolean getPrune()

Indicates whether Kubernetes resources 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.

getVpc

@Stability(value=Stable)
 @NotNull
IVpc getVpc()

The VPC in which this Cluster was created.

getClusterHandlerSecurityGroup

@Stability(value=Stable)
 @Nullable
default ISecurityGroup getClusterHandlerSecurityGroup()

A security group to associate with the Cluster Handler's Lambdas.

The Cluster Handler's Lambdas are responsible for calling AWS's EKS API.

Requires placeClusterHandlerInVpc to be set to true.

Default: - No security group.

getKubectlEnvironment

@Stability(value=Stable)
 @Nullable
default Map<String,String> getKubectlEnvironment()

Custom environment variables when running `kubectl` against this cluster.

getKubectlLambdaRole

@Stability(value=Stable)
 @Nullable
default IRole getKubectlLambdaRole()

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.

getKubectlLayer

@Stability(value=Stable)
 @Nullable
default ILayerVersion getKubectlLayer()

An AWS Lambda layer that includes `kubectl`, `helm` and the `aws` CLI.

If not defined, a default layer will be used.

getKubectlMemory

@Stability(value=Stable)
 @Nullable
default Size getKubectlMemory()

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

getKubectlPrivateSubnets

@Stability(value=Stable)
 @Nullable
default List<ISubnet> getKubectlPrivateSubnets()

Subnets to host the `kubectl` compute resources.

If this is undefined, the k8s endpoint is expected to be accessible publicly.

getKubectlProvider

@Stability(value=Stable)
 @Nullable
default IKubectlProvider getKubectlProvider()

Kubectl Provider for issuing kubectl commands against it.

If not defined, a default provider will be used

getKubectlRole

@Stability(value=Stable)
 @Nullable
default IRole getKubectlRole()

An IAM role that can perform kubectl operations against this cluster.

The role should be mapped to the system:masters Kubernetes RBAC role.

getKubectlSecurityGroup

@Stability(value=Stable)
 @Nullable
default ISecurityGroup getKubectlSecurityGroup()

A security group to use for `kubectl` execution.

If this is undefined, the k8s endpoint is expected to be accessible publicly.

getOnEventLayer

@Stability(value=Stable)
 @Nullable
default ILayerVersion getOnEventLayer()

An AWS Lambda layer that includes the NPM dependency `proxy-agent`.

If not defined, a default layer will be used.

addCdk8sChart

@Stability(value=Stable)
 @NotNull
KubernetesManifest addCdk8sChart(@NotNull
                                                                    String id,
                                                                    @NotNull
                                                                    software.constructs.Construct chart,
                                                                    @Nullable
                                                                    KubernetesManifestOptions options)

Defines a CDK8s chart in this cluster.

Parameters:

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

chart - the cdk8s chart. This parameter is required.

options -

Returns:

a `KubernetesManifest` construct representing the chart.

addCdk8sChart

@Stability(value=Stable)
 @NotNull
KubernetesManifest addCdk8sChart(@NotNull
                                                                    String id,
                                                                    @NotNull
                                                                    software.constructs.Construct chart)

Defines a CDK8s chart in this cluster.

Parameters:

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

chart - the cdk8s chart. This parameter is required.

Returns:

a `KubernetesManifest` construct representing the chart.

addHelmChart

@Stability(value=Stable)
 @NotNull
HelmChart addHelmChart(@NotNull
                                                          String id,
                                                          @NotNull
                                                          HelmChartOptions options)

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` construct

addManifest

@Stability(value=Stable)
 @NotNull
KubernetesManifest addManifest(@NotNull
                                                                  String id,
                                                                  @NotNull
                                                                  Map<String,Object>... manifest)

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 `KubernetesManifest` object.

addServiceAccount

@Stability(value=Stable)
 @NotNull
ServiceAccount addServiceAccount(@NotNull
                                                                    String id,
                                                                    @Nullable
                                                                    ServiceAccountOptions options)

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

Parameters:

id - logical id of service account. This parameter is required.

options - service account options.

addServiceAccount

@Stability(value=Stable)
 @NotNull
ServiceAccount addServiceAccount(@NotNull
                                                                    String id)

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

Parameters:

id - logical id of service account. This parameter is required.

connectAutoScalingGroupCapacity

@Stability(value=Stable)
void connectAutoScalingGroupCapacity(@NotNull
                                                              AutoScalingGroup autoScalingGroup,
                                                              @NotNull
                                                              AutoScalingGroupOptions options)

Connect capacity in the form of an existing AutoScalingGroup to the EKS cluster.

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 addAutoScalingGroupCapacity 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