eks.ManagedNodeGroup
Explore with Pulumi AI
ManagedNodeGroup is a component that wraps creating an AWS managed node group.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html
Create ManagedNodeGroup Resource
new ManagedNodeGroup(name: string, args: ManagedNodeGroupArgs, opts?: CustomResourceOptions);
@overload
def ManagedNodeGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
ami_type: Optional[str] = None,
capacity_type: Optional[str] = None,
cluster: Optional[Union[Cluster, CoreDataArgs]] = None,
cluster_name: Optional[str] = None,
disk_size: Optional[int] = None,
force_update_version: Optional[bool] = None,
instance_types: Optional[Sequence[str]] = None,
labels: Optional[Mapping[str, str]] = None,
launch_template: Optional[pulumi_aws.eks.NodeGroupLaunchTemplateArgs] = None,
node_group_name: Optional[str] = None,
node_group_name_prefix: Optional[str] = None,
node_role: Optional[pulumi_aws.iam.Role] = None,
node_role_arn: Optional[str] = None,
release_version: Optional[str] = None,
remote_access: Optional[pulumi_aws.eks.NodeGroupRemoteAccessArgs] = None,
scaling_config: Optional[pulumi_aws.eks.NodeGroupScalingConfigArgs] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
taints: Optional[Sequence[pulumi_aws.eks.NodeGroupTaintArgs]] = None,
version: Optional[str] = None)
@overload
def ManagedNodeGroup(resource_name: str,
args: ManagedNodeGroupArgs,
opts: Optional[ResourceOptions] = None)
func NewManagedNodeGroup(ctx *Context, name string, args ManagedNodeGroupArgs, opts ...ResourceOption) (*ManagedNodeGroup, error)
public ManagedNodeGroup(string name, ManagedNodeGroupArgs args, CustomResourceOptions? opts = null)
public ManagedNodeGroup(String name, ManagedNodeGroupArgs args)
public ManagedNodeGroup(String name, ManagedNodeGroupArgs args, CustomResourceOptions options)
type: eks:ManagedNodeGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ManagedNodeGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ManagedNodeGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ManagedNodeGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ManagedNodeGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ManagedNodeGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ManagedNodeGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ManagedNodeGroup resource accepts the following input properties:
- Cluster
Pulumi.
Eks. Cluster | Core Data Args The target EKS cluster.
- Ami
Type string Type of Amazon Machine Image (AMI) associated with the EKS Node Group. Defaults to
AL2_x86_64
. See the AWS documentation (https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid AMI Types. This provider will only perform drift detection if a configuration value is provided.- Capacity
Type string Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
. This provider will only perform drift detection if a configuration value is provided.- Cluster
Name string Name of the EKS Cluster.
- Disk
Size int Disk size in GiB for worker nodes. Defaults to
20
. This provider will only perform drift detection if a configuration value is provided.- Force
Update boolVersion Force version update if existing pods are unable to be drained due to a pod disruption budget issue.
- Instance
Types List<string> Set of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. This provider will only perform drift detection if a configuration value is provided. Currently, the EKS API only accepts a single value in the set.- Labels Dictionary<string, string>
Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
- Launch
Template Pulumi.Aws. Eks. Inputs. Node Group Launch Template Args Launch Template settings.
- Node
Group stringName Name of the EKS Node Group. If omitted, this provider will assign a random, unique name. Conflicts with
nodeGroupNamePrefix
.- Node
Group stringName Prefix Creates a unique name beginning with the specified prefix. Conflicts with
nodeGroupName
.- Node
Role Pulumi.Aws. Iam. Role The IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRole
andnodeRoleArn
are mutually exclusive, and a single option must be used.- Node
Role stringArn Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRoleArn
andnodeRole
are mutually exclusive, and a single option must be used.- Release
Version string AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- Remote
Access Pulumi.Aws. Eks. Inputs. Node Group Remote Access Args Remote access settings.
- Scaling
Config Pulumi.Aws. Eks. Inputs. Node Group Scaling Config Args Scaling settings.
Default scaling amounts of the node group autoscaling group are:
- desiredSize: 2
- minSize: 1
- maxSize: 2
- Subnet
Ids List<string> Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag:
kubernetes.io/cluster/CLUSTER_NAME
(whereCLUSTER_NAME
is replaced with the name of the EKS Cluster).Default subnetIds is chosen from the following list, in order, if subnetIds arg is not set:
- core.subnetIds
- core.privateIds
- core.publicSubnetIds
This default logic is based on the existing subnet IDs logic of this package: https://git.io/JeM11
- Dictionary<string, string>
Key-value mapping of resource tags.
- Taints
List<Pulumi.
Aws. Eks. Inputs. Node Group Taint Args> The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.
- Version string
- Cluster
Cluster | Core
Data Args The target EKS cluster.
- Ami
Type string Type of Amazon Machine Image (AMI) associated with the EKS Node Group. Defaults to
AL2_x86_64
. See the AWS documentation (https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid AMI Types. This provider will only perform drift detection if a configuration value is provided.- Capacity
Type string Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
. This provider will only perform drift detection if a configuration value is provided.- Cluster
Name string Name of the EKS Cluster.
- Disk
Size int Disk size in GiB for worker nodes. Defaults to
20
. This provider will only perform drift detection if a configuration value is provided.- Force
Update boolVersion Force version update if existing pods are unable to be drained due to a pod disruption budget issue.
- Instance
Types []string Set of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. This provider will only perform drift detection if a configuration value is provided. Currently, the EKS API only accepts a single value in the set.- Labels map[string]string
Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
- Launch
Template NodeGroup Launch Template Args Launch Template settings.
- Node
Group stringName Name of the EKS Node Group. If omitted, this provider will assign a random, unique name. Conflicts with
nodeGroupNamePrefix
.- Node
Group stringName Prefix Creates a unique name beginning with the specified prefix. Conflicts with
nodeGroupName
.- Node
Role Role The IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRole
andnodeRoleArn
are mutually exclusive, and a single option must be used.- Node
Role stringArn Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRoleArn
andnodeRole
are mutually exclusive, and a single option must be used.- Release
Version string AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- Remote
Access NodeGroup Remote Access Args Remote access settings.
- Scaling
Config NodeGroup Scaling Config Args Scaling settings.
Default scaling amounts of the node group autoscaling group are:
- desiredSize: 2
- minSize: 1
- maxSize: 2
- Subnet
Ids []string Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag:
kubernetes.io/cluster/CLUSTER_NAME
(whereCLUSTER_NAME
is replaced with the name of the EKS Cluster).Default subnetIds is chosen from the following list, in order, if subnetIds arg is not set:
- core.subnetIds
- core.privateIds
- core.publicSubnetIds
This default logic is based on the existing subnet IDs logic of this package: https://git.io/JeM11
- map[string]string
Key-value mapping of resource tags.
- Taints
Node
Group Taint Args The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.
- Version string
- cluster
Cluster | Core
Data Args The target EKS cluster.
- ami
Type String Type of Amazon Machine Image (AMI) associated with the EKS Node Group. Defaults to
AL2_x86_64
. See the AWS documentation (https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid AMI Types. This provider will only perform drift detection if a configuration value is provided.- capacity
Type String Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
. This provider will only perform drift detection if a configuration value is provided.- cluster
Name String Name of the EKS Cluster.
- disk
Size Integer Disk size in GiB for worker nodes. Defaults to
20
. This provider will only perform drift detection if a configuration value is provided.- force
Update BooleanVersion Force version update if existing pods are unable to be drained due to a pod disruption budget issue.
- instance
Types List<String> Set of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. This provider will only perform drift detection if a configuration value is provided. Currently, the EKS API only accepts a single value in the set.- labels Map<String,String>
Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
- launch
Template NodeGroup Launch Template Args Launch Template settings.
- node
Group StringName Name of the EKS Node Group. If omitted, this provider will assign a random, unique name. Conflicts with
nodeGroupNamePrefix
.- node
Group StringName Prefix Creates a unique name beginning with the specified prefix. Conflicts with
nodeGroupName
.- node
Role Role The IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRole
andnodeRoleArn
are mutually exclusive, and a single option must be used.- node
Role StringArn Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRoleArn
andnodeRole
are mutually exclusive, and a single option must be used.- release
Version String AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access NodeGroup Remote Access Args Remote access settings.
- scaling
Config NodeGroup Scaling Config Args Scaling settings.
Default scaling amounts of the node group autoscaling group are:
- desiredSize: 2
- minSize: 1
- maxSize: 2
- subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag:
kubernetes.io/cluster/CLUSTER_NAME
(whereCLUSTER_NAME
is replaced with the name of the EKS Cluster).Default subnetIds is chosen from the following list, in order, if subnetIds arg is not set:
- core.subnetIds
- core.privateIds
- core.publicSubnetIds
This default logic is based on the existing subnet IDs logic of this package: https://git.io/JeM11
- Map<String,String>
Key-value mapping of resource tags.
- taints
List<Node
Group Taint Args> The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.
- version String
- cluster
Cluster | Core
Data Args The target EKS cluster.
- ami
Type string Type of Amazon Machine Image (AMI) associated with the EKS Node Group. Defaults to
AL2_x86_64
. See the AWS documentation (https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid AMI Types. This provider will only perform drift detection if a configuration value is provided.- capacity
Type string Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
. This provider will only perform drift detection if a configuration value is provided.- cluster
Name string Name of the EKS Cluster.
- disk
Size number Disk size in GiB for worker nodes. Defaults to
20
. This provider will only perform drift detection if a configuration value is provided.- force
Update booleanVersion Force version update if existing pods are unable to be drained due to a pod disruption budget issue.
- instance
Types string[] Set of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. This provider will only perform drift detection if a configuration value is provided. Currently, the EKS API only accepts a single value in the set.- labels {[key: string]: string}
Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
- launch
Template pulumiAwstypesinputeks Node Group Launch Template Launch Template settings.
- node
Group stringName Name of the EKS Node Group. If omitted, this provider will assign a random, unique name. Conflicts with
nodeGroupNamePrefix
.- node
Group stringName Prefix Creates a unique name beginning with the specified prefix. Conflicts with
nodeGroupName
.- node
Role pulumiAwsiam Role The IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRole
andnodeRoleArn
are mutually exclusive, and a single option must be used.- node
Role stringArn Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRoleArn
andnodeRole
are mutually exclusive, and a single option must be used.- release
Version string AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access pulumiAwstypesinputeks Node Group Remote Access Remote access settings.
- scaling
Config pulumiAwstypesinputeks Node Group Scaling Config Scaling settings.
Default scaling amounts of the node group autoscaling group are:
- desiredSize: 2
- minSize: 1
- maxSize: 2
- subnet
Ids string[] Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag:
kubernetes.io/cluster/CLUSTER_NAME
(whereCLUSTER_NAME
is replaced with the name of the EKS Cluster).Default subnetIds is chosen from the following list, in order, if subnetIds arg is not set:
- core.subnetIds
- core.privateIds
- core.publicSubnetIds
This default logic is based on the existing subnet IDs logic of this package: https://git.io/JeM11
- {[key: string]: string}
Key-value mapping of resource tags.
- taints
pulumi
Awstypesinputeks Node Group Taint[] The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.
- version string
- cluster
Cluster | Core
Data Args The target EKS cluster.
- ami_
type str Type of Amazon Machine Image (AMI) associated with the EKS Node Group. Defaults to
AL2_x86_64
. See the AWS documentation (https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid AMI Types. This provider will only perform drift detection if a configuration value is provided.- capacity_
type str Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
. This provider will only perform drift detection if a configuration value is provided.- cluster_
name str Name of the EKS Cluster.
- disk_
size int Disk size in GiB for worker nodes. Defaults to
20
. This provider will only perform drift detection if a configuration value is provided.- force_
update_ boolversion Force version update if existing pods are unable to be drained due to a pod disruption budget issue.
- instance_
types Sequence[str] Set of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. This provider will only perform drift detection if a configuration value is provided. Currently, the EKS API only accepts a single value in the set.- labels Mapping[str, str]
Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
- launch_
template NodeGroup Launch Template Args Launch Template settings.
- node_
group_ strname Name of the EKS Node Group. If omitted, this provider will assign a random, unique name. Conflicts with
nodeGroupNamePrefix
.- node_
group_ strname_ prefix Creates a unique name beginning with the specified prefix. Conflicts with
nodeGroupName
.- node_
role Role The IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRole
andnodeRoleArn
are mutually exclusive, and a single option must be used.- node_
role_ strarn Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRoleArn
andnodeRole
are mutually exclusive, and a single option must be used.- release_
version str AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote_
access NodeGroup Remote Access Args Remote access settings.
- scaling_
config NodeGroup Scaling Config Args Scaling settings.
Default scaling amounts of the node group autoscaling group are:
- desiredSize: 2
- minSize: 1
- maxSize: 2
- subnet_
ids Sequence[str] Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag:
kubernetes.io/cluster/CLUSTER_NAME
(whereCLUSTER_NAME
is replaced with the name of the EKS Cluster).Default subnetIds is chosen from the following list, in order, if subnetIds arg is not set:
- core.subnetIds
- core.privateIds
- core.publicSubnetIds
This default logic is based on the existing subnet IDs logic of this package: https://git.io/JeM11
- Mapping[str, str]
Key-value mapping of resource tags.
- taints
Node
Group Taint Args] The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.
- version str
- cluster eks:Cluster | Property Map
The target EKS cluster.
- ami
Type String Type of Amazon Machine Image (AMI) associated with the EKS Node Group. Defaults to
AL2_x86_64
. See the AWS documentation (https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid AMI Types. This provider will only perform drift detection if a configuration value is provided.- capacity
Type String Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
. This provider will only perform drift detection if a configuration value is provided.- cluster
Name String Name of the EKS Cluster.
- disk
Size Number Disk size in GiB for worker nodes. Defaults to
20
. This provider will only perform drift detection if a configuration value is provided.- force
Update BooleanVersion Force version update if existing pods are unable to be drained due to a pod disruption budget issue.
- instance
Types List<String> Set of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. This provider will only perform drift detection if a configuration value is provided. Currently, the EKS API only accepts a single value in the set.- labels Map<String>
Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.
- launch
Template Property Map Launch Template settings.
- node
Group StringName Name of the EKS Node Group. If omitted, this provider will assign a random, unique name. Conflicts with
nodeGroupNamePrefix
.- node
Group StringName Prefix Creates a unique name beginning with the specified prefix. Conflicts with
nodeGroupName
.- node
Role aws:iam:Role The IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRole
andnodeRoleArn
are mutually exclusive, and a single option must be used.- node
Role StringArn Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
Note,
nodeRoleArn
andnodeRole
are mutually exclusive, and a single option must be used.- release
Version String AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access Property Map Remote access settings.
- scaling
Config Property Map Scaling settings.
Default scaling amounts of the node group autoscaling group are:
- desiredSize: 2
- minSize: 1
- maxSize: 2
- subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag:
kubernetes.io/cluster/CLUSTER_NAME
(whereCLUSTER_NAME
is replaced with the name of the EKS Cluster).Default subnetIds is chosen from the following list, in order, if subnetIds arg is not set:
- core.subnetIds
- core.privateIds
- core.publicSubnetIds
This default logic is based on the existing subnet IDs logic of this package: https://git.io/JeM11
- Map<String>
Key-value mapping of resource tags.
- taints List<Property Map>
The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.
- version String
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagedNodeGroup resource produces the following output properties:
- Node
Group Pulumi.Aws. Eks. Node Group The AWS managed node group.
- Node
Group NodeGroup The AWS managed node group.
- node
Group NodeGroup The AWS managed node group.
- node
Group pulumiAwseks Node Group The AWS managed node group.
- node_
group NodeGroup The AWS managed node group.
- node
Group aws:eks:NodeGroup The AWS managed node group.
Supporting Types
ClusterNodeGroupOptions
- Ami
Id string The AMI ID to use for the worker nodes.
Defaults to the latest recommended EKS Optimized Linux AMI from the AWS Systems Manager Parameter Store.
Note:
amiId
andgpu
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html.
- Ami
Type string The AMI Type to use for the worker nodes.
Only applicable when setting an AMI ID that is of type
arm64
.Note:
amiType
andgpu
are mutually exclusive.- Dictionary<string, string>
The tags to apply to the NodeGroup's AutoScalingGroup in the CloudFormation Stack.
Per AWS, all stack-level tags, including automatically created tags, and the
cloudFormationTags
option are propagated to resources that AWS CloudFormation supports, including the AutoScalingGroup. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.htmlNote: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- Bootstrap
Extra stringArgs Additional args to pass directly to
/etc/eks/bootstrap.sh
. For details on available options, see: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh. Note that the--apiserver-endpoint
,--b64-cluster-ca
and--kubelet-extra-args
flags are included automatically based on other configuration parameters.- Dictionary<string, string>
The tags to apply to the CloudFormation Stack of the Worker NodeGroup.
Note: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- Cluster
Ingress Pulumi.Rule Aws. Ec2. Security Group Rule The ingress rule that gives node group access.
- Desired
Capacity int The number of worker nodes that should be running in the cluster. Defaults to 2.
- Encrypt
Root boolBlock Device Encrypt the root block device of the nodes in the node group.
- Extra
Node List<Pulumi.Security Groups Aws. Ec2. Security Group> Extra security groups to attach on all nodes in this worker node group.
This additional set of security groups captures any user application rules that will be needed for the nodes.
- Gpu bool
Use the latest recommended EKS Optimized Linux AMI with GPU support for the worker nodes from the AWS Systems Manager Parameter Store.
Defaults to false.
Note:
gpu
andamiId
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
- https://docs.aws.amazon.com/eks/latest/userguide/retrieve-ami-id.html
- Instance
Profile Pulumi.Aws. Iam. Instance Profile The ingress rule that gives node group access.
- Instance
Type string The instance type to use for the cluster's nodes. Defaults to "t2.medium".
- Key
Name string Name of the key pair to use for SSH access to worker nodes.
- Kubelet
Extra stringArgs Extra args to pass to the Kubelet. Corresponds to the options passed in the
--kubeletExtraArgs
flag to/etc/eks/bootstrap.sh
. For example, '--port=10251 --address=0.0.0.0'. Note that thelabels
andtaints
properties will be applied to this list (using--node-labels
and--register-with-taints
respectively) after to the explicitkubeletExtraArgs
.- Labels Dictionary<string, string>
Custom k8s node labels to be attached to each worker node. Adds the given key/value pairs to the
--node-labels
kubelet argument.- Max
Size int The maximum number of worker nodes running in the cluster. Defaults to 2.
- Min
Size int The minimum number of worker nodes running in the cluster. Defaults to 1.
- Node
Associate boolPublic Ip Address Whether or not to auto-assign public IP addresses on the EKS worker nodes. If this toggle is set to true, the EKS workers will be auto-assigned public IPs. If false, they will not be auto-assigned public IPs.
- Node
Public stringKey Public key material for SSH access to worker nodes. See allowed formats at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html If not provided, no SSH access is enabled on VMs.
- Node
Root intVolume Size The size in GiB of a cluster node's root volume. Defaults to 20.
- Node
Security Pulumi.Group Aws. Ec2. Security Group The security group for the worker node group to communicate with the cluster.
This security group requires specific inbound and outbound rules.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
Note: The
nodeSecurityGroup
option and the cluster optionnodeSecurityGroupTags
are mutually exclusive.- Node
Subnet List<string>Ids The set of subnets to override and use for the worker node group.
Setting this option overrides which subnets to use for the worker node group, regardless if the cluster's
subnetIds
is set, or ifpublicSubnetIds
and/orprivateSubnetIds
were set.- Node
User stringData Extra code to run on node startup. This code will run after the AWS EKS bootstrapping code and before the node signals its readiness to the managing CloudFormation stack. This code must be a typical user data script: critically it must begin with an interpreter directive (i.e. a
#!
).- Node
User stringData Override User specified code to run on node startup. This code is expected to handle the full AWS EKS bootstrapping code and signal node readiness to the managing CloudFormation stack. This code must be a complete and executable user data script in bash (Linux) or powershell (Windows).
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/worker.html
- Spot
Price string Bidding price for spot instance. If set, only spot instances will be added as worker node.
- Taints Dictionary<string, Taint>
Custom k8s node taints to be attached to each worker node. Adds the given taints to the
--register-with-taints
kubelet argument- Version string
Desired Kubernetes master / control plane version. If you do not specify a value, the latest available version is used.
- Ami
Id string The AMI ID to use for the worker nodes.
Defaults to the latest recommended EKS Optimized Linux AMI from the AWS Systems Manager Parameter Store.
Note:
amiId
andgpu
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html.
- Ami
Type string The AMI Type to use for the worker nodes.
Only applicable when setting an AMI ID that is of type
arm64
.Note:
amiType
andgpu
are mutually exclusive.- map[string]string
The tags to apply to the NodeGroup's AutoScalingGroup in the CloudFormation Stack.
Per AWS, all stack-level tags, including automatically created tags, and the
cloudFormationTags
option are propagated to resources that AWS CloudFormation supports, including the AutoScalingGroup. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.htmlNote: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- Bootstrap
Extra stringArgs Additional args to pass directly to
/etc/eks/bootstrap.sh
. For details on available options, see: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh. Note that the--apiserver-endpoint
,--b64-cluster-ca
and--kubelet-extra-args
flags are included automatically based on other configuration parameters.- map[string]string
The tags to apply to the CloudFormation Stack of the Worker NodeGroup.
Note: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- Cluster
Ingress SecurityRule Group Rule The ingress rule that gives node group access.
- Desired
Capacity int The number of worker nodes that should be running in the cluster. Defaults to 2.
- Encrypt
Root boolBlock Device Encrypt the root block device of the nodes in the node group.
- Extra
Node SecuritySecurity Groups Group Extra security groups to attach on all nodes in this worker node group.
This additional set of security groups captures any user application rules that will be needed for the nodes.
- Gpu bool
Use the latest recommended EKS Optimized Linux AMI with GPU support for the worker nodes from the AWS Systems Manager Parameter Store.
Defaults to false.
Note:
gpu
andamiId
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
- https://docs.aws.amazon.com/eks/latest/userguide/retrieve-ami-id.html
- Instance
Profile InstanceProfile The ingress rule that gives node group access.
- Instance
Type string The instance type to use for the cluster's nodes. Defaults to "t2.medium".
- Key
Name string Name of the key pair to use for SSH access to worker nodes.
- Kubelet
Extra stringArgs Extra args to pass to the Kubelet. Corresponds to the options passed in the
--kubeletExtraArgs
flag to/etc/eks/bootstrap.sh
. For example, '--port=10251 --address=0.0.0.0'. Note that thelabels
andtaints
properties will be applied to this list (using--node-labels
and--register-with-taints
respectively) after to the explicitkubeletExtraArgs
.- Labels map[string]string
Custom k8s node labels to be attached to each worker node. Adds the given key/value pairs to the
--node-labels
kubelet argument.- Max
Size int The maximum number of worker nodes running in the cluster. Defaults to 2.
- Min
Size int The minimum number of worker nodes running in the cluster. Defaults to 1.
- Node
Associate boolPublic Ip Address Whether or not to auto-assign public IP addresses on the EKS worker nodes. If this toggle is set to true, the EKS workers will be auto-assigned public IPs. If false, they will not be auto-assigned public IPs.
- Node
Public stringKey Public key material for SSH access to worker nodes. See allowed formats at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html If not provided, no SSH access is enabled on VMs.
- Node
Root intVolume Size The size in GiB of a cluster node's root volume. Defaults to 20.
- Node
Security SecurityGroup Group The security group for the worker node group to communicate with the cluster.
This security group requires specific inbound and outbound rules.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
Note: The
nodeSecurityGroup
option and the cluster optionnodeSecurityGroupTags
are mutually exclusive.- Node
Subnet []stringIds The set of subnets to override and use for the worker node group.
Setting this option overrides which subnets to use for the worker node group, regardless if the cluster's
subnetIds
is set, or ifpublicSubnetIds
and/orprivateSubnetIds
were set.- Node
User stringData Extra code to run on node startup. This code will run after the AWS EKS bootstrapping code and before the node signals its readiness to the managing CloudFormation stack. This code must be a typical user data script: critically it must begin with an interpreter directive (i.e. a
#!
).- Node
User stringData Override User specified code to run on node startup. This code is expected to handle the full AWS EKS bootstrapping code and signal node readiness to the managing CloudFormation stack. This code must be a complete and executable user data script in bash (Linux) or powershell (Windows).
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/worker.html
- Spot
Price string Bidding price for spot instance. If set, only spot instances will be added as worker node.
- Taints map[string]Taint
Custom k8s node taints to be attached to each worker node. Adds the given taints to the
--register-with-taints
kubelet argument- Version string
Desired Kubernetes master / control plane version. If you do not specify a value, the latest available version is used.
- ami
Id String The AMI ID to use for the worker nodes.
Defaults to the latest recommended EKS Optimized Linux AMI from the AWS Systems Manager Parameter Store.
Note:
amiId
andgpu
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html.
- ami
Type String The AMI Type to use for the worker nodes.
Only applicable when setting an AMI ID that is of type
arm64
.Note:
amiType
andgpu
are mutually exclusive.- Map<String,String>
The tags to apply to the NodeGroup's AutoScalingGroup in the CloudFormation Stack.
Per AWS, all stack-level tags, including automatically created tags, and the
cloudFormationTags
option are propagated to resources that AWS CloudFormation supports, including the AutoScalingGroup. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.htmlNote: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- bootstrap
Extra StringArgs Additional args to pass directly to
/etc/eks/bootstrap.sh
. For details on available options, see: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh. Note that the--apiserver-endpoint
,--b64-cluster-ca
and--kubelet-extra-args
flags are included automatically based on other configuration parameters.- Map<String,String>
The tags to apply to the CloudFormation Stack of the Worker NodeGroup.
Note: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- cluster
Ingress SecurityRule Group Rule The ingress rule that gives node group access.
- desired
Capacity Integer The number of worker nodes that should be running in the cluster. Defaults to 2.
- encrypt
Root BooleanBlock Device Encrypt the root block device of the nodes in the node group.
- extra
Node List<SecuritySecurity Groups Group> Extra security groups to attach on all nodes in this worker node group.
This additional set of security groups captures any user application rules that will be needed for the nodes.
- gpu Boolean
Use the latest recommended EKS Optimized Linux AMI with GPU support for the worker nodes from the AWS Systems Manager Parameter Store.
Defaults to false.
Note:
gpu
andamiId
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
- https://docs.aws.amazon.com/eks/latest/userguide/retrieve-ami-id.html
- instance
Profile InstanceProfile The ingress rule that gives node group access.
- instance
Type String The instance type to use for the cluster's nodes. Defaults to "t2.medium".
- key
Name String Name of the key pair to use for SSH access to worker nodes.
- kubelet
Extra StringArgs Extra args to pass to the Kubelet. Corresponds to the options passed in the
--kubeletExtraArgs
flag to/etc/eks/bootstrap.sh
. For example, '--port=10251 --address=0.0.0.0'. Note that thelabels
andtaints
properties will be applied to this list (using--node-labels
and--register-with-taints
respectively) after to the explicitkubeletExtraArgs
.- labels Map<String,String>
Custom k8s node labels to be attached to each worker node. Adds the given key/value pairs to the
--node-labels
kubelet argument.- max
Size Integer The maximum number of worker nodes running in the cluster. Defaults to 2.
- min
Size Integer The minimum number of worker nodes running in the cluster. Defaults to 1.
- node
Associate BooleanPublic Ip Address Whether or not to auto-assign public IP addresses on the EKS worker nodes. If this toggle is set to true, the EKS workers will be auto-assigned public IPs. If false, they will not be auto-assigned public IPs.
- node
Public StringKey Public key material for SSH access to worker nodes. See allowed formats at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html If not provided, no SSH access is enabled on VMs.
- node
Root IntegerVolume Size The size in GiB of a cluster node's root volume. Defaults to 20.
- node
Security SecurityGroup Group The security group for the worker node group to communicate with the cluster.
This security group requires specific inbound and outbound rules.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
Note: The
nodeSecurityGroup
option and the cluster optionnodeSecurityGroupTags
are mutually exclusive.- node
Subnet List<String>Ids The set of subnets to override and use for the worker node group.
Setting this option overrides which subnets to use for the worker node group, regardless if the cluster's
subnetIds
is set, or ifpublicSubnetIds
and/orprivateSubnetIds
were set.- node
User StringData Extra code to run on node startup. This code will run after the AWS EKS bootstrapping code and before the node signals its readiness to the managing CloudFormation stack. This code must be a typical user data script: critically it must begin with an interpreter directive (i.e. a
#!
).- node
User StringData Override User specified code to run on node startup. This code is expected to handle the full AWS EKS bootstrapping code and signal node readiness to the managing CloudFormation stack. This code must be a complete and executable user data script in bash (Linux) or powershell (Windows).
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/worker.html
- spot
Price String Bidding price for spot instance. If set, only spot instances will be added as worker node.
- taints Map<String,Taint>
Custom k8s node taints to be attached to each worker node. Adds the given taints to the
--register-with-taints
kubelet argument- version String
Desired Kubernetes master / control plane version. If you do not specify a value, the latest available version is used.
- ami
Id string The AMI ID to use for the worker nodes.
Defaults to the latest recommended EKS Optimized Linux AMI from the AWS Systems Manager Parameter Store.
Note:
amiId
andgpu
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html.
- ami
Type string The AMI Type to use for the worker nodes.
Only applicable when setting an AMI ID that is of type
arm64
.Note:
amiType
andgpu
are mutually exclusive.- {[key: string]: string}
The tags to apply to the NodeGroup's AutoScalingGroup in the CloudFormation Stack.
Per AWS, all stack-level tags, including automatically created tags, and the
cloudFormationTags
option are propagated to resources that AWS CloudFormation supports, including the AutoScalingGroup. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.htmlNote: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- bootstrap
Extra stringArgs Additional args to pass directly to
/etc/eks/bootstrap.sh
. For details on available options, see: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh. Note that the--apiserver-endpoint
,--b64-cluster-ca
and--kubelet-extra-args
flags are included automatically based on other configuration parameters.- {[key: string]: string}
The tags to apply to the CloudFormation Stack of the Worker NodeGroup.
Note: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- cluster
Ingress pulumiRule Awsec2Security Group Rule The ingress rule that gives node group access.
- desired
Capacity number The number of worker nodes that should be running in the cluster. Defaults to 2.
- encrypt
Root booleanBlock Device Encrypt the root block device of the nodes in the node group.
- extra
Node pulumiSecurity Groups Awsec2Security Group[] Extra security groups to attach on all nodes in this worker node group.
This additional set of security groups captures any user application rules that will be needed for the nodes.
- gpu boolean
Use the latest recommended EKS Optimized Linux AMI with GPU support for the worker nodes from the AWS Systems Manager Parameter Store.
Defaults to false.
Note:
gpu
andamiId
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
- https://docs.aws.amazon.com/eks/latest/userguide/retrieve-ami-id.html
- instance
Profile pulumiAwsiam Instance Profile The ingress rule that gives node group access.
- instance
Type string The instance type to use for the cluster's nodes. Defaults to "t2.medium".
- key
Name string Name of the key pair to use for SSH access to worker nodes.
- kubelet
Extra stringArgs Extra args to pass to the Kubelet. Corresponds to the options passed in the
--kubeletExtraArgs
flag to/etc/eks/bootstrap.sh
. For example, '--port=10251 --address=0.0.0.0'. Note that thelabels
andtaints
properties will be applied to this list (using--node-labels
and--register-with-taints
respectively) after to the explicitkubeletExtraArgs
.- labels {[key: string]: string}
Custom k8s node labels to be attached to each worker node. Adds the given key/value pairs to the
--node-labels
kubelet argument.- max
Size number The maximum number of worker nodes running in the cluster. Defaults to 2.
- min
Size number The minimum number of worker nodes running in the cluster. Defaults to 1.
- node
Associate booleanPublic Ip Address Whether or not to auto-assign public IP addresses on the EKS worker nodes. If this toggle is set to true, the EKS workers will be auto-assigned public IPs. If false, they will not be auto-assigned public IPs.
- node
Public stringKey Public key material for SSH access to worker nodes. See allowed formats at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html If not provided, no SSH access is enabled on VMs.
- node
Root numberVolume Size The size in GiB of a cluster node's root volume. Defaults to 20.
- node
Security pulumiGroup Awsec2Security Group The security group for the worker node group to communicate with the cluster.
This security group requires specific inbound and outbound rules.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
Note: The
nodeSecurityGroup
option and the cluster optionnodeSecurityGroupTags
are mutually exclusive.- node
Subnet string[]Ids The set of subnets to override and use for the worker node group.
Setting this option overrides which subnets to use for the worker node group, regardless if the cluster's
subnetIds
is set, or ifpublicSubnetIds
and/orprivateSubnetIds
were set.- node
User stringData Extra code to run on node startup. This code will run after the AWS EKS bootstrapping code and before the node signals its readiness to the managing CloudFormation stack. This code must be a typical user data script: critically it must begin with an interpreter directive (i.e. a
#!
).- node
User stringData Override User specified code to run on node startup. This code is expected to handle the full AWS EKS bootstrapping code and signal node readiness to the managing CloudFormation stack. This code must be a complete and executable user data script in bash (Linux) or powershell (Windows).
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/worker.html
- spot
Price string Bidding price for spot instance. If set, only spot instances will be added as worker node.
- taints {[key: string]: Taint}
Custom k8s node taints to be attached to each worker node. Adds the given taints to the
--register-with-taints
kubelet argument- version string
Desired Kubernetes master / control plane version. If you do not specify a value, the latest available version is used.
- ami_
id str The AMI ID to use for the worker nodes.
Defaults to the latest recommended EKS Optimized Linux AMI from the AWS Systems Manager Parameter Store.
Note:
amiId
andgpu
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html.
- ami_
type str The AMI Type to use for the worker nodes.
Only applicable when setting an AMI ID that is of type
arm64
.Note:
amiType
andgpu
are mutually exclusive.- Mapping[str, str]
The tags to apply to the NodeGroup's AutoScalingGroup in the CloudFormation Stack.
Per AWS, all stack-level tags, including automatically created tags, and the
cloudFormationTags
option are propagated to resources that AWS CloudFormation supports, including the AutoScalingGroup. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.htmlNote: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- bootstrap_
extra_ strargs Additional args to pass directly to
/etc/eks/bootstrap.sh
. For details on available options, see: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh. Note that the--apiserver-endpoint
,--b64-cluster-ca
and--kubelet-extra-args
flags are included automatically based on other configuration parameters.- Mapping[str, str]
The tags to apply to the CloudFormation Stack of the Worker NodeGroup.
Note: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- cluster_
ingress_ Securityrule Group Rule The ingress rule that gives node group access.
- desired_
capacity int The number of worker nodes that should be running in the cluster. Defaults to 2.
- encrypt_
root_ boolblock_ device Encrypt the root block device of the nodes in the node group.
- extra_
node_ Securitysecurity_ groups Group] Extra security groups to attach on all nodes in this worker node group.
This additional set of security groups captures any user application rules that will be needed for the nodes.
- gpu bool
Use the latest recommended EKS Optimized Linux AMI with GPU support for the worker nodes from the AWS Systems Manager Parameter Store.
Defaults to false.
Note:
gpu
andamiId
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
- https://docs.aws.amazon.com/eks/latest/userguide/retrieve-ami-id.html
- instance_
profile InstanceProfile The ingress rule that gives node group access.
- instance_
type str The instance type to use for the cluster's nodes. Defaults to "t2.medium".
- key_
name str Name of the key pair to use for SSH access to worker nodes.
- kubelet_
extra_ strargs Extra args to pass to the Kubelet. Corresponds to the options passed in the
--kubeletExtraArgs
flag to/etc/eks/bootstrap.sh
. For example, '--port=10251 --address=0.0.0.0'. Note that thelabels
andtaints
properties will be applied to this list (using--node-labels
and--register-with-taints
respectively) after to the explicitkubeletExtraArgs
.- labels Mapping[str, str]
Custom k8s node labels to be attached to each worker node. Adds the given key/value pairs to the
--node-labels
kubelet argument.- max_
size int The maximum number of worker nodes running in the cluster. Defaults to 2.
- min_
size int The minimum number of worker nodes running in the cluster. Defaults to 1.
- node_
associate_ boolpublic_ ip_ address Whether or not to auto-assign public IP addresses on the EKS worker nodes. If this toggle is set to true, the EKS workers will be auto-assigned public IPs. If false, they will not be auto-assigned public IPs.
- node_
public_ strkey Public key material for SSH access to worker nodes. See allowed formats at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html If not provided, no SSH access is enabled on VMs.
- node_
root_ intvolume_ size The size in GiB of a cluster node's root volume. Defaults to 20.
- node_
security_ Securitygroup Group The security group for the worker node group to communicate with the cluster.
This security group requires specific inbound and outbound rules.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
Note: The
nodeSecurityGroup
option and the cluster optionnodeSecurityGroupTags
are mutually exclusive.- node_
subnet_ Sequence[str]ids The set of subnets to override and use for the worker node group.
Setting this option overrides which subnets to use for the worker node group, regardless if the cluster's
subnetIds
is set, or ifpublicSubnetIds
and/orprivateSubnetIds
were set.- node_
user_ strdata Extra code to run on node startup. This code will run after the AWS EKS bootstrapping code and before the node signals its readiness to the managing CloudFormation stack. This code must be a typical user data script: critically it must begin with an interpreter directive (i.e. a
#!
).- node_
user_ strdata_ override User specified code to run on node startup. This code is expected to handle the full AWS EKS bootstrapping code and signal node readiness to the managing CloudFormation stack. This code must be a complete and executable user data script in bash (Linux) or powershell (Windows).
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/worker.html
- spot_
price str Bidding price for spot instance. If set, only spot instances will be added as worker node.
- taints Mapping[str, Taint]
Custom k8s node taints to be attached to each worker node. Adds the given taints to the
--register-with-taints
kubelet argument- version str
Desired Kubernetes master / control plane version. If you do not specify a value, the latest available version is used.
- ami
Id String The AMI ID to use for the worker nodes.
Defaults to the latest recommended EKS Optimized Linux AMI from the AWS Systems Manager Parameter Store.
Note:
amiId
andgpu
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html.
- ami
Type String The AMI Type to use for the worker nodes.
Only applicable when setting an AMI ID that is of type
arm64
.Note:
amiType
andgpu
are mutually exclusive.- Map<String>
The tags to apply to the NodeGroup's AutoScalingGroup in the CloudFormation Stack.
Per AWS, all stack-level tags, including automatically created tags, and the
cloudFormationTags
option are propagated to resources that AWS CloudFormation supports, including the AutoScalingGroup. See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.htmlNote: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- bootstrap
Extra StringArgs Additional args to pass directly to
/etc/eks/bootstrap.sh
. For details on available options, see: https://github.com/awslabs/amazon-eks-ami/blob/master/files/bootstrap.sh. Note that the--apiserver-endpoint
,--b64-cluster-ca
and--kubelet-extra-args
flags are included automatically based on other configuration parameters.- Map<String>
The tags to apply to the CloudFormation Stack of the Worker NodeGroup.
Note: Given the inheritance of auto-generated CF tags and
cloudFormationTags
, you should either supply the tag inautoScalingGroupTags
orcloudFormationTags
, but not both.- cluster
Ingress aws:ec2:SecurityRule Group Rule The ingress rule that gives node group access.
- desired
Capacity Number The number of worker nodes that should be running in the cluster. Defaults to 2.
- encrypt
Root BooleanBlock Device Encrypt the root block device of the nodes in the node group.
- extra
Node List<aws:ec2:SecuritySecurity Groups Group> Extra security groups to attach on all nodes in this worker node group.
This additional set of security groups captures any user application rules that will be needed for the nodes.
- gpu Boolean
Use the latest recommended EKS Optimized Linux AMI with GPU support for the worker nodes from the AWS Systems Manager Parameter Store.
Defaults to false.
Note:
gpu
andamiId
are mutually exclusive.See for more details:
- https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html
- https://docs.aws.amazon.com/eks/latest/userguide/retrieve-ami-id.html
- instance
Profile aws:iam:InstanceProfile The ingress rule that gives node group access.
- instance
Type String The instance type to use for the cluster's nodes. Defaults to "t2.medium".
- key
Name String Name of the key pair to use for SSH access to worker nodes.
- kubelet
Extra StringArgs Extra args to pass to the Kubelet. Corresponds to the options passed in the
--kubeletExtraArgs
flag to/etc/eks/bootstrap.sh
. For example, '--port=10251 --address=0.0.0.0'. Note that thelabels
andtaints
properties will be applied to this list (using--node-labels
and--register-with-taints
respectively) after to the explicitkubeletExtraArgs
.- labels Map<String>
Custom k8s node labels to be attached to each worker node. Adds the given key/value pairs to the
--node-labels
kubelet argument.- max
Size Number The maximum number of worker nodes running in the cluster. Defaults to 2.
- min
Size Number The minimum number of worker nodes running in the cluster. Defaults to 1.
- node
Associate BooleanPublic Ip Address Whether or not to auto-assign public IP addresses on the EKS worker nodes. If this toggle is set to true, the EKS workers will be auto-assigned public IPs. If false, they will not be auto-assigned public IPs.
- node
Public StringKey Public key material for SSH access to worker nodes. See allowed formats at: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html If not provided, no SSH access is enabled on VMs.
- node
Root NumberVolume Size The size in GiB of a cluster node's root volume. Defaults to 20.
- node
Security aws:ec2:SecurityGroup Group The security group for the worker node group to communicate with the cluster.
This security group requires specific inbound and outbound rules.
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html
Note: The
nodeSecurityGroup
option and the cluster optionnodeSecurityGroupTags
are mutually exclusive.- node
Subnet List<String>Ids The set of subnets to override and use for the worker node group.
Setting this option overrides which subnets to use for the worker node group, regardless if the cluster's
subnetIds
is set, or ifpublicSubnetIds
and/orprivateSubnetIds
were set.- node
User StringData Extra code to run on node startup. This code will run after the AWS EKS bootstrapping code and before the node signals its readiness to the managing CloudFormation stack. This code must be a typical user data script: critically it must begin with an interpreter directive (i.e. a
#!
).- node
User StringData Override User specified code to run on node startup. This code is expected to handle the full AWS EKS bootstrapping code and signal node readiness to the managing CloudFormation stack. This code must be a complete and executable user data script in bash (Linux) or powershell (Windows).
See for more details: https://docs.aws.amazon.com/eks/latest/userguide/worker.html
- spot
Price String Bidding price for spot instance. If set, only spot instances will be added as worker node.
- taints Map<Property Map>
Custom k8s node taints to be attached to each worker node. Adds the given taints to the
--register-with-taints
kubelet argument- version String
Desired Kubernetes master / control plane version. If you do not specify a value, the latest available version is used.
CoreData
- Cluster
Pulumi.
Aws. Eks. Cluster - Cluster
Iam Pulumi.Role Aws. Iam. Role The IAM Role attached to the EKS Cluster
- Cluster
Security Pulumi.Group Aws. Ec2. Security Group - Endpoint string
- Instance
Roles List<Pulumi.Aws. Iam. Role> - Node
Group ClusterOptions Node Group Options - Provider
Pulumi.
Kubernetes. Provider - Subnet
Ids List<string> - Vpc
Id string - Aws
Provider Pulumi.Aws. Provider - Eks
Node Pulumi.Access Kubernetes. Core. V1. Config Map - Encryption
Config Pulumi.Aws. Eks. Inputs. Cluster Encryption Config - Fargate
Profile Pulumi.Aws. Eks. Fargate Profile - Kubeconfig object
- Dictionary<string, string>
- Oidc
Provider Pulumi.Aws. Iam. Open Id Connect Provider - Private
Subnet List<string>Ids - Public
Subnet List<string>Ids - Storage
Classes Dictionary<string, Pulumi.Kubernetes. Storage. V1. Storage Class> - Dictionary<string, string>
- Vpc
Cni Pulumi.Eks. Vpc Cni
- Cluster Cluster
- Cluster
Iam RoleRole The IAM Role attached to the EKS Cluster
- Cluster
Security SecurityGroup Group - Endpoint string
- Instance
Roles Role - Node
Group ClusterOptions Node Group Options - Provider Provider
- Subnet
Ids []string - Vpc
Id string - Aws
Provider Provider - Eks
Node ConfigAccess Map - Encryption
Config ClusterEncryption Config - Fargate
Profile FargateProfile - Kubeconfig interface{}
- map[string]string
- Oidc
Provider OpenId Connect Provider - Private
Subnet []stringIds - Public
Subnet []stringIds - Storage
Classes StorageClass - map[string]string
- Vpc
Cni VpcCni
- cluster Cluster
- cluster
Iam RoleRole The IAM Role attached to the EKS Cluster
- cluster
Security SecurityGroup Group - endpoint String
- instance
Roles List<Role> - node
Group ClusterOptions Node Group Options - provider Provider
- subnet
Ids List<String> - vpc
Id String - aws
Provider Provider - eks
Node ConfigAccess Map - encryption
Config ClusterEncryption Config - fargate
Profile FargateProfile - kubeconfig Object
- Map<String,String>
- oidc
Provider OpenId Connect Provider - private
Subnet List<String>Ids - public
Subnet List<String>Ids - storage
Classes Map<String,StorageClass> - Map<String,String>
- vpc
Cni VpcCni
- cluster
pulumi
Awseks Cluster - cluster
Iam pulumiRole Awsiam Role The IAM Role attached to the EKS Cluster
- cluster
Security pulumiGroup Awsec2Security Group - endpoint string
- instance
Roles pulumiAwsiam Role[] - node
Group ClusterOptions Node Group Options - provider
pulumi
Kubernetes Provider - subnet
Ids string[] - vpc
Id string - aws
Provider pulumiAws Provider - eks
Node pulumiAccess Kubernetescorev1Config Map - encryption
Config pulumiAwstypesinputeks Cluster Encryption Config - fargate
Profile pulumiAwseks Fargate Profile - kubeconfig any
- {[key: string]: string}
- oidc
Provider pulumiAwsiam Open Id Connect Provider - private
Subnet string[]Ids - public
Subnet string[]Ids - storage
Classes {[key: string]: pulumiKubernetesstoragev1Storage Class} - {[key: string]: string}
- vpc
Cni VpcCni
- cluster Cluster
- cluster_
iam_ Rolerole The IAM Role attached to the EKS Cluster
- cluster_
security_ Securitygroup Group - endpoint str
- instance_
roles Role] - node_
group_ Clusteroptions Node Group Options - provider Provider
- subnet_
ids Sequence[str] - vpc_
id str - aws_
provider Provider - eks_
node_ Configaccess Map - encryption_
config ClusterEncryption Config Args - fargate_
profile FargateProfile - kubeconfig Any
- Mapping[str, str]
- oidc_
provider OpenId Connect Provider - private_
subnet_ Sequence[str]ids - public_
subnet_ Sequence[str]ids - storage_
classes StorageClass] - Mapping[str, str]
- vpc_
cni VpcCni
- cluster aws:eks:Cluster
- cluster
Iam aws:iam:RoleRole The IAM Role attached to the EKS Cluster
- cluster
Security aws:ec2:SecurityGroup Group - endpoint String
- instance
Roles List<aws:iam:Role> - node
Group Property MapOptions - provider pulumi:providers:kubernetes
- subnet
Ids List<String> - vpc
Id String - aws
Provider pulumi:providers:aws - eks
Node kubernetes:core/v1:ConfigAccess Map - encryption
Config Property Map - fargate
Profile aws:eks:FargateProfile - kubeconfig Any
- Map<String>
- oidc
Provider aws:iam:OpenId Connect Provider - private
Subnet List<String>Ids - public
Subnet List<String>Ids - storage
Classes Map<kubernetes:storage.k8s.io/v1:StorageClass> - Map<String>
- vpc
Cni eks:VpcCni
Taint
Package Details
- Repository
- Amazon EKS pulumi/pulumi-eks
- License
- Apache-2.0