java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:: ClusterOptions, ClusterProps, CommonClusterOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:: ClusterProps

@Stability(Stable) @Internal public static final class ClusterProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ClusterProps

An implementation for ClusterProps

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.ClusterProps
ClusterProps.Builder, ClusterProps.Jsii$Proxy
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(ClusterProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the ClusterProps.Builder.

protected

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

Constructor that initializes the object based on values retrieved from the JsiiObject.
Method Summary

Modifier and Type

Method

Description

com.fasterxml.jackson.databind.JsonNode

$jsii$toJson()

final boolean

equals(Object o)

final AlbControllerOptions

getAlbController()

Install the AWS Load Balancer Controller onto the cluster.

final AuthenticationMode

getAuthenticationMode()

The desired authentication mode for the cluster.

final ILayerVersion

getAwscliLayer()

An AWS Lambda layer that contains the aws CLI.

final Boolean

getBootstrapClusterCreatorAdminPermissions()

Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.

final Boolean

getBootstrapSelfManagedAddons()

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

final Map<String,String>

getClusterHandlerEnvironment()

Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.

final ISecurityGroup

getClusterHandlerSecurityGroup()

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

final List<ClusterLoggingTypes>

getClusterLogging()

The cluster log types which you want to enable.

final String

getClusterName()

Name for the cluster.

final CoreDnsComputeType

getCoreDnsComputeType()

Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

final Number

getDefaultCapacity()

Number of instances to allocate as an initial capacity for this cluster.

final InstanceType

getDefaultCapacityInstance()

The instance type to use for the default capacity.

final DefaultCapacityType

getDefaultCapacityType()

The default capacity type for the cluster.

final EndpointAccess

getEndpointAccess()

Configure access to the Kubernetes API server endpoint..

final IpFamily

getIpFamily()

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

final Map<String,String>

getKubectlEnvironment()

Environment variables for the kubectl execution.

final IRole

getKubectlLambdaRole()

The IAM role to pass to the Kubectl Lambda Handler.

final ILayerVersion

getKubectlLayer()

An AWS Lambda Layer which includes kubectl and Helm.

final Size

getKubectlMemory()

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

final IRole

getMastersRole()

An IAM role that will be added to the system:masters Kubernetes RBAC group.

final ILayerVersion

getOnEventLayer()

An AWS Lambda Layer which includes the NPM dependency proxy-agent.

final Boolean

getOutputClusterName()

Determines whether a CloudFormation output with the name of the cluster will be synthesized.

final Boolean

getOutputConfigCommand()

Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.

final Boolean

getOutputMastersRoleArn()

Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).

final Boolean

getPlaceClusterHandlerInVpc()

If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.

final Boolean

getPrune()

Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.

final List<RemoteNodeNetwork>

getRemoteNodeNetworks()

IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.

final List<RemotePodNetwork>

getRemotePodNetworks()

IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.

final IRole

getRole()

Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

final IKey

getSecretsEncryptionKey()

KMS secret for envelope encryption for Kubernetes secrets.

final ISecurityGroup

getSecurityGroup()

Security Group to use for Control Plane ENIs.

final String

getServiceIpv4Cidr()

The CIDR block to assign Kubernetes service IP addresses from.

final Map<String,String>

getTags()

The tags assigned to the EKS cluster.

final KubernetesVersion

getVersion()

The Kubernetes version to run in the cluster.

final IVpc

getVpc()

The VPC in which to create the Cluster.

final List<SubnetSelection>

getVpcSubnets()

Where to place EKS Control Plane ENIs.

final int

hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Jsii$Proxy
  
  protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
  
  Constructor that initializes the object based on values retrieved from the JsiiObject.
  
  Parameters:
  
  objRef - Reference to the JSII managed object.
