ICluster.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.eks.ICluster.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IConnectable, IConnectable.Jsii$Default, ICluster, ICluster.Jsii$Default

Enclosing interface:

ICluster
```
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 interface software.amazon.awscdk.services.eks.ICluster
  ICluster.Jsii$Default, ICluster.Jsii$Proxy

Constructor Summary

Constructors
Modifier Constructor and Description

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

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
- Method Detail
  - getNode
```
public final ConstructNode getNode()
```
    The construct tree node for this construct.
    
    Specified by:
    
    getNode in interface IConstruct
    
    Specified by:
    
    getNode in interface IConstruct.Jsii$Default
    
    Specified by:
    
    getNode in interface IResource.Jsii$Default
    
    Specified by:
    
    getNode in interface ICluster.Jsii$Default
  - getEnv
```
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 IResource
    
    Specified by:
    
    getEnv in interface IResource.Jsii$Default
    
    Specified by:
    
    getEnv in interface ICluster.Jsii$Default
  - getStack
```
public final Stack getStack()
```
    The stack in which this resource is defined.
    
    Specified by:
    
    getStack in interface IResource
    
    Specified by:
    
    getStack in interface IResource.Jsii$Default
    
    Specified by:
    
    getStack in interface ICluster.Jsii$Default
  - getConnections
```
public final Connections getConnections()
```
    The network connections associated with this resource.
    
    Specified by:
    
    getConnections in interface IConnectable
    
    Specified by:
    
    getConnections in interface IConnectable.Jsii$Default
    
    Specified by:
    
    getConnections in interface ICluster.Jsii$Default
  - getClusterArn
```
public final java.lang.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
```
public final java.lang.String getClusterCertificateAuthorityData()
```
    The certificate-authority-data for your cluster.
    
    Specified by:
    
    getClusterCertificateAuthorityData in interface ICluster
    
    Specified by:
    
    getClusterCertificateAuthorityData in interface ICluster.Jsii$Default
  - getClusterEncryptionConfigKeyArn
```
public final java.lang.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
```
public final java.lang.String getClusterEndpoint()
```
    The API Server endpoint URL.
    
    Specified by:
    
    getClusterEndpoint in interface ICluster
    
    Specified by:
    
    getClusterEndpoint in interface ICluster.Jsii$Default
  - getClusterName
```
public final java.lang.String getClusterName()
```
    The physical name of the Cluster.
    
    Specified by:
    
    getClusterName in interface ICluster
    
    Specified by:
    
    getClusterName in interface ICluster.Jsii$Default
  - getClusterSecurityGroup
```
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
```
public final java.lang.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
```
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
```
public final java.lang.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
```
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
  - getClusterHandlerSecurityGroup
```
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
  - getKubectlEnvironment
```
public final java.util.Map<java.lang.String,java.lang.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
```
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
```
public final ILayerVersion getKubectlLayer()
```
    An AWS Lambda layer that includes `kubectl`, `helm` and the `aws` CLI.
    If not defined, a default layer will be used.
    
    Specified by:
    
    getKubectlLayer in interface ICluster
    
    Specified by:
    
    getKubectlLayer in interface ICluster.Jsii$Default
  - getKubectlMemory
```
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
```
public final java.util.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
```
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
```
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
```
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
```
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
```
public final void applyRemovalPolicy(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 IResource
    
    Specified by:
    
    applyRemovalPolicy in interface IResource.Jsii$Default
    
    Specified by:
    
    applyRemovalPolicy in interface ICluster.Jsii$Default
    
    Parameters:
    
    policy - This parameter is required.
  - addCdk8sChart
```
public final KubernetesManifest addCdk8sChart(java.lang.String id,
                                              software.constructs.Construct chart,
                                              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
```
public final KubernetesManifest addCdk8sChart(java.lang.String id,
                                              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
```
public final HelmChart addHelmChart(java.lang.String id,
                                    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
```
public final KubernetesManifest addManifest(java.lang.String id,
                                            java.util.Map<java.lang.String,java.lang.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
```
public final ServiceAccount addServiceAccount(java.lang.String id,
                                              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
```
public final ServiceAccount addServiceAccount(java.lang.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
```
public final void connectAutoScalingGroupCapacity(AutoScalingGroup autoScalingGroup,
                                                  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

Class ICluster.Jsii$Proxy

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Jsii$Proxy

Method Detail

getNode

getEnv

getStack

getConnections

getClusterArn

getClusterCertificateAuthorityData

getClusterEncryptionConfigKeyArn

getClusterEndpoint

getClusterName

getClusterSecurityGroup

getClusterSecurityGroupId

getOpenIdConnectProvider

getPrune

getVpc

getClusterHandlerSecurityGroup

getKubectlEnvironment

getKubectlLambdaRole

getKubectlLayer

getKubectlMemory

getKubectlPrivateSubnets

getKubectlProvider

getKubectlRole

getKubectlSecurityGroup

getOnEventLayer

applyRemovalPolicy

addCdk8sChart

addCdk8sChart

addHelmChart

addManifest

addServiceAccount

addServiceAccount

connectAutoScalingGroupCapacity