Package software.amazon.awscdk.services.eks

Class ICluster.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.eks.ICluster.Jsii$Proxy

All Implemented Interfaces:

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

Enclosing interface:

ICluster

@Internal
public static final class ICluster.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ICluster.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ec2.IConnectable

IConnectable.Jsii$Default, IConnectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface ICluster.Jsii$Default

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface ICluster.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface ICluster.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getConnections

@Stability(Stable)
@NotNull
public final Connections getConnections()

The network connections associated with this resource.

Specified by:

getConnections in interface ICluster.Jsii$Default

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in interface IConnectable.Jsii$Default

getClusterArn

@Stability(Stable)
@NotNull
public final String getClusterArn()

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

Specified by:

getClusterArn in interface ICluster

Specified by:

getClusterArn in interface ICluster.Jsii$Default

getClusterCertificateAuthorityData

@Stability(Stable)
@NotNull
public final String getClusterCertificateAuthorityData()

The certificate-authority-data for your cluster.

Specified by:

getClusterCertificateAuthorityData in interface ICluster

Specified by:

getClusterCertificateAuthorityData in interface ICluster.Jsii$Default

getClusterEncryptionConfigKeyArn

@Stability(Stable)
@NotNull
public final String getClusterEncryptionConfigKeyArn()

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

Specified by:

getClusterEncryptionConfigKeyArn in interface ICluster

Specified by:

getClusterEncryptionConfigKeyArn in interface ICluster.Jsii$Default

getClusterEndpoint

@Stability(Stable)
@NotNull
public final String getClusterEndpoint()

The API Server endpoint URL.

Specified by:

getClusterEndpoint in interface ICluster

Specified by:

getClusterEndpoint in interface ICluster.Jsii$Default

getClusterName

@Stability(Stable)
@NotNull
public final String getClusterName()

The physical name of the Cluster.

Specified by:

getClusterName in interface ICluster

Specified by:

getClusterName in interface ICluster.Jsii$Default

getClusterSecurityGroup

@Stability(Stable)
@NotNull
public final ISecurityGroup getClusterSecurityGroup()

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

Specified by:

getClusterSecurityGroup in interface ICluster

Specified by:

getClusterSecurityGroup in interface ICluster.Jsii$Default

getClusterSecurityGroupId

@Stability(Stable)
@NotNull
public final String getClusterSecurityGroupId()

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

Specified by:

getClusterSecurityGroupId in interface ICluster

Specified by:

getClusterSecurityGroupId in interface ICluster.Jsii$Default

getOpenIdConnectProvider

@Stability(Stable)
@NotNull
public final IOpenIdConnectProvider getOpenIdConnectProvider()

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

Specified by:

getOpenIdConnectProvider in interface ICluster

Specified by:

getOpenIdConnectProvider in interface ICluster.Jsii$Default

getPrune

@Stability(Stable)
@NotNull
public final 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.

Specified by:

getPrune in interface ICluster

Specified by:

getPrune in interface ICluster.Jsii$Default

getVpc

@Stability(Stable)
@NotNull
public final IVpc getVpc()

The VPC in which this Cluster was created.

Specified by:

getVpc in interface ICluster

Specified by:

getVpc in interface ICluster.Jsii$Default

getAwscliLayer

@Stability(Stable)
@Nullable
public final ILayerVersion getAwscliLayer()

An AWS Lambda layer that contains the aws CLI.

If not defined, a default layer will be used containing the AWS CLI 1.x.

Specified by:

getAwscliLayer in interface ICluster

Specified by:

getAwscliLayer in interface ICluster.Jsii$Default

getClusterHandlerSecurityGroup

@Stability(Stable)
@Nullable
public final 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.

Specified by:

getClusterHandlerSecurityGroup in interface ICluster

Specified by:

getClusterHandlerSecurityGroup in interface ICluster.Jsii$Default

getIpFamily

@Stability(Stable)
@Nullable
public final IpFamily getIpFamily()

Specify which IP family is used to assign Kubernetes pod and service IP addresses.

Default: - IpFamily.IP_V4

Specified by:

getIpFamily in interface ICluster

Specified by:

getIpFamily in interface ICluster.Jsii$Default

See Also:

• https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-ipFamily

getKubectlEnvironment

@Stability(Stable)
@Nullable
public final Map<String,String> getKubectlEnvironment()

Custom environment variables when running kubectl against this cluster.