- Jsii$Proxy
  
  protected Jsii$Proxy(ClusterProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the ClusterProps.Builder.
Method Details
- getBootstrapClusterCreatorAdminPermissions
  
  public final Boolean getBootstrapClusterCreatorAdminPermissions()
  
  Description copied from interface: ClusterProps
  
  Whether or not IAM principal of the cluster creator was set as a cluster admin access entry during cluster creation time.
  Changing this value after the cluster has been created will result in the cluster being replaced.
  Default: true
  
  Specified by:
  
  getBootstrapClusterCreatorAdminPermissions in interface ClusterProps
- getBootstrapSelfManagedAddons
  
  public final Boolean getBootstrapSelfManagedAddons()
  
  Description copied from interface: ClusterProps
  
  If you set this value to False when creating a cluster, the default networking add-ons will not be installed.
  The default networking addons include vpc-cni, coredns, and kube-proxy. Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.
  Changing this value after the cluster has been created will result in the cluster being replaced.
  Default: true
  
  Specified by:
  
  getBootstrapSelfManagedAddons in interface ClusterProps
- getDefaultCapacity
  
  public final Number getDefaultCapacity()
  
  Description copied from interface: ClusterProps
  
  Number of instances to allocate as an initial capacity for this cluster.
  Instance type can be configured through defaultCapacityInstanceType, which defaults to m5.large.
  Use cluster.addAutoScalingGroupCapacity to add additional customized capacity. Set this to 0 is you wish to avoid the initial capacity allocation.
  Default: 2
  
  Specified by:
  
  getDefaultCapacity in interface ClusterProps
- getDefaultCapacityInstance
  
  public final InstanceType getDefaultCapacityInstance()
  
  Description copied from interface: ClusterProps
  
  The instance type to use for the default capacity.
  This will only be taken into account if defaultCapacity is > 0.
  Default: m5.large
  
  Specified by:
  
  getDefaultCapacityInstance in interface ClusterProps
- getDefaultCapacityType
  
  public final DefaultCapacityType getDefaultCapacityType()
  
  Description copied from interface: ClusterProps
  
  The default capacity type for the cluster.
  Default: NODEGROUP
  
  Specified by:
  
  getDefaultCapacityType in interface ClusterProps
- getKubectlLambdaRole
  
  public final IRole getKubectlLambdaRole()
  
  Description copied from interface: ClusterProps
  
  The IAM role to pass to the Kubectl Lambda Handler.
  Default: - Default Lambda IAM Execution Role
  
  Specified by:
  
  getKubectlLambdaRole in interface ClusterProps
- getTags
  
  public final Map<String,String> getTags()
  
  Description copied from interface: ClusterProps
  
  The tags assigned to the EKS cluster.
  Default: - none
  
  Specified by:
  
  getTags in interface ClusterProps
- getKubectlLayer
  
  public final ILayerVersion getKubectlLayer()
  
  Description copied from interface: ClusterOptions
  An AWS Lambda Layer which includes kubectl and Helm.
  This layer is used by the kubectl handler to apply manifests and install helm charts. You must pick an appropriate releases of one of the @aws-cdk/layer-kubectl-vXX packages, that works with the version of Kubernetes you have chosen.
  The handler expects the layer to include the following executables:
  
  /opt/helm/helm /opt/kubectl/kubectl
  Specified by:
  
  getKubectlLayer in interface ClusterOptions
- getAlbController
  
  public final AlbControllerOptions getAlbController()
  
  Description copied from interface: ClusterOptions
  
  Install the AWS Load Balancer Controller onto the cluster.
  Default: - The controller is not installed.
  Specified by:
  
  getAlbController in interface ClusterOptions
  
  See Also:
  
  https://kubernetes-sigs.github.io/aws-load-balancer-controller
- getAuthenticationMode
  
  public final AuthenticationMode getAuthenticationMode()
  
  Description copied from interface: ClusterOptions
  
  The desired authentication mode for the cluster.
  Default: AuthenticationMode.CONFIG_MAP
  
  Specified by:
  
  getAuthenticationMode in interface ClusterOptions
- getAwscliLayer
  
  public final ILayerVersion getAwscliLayer()
  
  Description copied from interface: ClusterOptions
  An AWS Lambda layer that contains the aws CLI.
  The handler expects the layer to include the following executables:
  
  /opt/awscli/aws
  
  Default: - a default layer with the AWS CLI 1.x
  Specified by:
  
  getAwscliLayer in interface ClusterOptions
- getClusterHandlerEnvironment
  
  public final Map<String,String> getClusterHandlerEnvironment()
  
  Description copied from interface: ClusterOptions
  
  Custom environment variables when interacting with the EKS endpoint to manage the cluster lifecycle.
  Default: - No environment variables.
  
  Specified by:
  
  getClusterHandlerEnvironment in interface ClusterOptions
- getClusterHandlerSecurityGroup
  
  public final ISecurityGroup getClusterHandlerSecurityGroup()
  
  Description copied from interface: ClusterOptions
  
  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 ClusterOptions
- getClusterLogging
  
  public final List<ClusterLoggingTypes> getClusterLogging()
  
  Description copied from interface: ClusterOptions
  
  The cluster log types which you want to enable.
  Default: - none
  
  Specified by:
  
  getClusterLogging in interface ClusterOptions
- getCoreDnsComputeType
  
  public final CoreDnsComputeType getCoreDnsComputeType()
  
  Description copied from interface: ClusterOptions
  
  Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.
  Default: CoreDnsComputeType.EC2 (for `FargateCluster` the default is FARGATE)
  
  Specified by:
  
  getCoreDnsComputeType in interface ClusterOptions
- getEndpointAccess
  
  public final EndpointAccess getEndpointAccess()
  
  Description copied from interface: ClusterOptions
  
  Configure access to the Kubernetes API server endpoint..
  Default: EndpointAccess.PUBLIC_AND_PRIVATE
  Specified by:
  
  getEndpointAccess in interface ClusterOptions
  
  See Also:
  
  https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html
- getIpFamily
  
  public final IpFamily getIpFamily()
  
  Description copied from interface: ClusterOptions
  
  Specify which IP family is used to assign Kubernetes pod and service IP addresses.
  Default: - IpFamily.IP_V4
  Specified by:
  
  getIpFamily in interface ClusterOptions
  
  See Also:
  
  https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-ipFamily
- getKubectlEnvironment
  
  public final Map<String,String> getKubectlEnvironment()
  
  Description copied from interface: ClusterOptions
  
  Environment variables for the kubectl execution.
  Only relevant for kubectl enabled clusters.
  Default: - No environment variables.
  
  Specified by:
  
  getKubectlEnvironment in interface ClusterOptions
- getKubectlMemory
  
  public final Size getKubectlMemory()
  
  Description copied from interface: ClusterOptions
  
  Amount of memory to allocate to the provider's lambda function.
  Default: Size.gibibytes(1)
  
  Specified by:
  
  getKubectlMemory in interface ClusterOptions
- getMastersRole
  
  public final IRole getMastersRole()
  
  Description copied from interface: ClusterOptions
  
  An IAM role that will be added to the system:masters Kubernetes RBAC group.
  Default: - no masters role.
  Specified by:
  
  getMastersRole in interface ClusterOptions
  
  See Also:
  
  https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings
- getOnEventLayer
  
  public final ILayerVersion getOnEventLayer()
  
  Description copied from interface: ClusterOptions
  An AWS Lambda Layer which includes the NPM dependency proxy-agent.
  This layer is used by the onEvent handler to route AWS SDK requests through a proxy.
  By default, the provider will use the layer included in the "aws-lambda-layer-node-proxy-agent" SAR application which is available in all commercial regions.
  To deploy the layer locally define it in your app as follows:
  
  LayerVersion layer = LayerVersion.Builder.create(this, "proxy-agent-layer") .code(Code.fromAsset(String.format("%s/layer.zip", __dirname))) .compatibleRuntimes(List.of(Runtime.NODEJS_LATEST)) .build();
  
  Default: - a layer bundled with this module.
  Specified by:
  
  getOnEventLayer in interface ClusterOptions
- getOutputMastersRoleArn
  
  public final Boolean getOutputMastersRoleArn()
  
  Description copied from interface: ClusterOptions
  
  Determines whether a CloudFormation output with the ARN of the "masters" IAM role will be synthesized (if mastersRole is specified).
  Default: false
  
  Specified by:
  
  getOutputMastersRoleArn in interface ClusterOptions
- getPlaceClusterHandlerInVpc
  
  public final Boolean getPlaceClusterHandlerInVpc()
  
  Description copied from interface: ClusterOptions
  
  If set to true, the cluster handler functions will be placed in the private subnets of the cluster vpc, subject to the vpcSubnets selection strategy.
  Default: false
  
  Specified by:
  
  getPlaceClusterHandlerInVpc in interface ClusterOptions
- getPrune
  
  public final Boolean getPrune()
  
  Description copied from interface: ClusterOptions
  
  Indicates whether Kubernetes resources added through addManifest() 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.
  Default: true
  
  Specified by:
  
  getPrune in interface ClusterOptions
- getRemoteNodeNetworks
  
  public final List<RemoteNodeNetwork> getRemoteNodeNetworks()
  
  Description copied from interface: ClusterOptions
  
  IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.
  Default: - none
  
  Specified by:
  
  getRemoteNodeNetworks in interface ClusterOptions
- getRemotePodNetworks
  
  public final List<RemotePodNetwork> getRemotePodNetworks()
  
  Description copied from interface: ClusterOptions
  
  IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.
  Default: - none
  
  Specified by:
  
  getRemotePodNetworks in interface ClusterOptions
- getSecretsEncryptionKey
  
  public final IKey getSecretsEncryptionKey()
  
  Description copied from interface: ClusterOptions
  
  KMS secret for envelope encryption for Kubernetes secrets.
  Default: - By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys.
  
  Specified by:
  
  getSecretsEncryptionKey in interface ClusterOptions
- getServiceIpv4Cidr
  
  public final String getServiceIpv4Cidr()
  
  Description copied from interface: ClusterOptions
  
  The CIDR block to assign Kubernetes service IP addresses from.
  Default: - Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks
  Specified by:
  
  getServiceIpv4Cidr in interface ClusterOptions
  
  See Also:
  
  https://docs.aws.amazon.com/eks/latest/APIReference/API_KubernetesNetworkConfigRequest.html#AmazonEKS-Type-KubernetesNetworkConfigRequest-serviceIpv4Cidr
- getVersion
  
  public final KubernetesVersion getVersion()
  
  Description copied from interface: CommonClusterOptions
  
  The Kubernetes version to run in the cluster.
  
  Specified by:
  
  getVersion in interface CommonClusterOptions
- getClusterName
  
  public final String getClusterName()
  
  Description copied from interface: CommonClusterOptions
  
  Name for the cluster.
  Default: - Automatically generated name
  
  Specified by:
  
  getClusterName in interface CommonClusterOptions
- getOutputClusterName
  
  public final Boolean getOutputClusterName()
  
  Description copied from interface: CommonClusterOptions
  
  Determines whether a CloudFormation output with the name of the cluster will be synthesized.
  Default: false
  
  Specified by:
  
  getOutputClusterName in interface CommonClusterOptions
- getOutputConfigCommand
  
  public final Boolean getOutputConfigCommand()
  
  Description copied from interface: CommonClusterOptions
  
  Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.
  This command will include the cluster name and the ARN of the masters IAM role.
  Note: If mastersRole is not specified, this property will be ignored and no config command will be emitted.
  Default: true
  Specified by:
  
  getOutputConfigCommand in interface CommonClusterOptions
  
  See Also:
  
  https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks-readme.html#masters-role
- getRole
  
  public final IRole getRole()
  
  Description copied from interface: CommonClusterOptions
  
  Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
  Default: - A role is automatically created for you
  
  Specified by:
  
  getRole in interface CommonClusterOptions
- getSecurityGroup
  
  public final ISecurityGroup getSecurityGroup()
  
  Description copied from interface: CommonClusterOptions
  
  Security Group to use for Control Plane ENIs.
  Default: - A security group is automatically created
  
  Specified by:
  
  getSecurityGroup in interface CommonClusterOptions
- getVpc
  
  public final IVpc getVpc()
  
  Description copied from interface: CommonClusterOptions
  
  The VPC in which to create the Cluster.
  Default: - a VPC with default configuration will be created and can be accessed through `cluster.vpc`.
  
  Specified by:
  
  getVpc in interface CommonClusterOptions
- getVpcSubnets
  
  public final List<SubnetSelection> getVpcSubnets()
  
  Description copied from interface: CommonClusterOptions
  
  Where to place EKS Control Plane ENIs.
  For example, to only select private subnets, supply the following:
  vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]
  Default: - All public and private subnets
  
  Specified by:
  
  getVpcSubnets in interface CommonClusterOptions
- $jsii$toJson
  
  @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
  
  Specified by:
  
  $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
- equals
  
  public final boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public final int hashCode()
  
  Overrides:
  
  hashCode in class Object

Class ClusterProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getBootstrapClusterCreatorAdminPermissions

getBootstrapSelfManagedAddons

getDefaultCapacity

getDefaultCapacityInstance

getDefaultCapacityType

getKubectlLambdaRole

getTags

getKubectlLayer

getAlbController

getAuthenticationMode

getAwscliLayer

getClusterHandlerEnvironment

getClusterHandlerSecurityGroup

getClusterLogging

getCoreDnsComputeType

getEndpointAccess

getIpFamily

getKubectlEnvironment

getKubectlMemory

getMastersRole

getOnEventLayer

getOutputMastersRoleArn

getPlaceClusterHandlerInVpc

getPrune

getRemoteNodeNetworks

getRemotePodNetworks

getSecretsEncryptionKey

getServiceIpv4Cidr

getVersion

getClusterName

getOutputClusterName

getOutputConfigCommand

getRole

getSecurityGroup

getVpc

getVpcSubnets

$jsii$toJson

equals

hashCode