aws-cdk-lib.aws_eks.BootstrapOptions

interface BootstrapOptions

LanguageType name
.NETAmazon.CDK.AWS.EKS.BootstrapOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseks#BootstrapOptions
Javasoftware.amazon.awscdk.services.eks.BootstrapOptions
Pythonaws_cdk.aws_eks.BootstrapOptions
TypeScript (source)aws-cdk-lib » aws_eks » BootstrapOptions

EKS node bootstrapping options.

Example

declare const cluster: eks.Cluster;
cluster.addAutoScalingGroupCapacity('spot', {
  instanceType: new ec2.InstanceType('t3.large'),
  minCapacity: 2,
  bootstrapOptions: {
    kubeletExtraArgs: '--node-labels foo=bar,goo=far',
    awsApiRetryAttempts: 5,
  },
});

Properties

NameTypeDescription
additionalArgs?stringAdditional command line arguments to pass to the /etc/eks/bootstrap.sh command.
awsApiRetryAttempts?numberNumber of retry attempts for AWS API call (DescribeCluster).
dnsClusterIp?stringOverrides the IP address to use for DNS queries within the cluster.
dockerConfigJson?stringThe contents of the /etc/docker/daemon.json file. Useful if you want a custom config differing from the default one in the EKS AMI.
enableDockerBridge?booleanRestores the docker default bridge network.
kubeletExtraArgs?stringExtra arguments to add to the kubelet. Useful for adding labels or taints.
useMaxPods?booleanSets --max-pods for the kubelet based on the capacity of the EC2 instance.

additionalArgs?

Type: string (optional, default: none)

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

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


awsApiRetryAttempts?

Type: number (optional, default: 3)

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


dnsClusterIp?

Type: string (optional, default: 10.100.0.10 or 172.20.0.10 based on the IP address of the primary interface.)

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


dockerConfigJson?

Type: string (optional, default: none)

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.


enableDockerBridge?

Type: boolean (optional, default: false)

Restores the docker default bridge network.


kubeletExtraArgs?

Type: string (optional, default: none)

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

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


useMaxPods?

Type: boolean (optional, default: true)

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