Specified by:

getKubectlEnvironment in interface ICluster

Specified by:

getKubectlEnvironment in interface ICluster.Jsii$Default

getKubectlLambdaRole

@Stability(Stable)
@Nullable
public final 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.

Specified by:

getKubectlLambdaRole in interface ICluster

Specified by:

getKubectlLambdaRole in interface ICluster.Jsii$Default

getKubectlLayer

@Stability(Stable)
@Nullable
public final ILayerVersion getKubectlLayer()

An AWS Lambda layer that includes kubectl and helm.

If not defined, a default layer will be used containing Kubectl 1.20 and Helm 3.8

Specified by:

getKubectlLayer in interface ICluster

Specified by:

getKubectlLayer in interface ICluster.Jsii$Default

getKubectlMemory

@Stability(Stable)
@Nullable
public final Size getKubectlMemory()

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

Specified by:

getKubectlMemory in interface ICluster

Specified by:

getKubectlMemory in interface ICluster.Jsii$Default

getKubectlPrivateSubnets

@Stability(Stable)
@Nullable
public final List<ISubnet> getKubectlPrivateSubnets()

Subnets to host the kubectl compute resources.

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

Specified by:

getKubectlPrivateSubnets in interface ICluster

Specified by:

getKubectlPrivateSubnets in interface ICluster.Jsii$Default

getKubectlProvider

@Stability(Stable)
@Nullable
public final IKubectlProvider getKubectlProvider()

Kubectl Provider for issuing kubectl commands against it.

If not defined, a default provider will be used

Specified by:

getKubectlProvider in interface ICluster

Specified by:

getKubectlProvider in interface ICluster.Jsii$Default

getKubectlRole

@Stability(Stable)
@Nullable
public final 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.

Specified by:

getKubectlRole in interface ICluster

Specified by:

getKubectlRole in interface ICluster.Jsii$Default

getKubectlSecurityGroup

@Stability(Stable)
@Nullable
public final ISecurityGroup getKubectlSecurityGroup()

A security group to use for kubectl execution.

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

Specified by:

getKubectlSecurityGroup in interface ICluster

Specified by:

getKubectlSecurityGroup in interface ICluster.Jsii$Default

getOnEventLayer

@Stability(Stable)
@Nullable
public final ILayerVersion getOnEventLayer()

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

If not defined, a default layer will be used.

Specified by:

getOnEventLayer in interface ICluster

Specified by:

getOnEventLayer in interface ICluster.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
public final void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface ICluster.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

addCdk8sChart

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

Defines a CDK8s chart in this cluster.

Specified by:

addCdk8sChart in interface ICluster

Specified by:

addCdk8sChart in interface ICluster.Jsii$Default

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(Stable)
@NotNull
public final KubernetesManifest addCdk8sChart(@NotNull
 String id,
 @NotNull
 software.constructs.Construct chart)

Defines a CDK8s chart in this cluster.

Specified by:

addCdk8sChart in interface ICluster

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(Stable)
@NotNull
public final HelmChart addHelmChart(@NotNull
 String id,
 @NotNull
 HelmChartOptions options)

Defines a Helm chart in this cluster.

Specified by:

addHelmChart in interface ICluster

Specified by:

addHelmChart in interface ICluster.Jsii$Default

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(Stable)
@NotNull
public final KubernetesManifest addManifest(@NotNull
 String id,
 @NotNull
 @NotNull Map<String,Object>... manifest)

Defines a Kubernetes resource in this cluster.

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

Specified by:

addManifest in interface ICluster

Specified by:

addManifest in interface ICluster.Jsii$Default

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(Stable)
@NotNull
public final ServiceAccount addServiceAccount(@NotNull
 String id,
 @Nullable
 ServiceAccountOptions options)

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

Specified by:

addServiceAccount in interface ICluster

Specified by:

addServiceAccount in interface ICluster.Jsii$Default

Parameters:

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

options - service account options.

addServiceAccount

@Stability(Stable)
@NotNull
public final ServiceAccount addServiceAccount(@NotNull
 String id)

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

Specified by:

addServiceAccount in interface ICluster

Parameters:

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

connectAutoScalingGroupCapacity

@Stability(Stable)
public final 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.

Specified by:

connectAutoScalingGroupCapacity in interface ICluster

Specified by:

connectAutoScalingGroupCapacity in interface ICluster.Jsii$Default

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