Package software.amazon.awscdk.services.eks

Interface BootstrapOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BootstrapOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:29.566Z")
@Stability(Stable)
public interface BootstrapOptions
extends software.amazon.jsii.JsiiSerializable

EKS node bootstrapping options.

Example:

 Cluster cluster;
 cluster.addAutoScalingGroupCapacity("spot", AutoScalingGroupCapacityOptions.builder()
         .instanceType(new InstanceType("t3.large"))
         .minCapacity(2)
         .bootstrapOptions(BootstrapOptions.builder()
                 .kubeletExtraArgs("--node-labels foo=bar,goo=far")
                 .awsApiRetryAttempts(5)
                 .build())
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BootstrapOptions.Builder	A builder for BootstrapOptions
static final class	BootstrapOptions.Jsii$Proxy	An implementation for BootstrapOptions

Method Summary

Modifier and Type	Method	Description
static BootstrapOptions.Builder	builder()
default String	getAdditionalArgs()	Additional command line arguments to pass to the /etc/eks/bootstrap.sh command.
default Number	getAwsApiRetryAttempts()	Number of retry attempts for AWS API call (DescribeCluster).
default String	getDnsClusterIp()	Overrides the IP address to use for DNS queries within the cluster.
default String	getDockerConfigJson()	The contents of the /etc/docker/daemon.json file.
default Boolean	getEnableDockerBridge()	Restores the docker default bridge network.
default String	getKubeletExtraArgs()	Extra arguments to add to the kubelet.
default Boolean	getUseMaxPods()	Sets --max-pods for the kubelet based on the capacity of the EC2 instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalArgs

@Stability(Stable)
@Nullable
default String getAdditionalArgs()

Additional command line arguments to pass to the /etc/eks/bootstrap.sh command.

Default: - none

See Also:

• https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh

getAwsApiRetryAttempts

@Stability(Stable)
@Nullable
default Number getAwsApiRetryAttempts()

Number of retry attempts for AWS API call (DescribeCluster).

Default: 3

getDnsClusterIp

@Stability(Stable)
@Nullable
default String getDnsClusterIp()

Overrides the IP address to use for DNS queries within the cluster.

Default: - 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface.

getDockerConfigJson

@Stability(Stable)
@Nullable
default String getDockerConfigJson()

The contents of the /etc/docker/daemon.json file. Useful if you want a custom config differing from the default one in the EKS AMI.

Default: - none

getEnableDockerBridge

@Stability(Stable)
@Nullable
default Boolean getEnableDockerBridge()

Restores the docker default bridge network.

Default: false

getKubeletExtraArgs

@Stability(Stable)
@Nullable
default String getKubeletExtraArgs()

Extra arguments to add to the kubelet. Useful for adding labels or taints.

For example, --node-labels foo=bar,goo=far.

Default: - none

getUseMaxPods

@Stability(Stable)
@Nullable
default Boolean getUseMaxPods()

Sets --max-pods for the kubelet based on the capacity of the EC2 instance.

Default: true

builder

@Stability(Stable)
static BootstrapOptions.Builder builder()

Returns:

a BootstrapOptions.Builder of BootstrapOptions