Package software.amazon.awscdk.services.eks

Class NodegroupOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

NodegroupOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

NodegroupOptions

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

An implementation for NodegroupOptions

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.NodegroupOptions

NodegroupOptions.Builder, NodegroupOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(NodegroupOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the NodegroupOptions.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 NodegroupAmiType	getAmiType()	The AMI type for your node group.
final CapacityType	getCapacityType()	The capacity type of the nodegroup.
final Number	getDesiredSize()	The current number of worker nodes that the managed node group should maintain.
final Number	getDiskSize()	The root device disk size (in GiB) for your node group instances.
final Boolean	getForceUpdate()	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
final List<InstanceType>	getInstanceTypes()	The instance types to use for your node group.
final Map<String,String>	getLabels()	The Kubernetes labels to be applied to the nodes in the node group when they are created.
final LaunchTemplateSpec	getLaunchTemplateSpec()	Launch template specification used for the nodegroup.
final Number	getMaxSize()	The maximum number of worker nodes that the managed node group can scale out to.
final Number	getMaxUnavailable()	The maximum number of nodes unavailable at once during a version update.
final Number	getMaxUnavailablePercentage()	The maximum percentage of nodes unavailable during a version update.
final Number	getMinSize()	The minimum number of worker nodes that the managed node group can scale in to.
final String	getNodegroupName()	Name of the Nodegroup.
final IRole	getNodeRole()	The IAM role to associate with your node group.
final String	getReleaseVersion()	The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD).
final NodegroupRemoteAccess	getRemoteAccess()	The remote access (SSH) configuration to use with your node group.
final SubnetSelection	getSubnets()	The subnets to use for the Auto Scaling group that is created for your node group.
final Map<String,String>	getTags()	The metadata to apply to the node group to assist with categorization and organization.
final List<TaintSpec>	getTaints()	The Kubernetes taints to be applied to the nodes in the node group when they are created.
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(NodegroupOptions.Builder builder)

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

Method Details

getAmiType

public final NodegroupAmiType getAmiType()

Description copied from interface: NodegroupOptions

The AMI type for your node group.

If you explicitly specify the launchTemplate with custom AMI, do not specify this property, or the node group deployment will fail. In other cases, you will need to specify correct amiType for the nodegroup.

Default: - auto-determined from the instanceTypes property when launchTemplateSpec property is not specified

Specified by:

getAmiType in interface NodegroupOptions

getCapacityType

public final CapacityType getCapacityType()

Description copied from interface: NodegroupOptions

The capacity type of the nodegroup.

Default: - ON_DEMAND

Specified by:

getCapacityType in interface NodegroupOptions

getDesiredSize

public final Number getDesiredSize()

Description copied from interface: NodegroupOptions

The current number of worker nodes that the managed node group should maintain.

If not specified, the nodewgroup will initially create minSize instances.

Default: 2

Specified by:

getDesiredSize in interface NodegroupOptions

getDiskSize

public final Number getDiskSize()

Description copied from interface: NodegroupOptions

The root device disk size (in GiB) for your node group instances.

Default: 20

Specified by:

getDiskSize in interface NodegroupOptions

getForceUpdate

public final Boolean getForceUpdate()

Description copied from interface: NodegroupOptions

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.

If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

Default: true

Specified by:

getForceUpdate in interface NodegroupOptions

getInstanceTypes

public final List<InstanceType> getInstanceTypes()

Description copied from interface: NodegroupOptions

The instance types to use for your node group.

Default: t3.medium will be used according to the cloudformation document.

Specified by:

getInstanceTypes in interface NodegroupOptions

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes

getLabels

public final Map<String,String> getLabels()

Description copied from interface: NodegroupOptions

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Default: - None

Specified by:

getLabels in interface NodegroupOptions

getLaunchTemplateSpec

public final LaunchTemplateSpec getLaunchTemplateSpec()

Description copied from interface: NodegroupOptions

Launch template specification used for the nodegroup.

Default: - no launch template

Specified by:

getLaunchTemplateSpec in interface NodegroupOptions

See Also:

• https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html

getMaxSize

public final Number getMaxSize()

Description copied from interface: NodegroupOptions

The maximum number of worker nodes that the managed node group can scale out to.

Managed node groups can support up to 100 nodes by default.

Default: - desiredSize

Specified by:

getMaxSize in interface NodegroupOptions

getMaxUnavailable

public final Number getMaxUnavailable()

Description copied from interface: NodegroupOptions

The maximum number of nodes unavailable at once during a version update.

Nodes will be updated in parallel. The maximum number is 100.

This value or maxUnavailablePercentage is required to have a value for custom update configurations to be applied.

Default: 1

Specified by:

getMaxUnavailable in interface NodegroupOptions

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailable

getMaxUnavailablePercentage

public final Number getMaxUnavailablePercentage()

Description copied from interface: NodegroupOptions

The maximum percentage of nodes unavailable during a version update.

This percentage of nodes will be updated in parallel, up to 100 nodes at once.

This value or maxUnavailable is required to have a value for custom update configurations to be applied.

Default: undefined - node groups will update instances one at a time

Specified by:

getMaxUnavailablePercentage in interface NodegroupOptions

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-nodegroup-updateconfig.html#cfn-eks-nodegroup-updateconfig-maxunavailablepercentage

getMinSize

public final Number getMinSize()

Description copied from interface: NodegroupOptions

The minimum number of worker nodes that the managed node group can scale in to.

This number must be greater than or equal to zero.

Default: 1

Specified by:

getMinSize in interface NodegroupOptions

getNodegroupName

public final String getNodegroupName()

Description copied from interface: NodegroupOptions

Name of the Nodegroup.

Default: - resource ID

Specified by:

getNodegroupName in interface NodegroupOptions

getNodeRole

public final IRole getNodeRole()

Description copied from interface: NodegroupOptions

The IAM role to associate with your node group.

The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched.

Default: - None. Auto-generated if not specified.

Specified by:

getNodeRole in interface NodegroupOptions

getReleaseVersion

public final String getReleaseVersion()

Description copied from interface: NodegroupOptions

The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD).

Default: - The latest available AMI version for the node group's current Kubernetes version is used.

Specified by:

getReleaseVersion in interface NodegroupOptions

getRemoteAccess

public final NodegroupRemoteAccess getRemoteAccess()

Description copied from interface: NodegroupOptions

The remote access (SSH) configuration to use with your node group.

Disabled by default, however, if you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0)

Default: - disabled

Specified by:

getRemoteAccess in interface NodegroupOptions

getSubnets

public final SubnetSelection getSubnets()

Description copied from interface: NodegroupOptions

The subnets to use for the Auto Scaling group that is created for your node group.

By specifying the SubnetSelection, the selected subnets will automatically apply required tags i.e. kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where CLUSTER_NAME is replaced with the name of your cluster.

Default: - private subnets

Specified by:

getSubnets in interface NodegroupOptions

getTags

public final Map<String,String> getTags()

Description copied from interface: NodegroupOptions

The metadata to apply to the node group to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

Default: - None

Specified by:

getTags in interface NodegroupOptions

getTaints

public final List<TaintSpec> getTaints()

Description copied from interface: NodegroupOptions

The Kubernetes taints to be applied to the nodes in the node group when they are created.

Default: - None

Specified by:

getTaints in interface NodegroupOptions

$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