Package software.amazon.awscdk.services.eks_v2

Class ClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

ClusterCommonOptions, ClusterProps, 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_v2.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 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 List<ClusterLoggingTypes>	getClusterLogging()	The cluster log types which you want to enable.
final String	getClusterName()	Name for the cluster.
final ComputeConfig	getCompute()	Configuration for compute settings in Auto Mode.
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 KubectlProviderOptions	getKubectlProviderOptions()	Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster.
final IRole	getMastersRole()	An IAM role that will be added to the system:masters Kubernetes RBAC group.
final Boolean	getOutputConfigCommand()	Determines whether a CloudFormation output with the aws eks update-kubeconfig command will be synthesized.
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 RemovalPolicy	getRemovalPolicy()	The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation.
final IRole	getRole()	Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.
final IKeyRef	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 if the mode is not EKS Auto Mode

Specified by:

getBootstrapSelfManagedAddons in interface ClusterProps

getCompute

public final ComputeConfig getCompute()

Description copied from interface: ClusterProps

Configuration for compute settings in Auto Mode.

When enabled, EKS will automatically manage compute resources.

Default: - Auto Mode compute disabled

Specified by:

getCompute 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: AUTOMODE

Specified by:

getDefaultCapacityType in interface ClusterProps

getOutputConfigCommand

public final Boolean getOutputConfigCommand()

Description copied from interface: ClusterProps

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

This command will include the cluster name and, if applicable, the ARN of the masters IAM role.

Default: true

Specified by:

getOutputConfigCommand in interface ClusterProps

getVersion

public final KubernetesVersion getVersion()

Description copied from interface: ClusterCommonOptions

The Kubernetes version to run in the cluster.

Specified by:

getVersion in interface ClusterCommonOptions

getAlbController

public final AlbControllerOptions getAlbController()

Description copied from interface: ClusterCommonOptions

Install the AWS Load Balancer Controller onto the cluster.

Default: - The controller is not installed.

Specified by:

getAlbController in interface ClusterCommonOptions

See Also:

• https://kubernetes-sigs.github.io/aws-load-balancer-controller

getClusterLogging

public final List<ClusterLoggingTypes> getClusterLogging()

Description copied from interface: ClusterCommonOptions

The cluster log types which you want to enable.

Default: - none

Specified by:

getClusterLogging in interface ClusterCommonOptions

getClusterName

public final String getClusterName()

Description copied from interface: ClusterCommonOptions

Name for the cluster.

Default: - Automatically generated name

Specified by:

getClusterName in interface ClusterCommonOptions

getCoreDnsComputeType

public final CoreDnsComputeType getCoreDnsComputeType()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

getEndpointAccess

public final EndpointAccess getEndpointAccess()

Description copied from interface: ClusterCommonOptions

Configure access to the Kubernetes API server endpoint..

Default: EndpointAccess.PUBLIC_AND_PRIVATE

Specified by:

getEndpointAccess in interface ClusterCommonOptions

See Also:

• https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

getIpFamily

public final IpFamily getIpFamily()

Description copied from interface: ClusterCommonOptions

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

Default: IpFamily.IP_V4

Specified by:

getIpFamily in interface ClusterCommonOptions

See Also:

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

getKubectlProviderOptions

public final KubectlProviderOptions getKubectlProviderOptions()

Description copied from interface: ClusterCommonOptions

Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster.

If defined, kubectlLayer is a required property.

Default: - kubectl provider will not be created

Specified by:

getKubectlProviderOptions in interface ClusterCommonOptions

getMastersRole

public final IRole getMastersRole()

Description copied from interface: ClusterCommonOptions

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

Default: - no masters role.

Specified by:

getMastersRole in interface ClusterCommonOptions

See Also:

• https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings

getPrune

public final Boolean getPrune()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

getRemoteNodeNetworks

public final List<RemoteNodeNetwork> getRemoteNodeNetworks()

Description copied from interface: ClusterCommonOptions

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

Default: - none

Specified by:

getRemoteNodeNetworks in interface ClusterCommonOptions

getRemotePodNetworks

public final List<RemotePodNetwork> getRemotePodNetworks()

Description copied from interface: ClusterCommonOptions

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

Default: - none

Specified by:

getRemotePodNetworks in interface ClusterCommonOptions

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: ClusterCommonOptions

The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation.

This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it;
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
• The stack is deleted, so CloudFormation stops managing all resources in it.

This affects the EKS cluster itself, associated IAM roles, node groups, security groups, VPC and any other CloudFormation resources managed by this construct.

Default: - Resources will be deleted.

Specified by:

getRemovalPolicy in interface ClusterCommonOptions

getRole

public final IRole getRole()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

getSecretsEncryptionKey

public final IKeyRef getSecretsEncryptionKey()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

getSecurityGroup

public final ISecurityGroup getSecurityGroup()

Description copied from interface: ClusterCommonOptions

Security Group to use for Control Plane ENIs.

Default: - A security group is automatically created

Specified by:

getSecurityGroup in interface ClusterCommonOptions

getServiceIpv4Cidr

public final String getServiceIpv4Cidr()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

See Also:

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

getTags

public final Map<String,String> getTags()

Description copied from interface: ClusterCommonOptions

The tags assigned to the EKS cluster.

Default: - none

Specified by:

getTags in interface ClusterCommonOptions

getVpc

public final IVpc getVpc()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

getVpcSubnets

public final List<SubnetSelection> getVpcSubnets()

Description copied from interface: ClusterCommonOptions

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 ClusterCommonOptions

$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