Try AWS Native preview for resources not in the classic version.
aws.eks.NodeGroup
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Manages an EKS Node Group, which can provision and optionally update an Auto Scaling Group of Kubernetes worker nodes compatible with EKS. Additional documentation about this functionality can be found in the EKS User Guide.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.eks.NodeGroup("example", {
clusterName: exampleAwsEksCluster.name,
nodeGroupName: "example",
nodeRoleArn: exampleAwsIamRole.arn,
subnetIds: exampleAwsSubnet.map(__item => __item.id),
scalingConfig: {
desiredSize: 1,
maxSize: 2,
minSize: 1,
},
updateConfig: {
maxUnavailable: 1,
},
}, {
dependsOn: [
example_AmazonEKSWorkerNodePolicy,
example_AmazonEKSCNIPolicy,
example_AmazonEC2ContainerRegistryReadOnly,
],
});
import pulumi
import pulumi_aws as aws
example = aws.eks.NodeGroup("example",
cluster_name=example_aws_eks_cluster["name"],
node_group_name="example",
node_role_arn=example_aws_iam_role["arn"],
subnet_ids=[__item["id"] for __item in example_aws_subnet],
scaling_config={
"desiredSize": 1,
"maxSize": 2,
"minSize": 1,
},
update_config={
"maxUnavailable": 1,
},
opts = pulumi.ResourceOptions(depends_on=[
example__amazon_eks_worker_node_policy,
example__amazon_ekscni_policy,
example__amazon_ec2_container_registry_read_only,
]))
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/eks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
var splat0 []interface{}
for _, val0 := range exampleAwsSubnet {
splat0 = append(splat0, val0.Id)
}
_, err := eks.NewNodeGroup(ctx, "example", &eks.NodeGroupArgs{
ClusterName: pulumi.Any(exampleAwsEksCluster.Name),
NodeGroupName: pulumi.String("example"),
NodeRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
SubnetIds: toPulumiArray(splat0),
ScalingConfig: &eks.NodeGroupScalingConfigArgs{
DesiredSize: pulumi.Int(1),
MaxSize: pulumi.Int(2),
MinSize: pulumi.Int(1),
},
UpdateConfig: &eks.NodeGroupUpdateConfigArgs{
MaxUnavailable: pulumi.Int(1),
},
}, pulumi.DependsOn([]pulumi.Resource{
example_AmazonEKSWorkerNodePolicy,
example_AmazonEKSCNIPolicy,
example_AmazonEC2ContainerRegistryReadOnly,
}))
if err != nil {
return err
}
return nil
})
}
func toPulumiArray(arr []) pulumi.Array {
var pulumiArr pulumi.Array
for _, v := range arr {
pulumiArr = append(pulumiArr, pulumi.(v))
}
return pulumiArr
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Eks.NodeGroup("example", new()
{
ClusterName = exampleAwsEksCluster.Name,
NodeGroupName = "example",
NodeRoleArn = exampleAwsIamRole.Arn,
SubnetIds = exampleAwsSubnet.Select(__item => __item.Id).ToList(),
ScalingConfig = new Aws.Eks.Inputs.NodeGroupScalingConfigArgs
{
DesiredSize = 1,
MaxSize = 2,
MinSize = 1,
},
UpdateConfig = new Aws.Eks.Inputs.NodeGroupUpdateConfigArgs
{
MaxUnavailable = 1,
},
}, new CustomResourceOptions
{
DependsOn =
{
example_AmazonEKSWorkerNodePolicy,
example_AmazonEKSCNIPolicy,
example_AmazonEC2ContainerRegistryReadOnly,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.NodeGroup;
import com.pulumi.aws.eks.NodeGroupArgs;
import com.pulumi.aws.eks.inputs.NodeGroupScalingConfigArgs;
import com.pulumi.aws.eks.inputs.NodeGroupUpdateConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new NodeGroup("example", NodeGroupArgs.builder()
.clusterName(exampleAwsEksCluster.name())
.nodeGroupName("example")
.nodeRoleArn(exampleAwsIamRole.arn())
.subnetIds(exampleAwsSubnet.stream().map(element -> element.id()).collect(toList()))
.scalingConfig(NodeGroupScalingConfigArgs.builder()
.desiredSize(1)
.maxSize(2)
.minSize(1)
.build())
.updateConfig(NodeGroupUpdateConfigArgs.builder()
.maxUnavailable(1)
.build())
.build(), CustomResourceOptions.builder()
.dependsOn(
example_AmazonEKSWorkerNodePolicy,
example_AmazonEKSCNIPolicy,
example_AmazonEC2ContainerRegistryReadOnly)
.build());
}
}
Coming soon!
Ignoring Changes to Desired Size
You can utilize ignoreChanges create an EKS Node Group with an initial size of running instances, then ignore any changes to that count caused externally (e.g. Application Autoscaling).
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.eks.NodeGroup("example", {scalingConfig: {
desiredSize: 2,
}});
import pulumi
import pulumi_aws as aws
example = aws.eks.NodeGroup("example", scaling_config={
"desiredSize": 2,
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/eks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := eks.NewNodeGroup(ctx, "example", &eks.NodeGroupArgs{
ScalingConfig: &eks.NodeGroupScalingConfigArgs{
DesiredSize: pulumi.Int(2),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Eks.NodeGroup("example", new()
{
ScalingConfig = new Aws.Eks.Inputs.NodeGroupScalingConfigArgs
{
DesiredSize = 2,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.NodeGroup;
import com.pulumi.aws.eks.NodeGroupArgs;
import com.pulumi.aws.eks.inputs.NodeGroupScalingConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new NodeGroup("example", NodeGroupArgs.builder()
.scalingConfig(NodeGroupScalingConfigArgs.builder()
.desiredSize(2)
.build())
.build());
}
}
resources:
example:
type: aws:eks:NodeGroup
properties:
scalingConfig:
desiredSize: 2
Example IAM Role for EKS Node Group
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.iam.Role("example", {
name: "eks-node-group-example",
assumeRolePolicy: JSON.stringify({
Statement: [{
Action: "sts:AssumeRole",
Effect: "Allow",
Principal: {
Service: "ec2.amazonaws.com",
},
}],
Version: "2012-10-17",
}),
});
const example_AmazonEKSWorkerNodePolicy = new aws.iam.RolePolicyAttachment("example-AmazonEKSWorkerNodePolicy", {
policyArn: "arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy",
role: example.name,
});
const example_AmazonEKSCNIPolicy = new aws.iam.RolePolicyAttachment("example-AmazonEKS_CNI_Policy", {
policyArn: "arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy",
role: example.name,
});
const example_AmazonEC2ContainerRegistryReadOnly = new aws.iam.RolePolicyAttachment("example-AmazonEC2ContainerRegistryReadOnly", {
policyArn: "arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly",
role: example.name,
});
import pulumi
import json
import pulumi_aws as aws
example = aws.iam.Role("example",
name="eks-node-group-example",
assume_role_policy=json.dumps({
"Statement": [{
"Action": "sts:AssumeRole",
"Effect": "Allow",
"Principal": {
"Service": "ec2.amazonaws.com",
},
}],
"Version": "2012-10-17",
}))
example__amazon_eks_worker_node_policy = aws.iam.RolePolicyAttachment("example-AmazonEKSWorkerNodePolicy",
policy_arn="arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy",
role=example.name)
example__amazon_ekscni_policy = aws.iam.RolePolicyAttachment("example-AmazonEKS_CNI_Policy",
policy_arn="arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy",
role=example.name)
example__amazon_ec2_container_registry_read_only = aws.iam.RolePolicyAttachment("example-AmazonEC2ContainerRegistryReadOnly",
policy_arn="arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly",
role=example.name)
package main
import (
"encoding/json"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"Statement": []map[string]interface{}{
map[string]interface{}{
"Action": "sts:AssumeRole",
"Effect": "Allow",
"Principal": map[string]interface{}{
"Service": "ec2.amazonaws.com",
},
},
},
"Version": "2012-10-17",
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
example, err := iam.NewRole(ctx, "example", &iam.RoleArgs{
Name: pulumi.String("eks-node-group-example"),
AssumeRolePolicy: pulumi.String(json0),
})
if err != nil {
return err
}
_, err = iam.NewRolePolicyAttachment(ctx, "example-AmazonEKSWorkerNodePolicy", &iam.RolePolicyAttachmentArgs{
PolicyArn: pulumi.String("arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy"),
Role: example.Name,
})
if err != nil {
return err
}
_, err = iam.NewRolePolicyAttachment(ctx, "example-AmazonEKS_CNI_Policy", &iam.RolePolicyAttachmentArgs{
PolicyArn: pulumi.String("arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy"),
Role: example.Name,
})
if err != nil {
return err
}
_, err = iam.NewRolePolicyAttachment(ctx, "example-AmazonEC2ContainerRegistryReadOnly", &iam.RolePolicyAttachmentArgs{
PolicyArn: pulumi.String("arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly"),
Role: example.Name,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Iam.Role("example", new()
{
Name = "eks-node-group-example",
AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["Statement"] = new[]
{
new Dictionary<string, object?>
{
["Action"] = "sts:AssumeRole",
["Effect"] = "Allow",
["Principal"] = new Dictionary<string, object?>
{
["Service"] = "ec2.amazonaws.com",
},
},
},
["Version"] = "2012-10-17",
}),
});
var example_AmazonEKSWorkerNodePolicy = new Aws.Iam.RolePolicyAttachment("example-AmazonEKSWorkerNodePolicy", new()
{
PolicyArn = "arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy",
Role = example.Name,
});
var example_AmazonEKSCNIPolicy = new Aws.Iam.RolePolicyAttachment("example-AmazonEKS_CNI_Policy", new()
{
PolicyArn = "arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy",
Role = example.Name,
});
var example_AmazonEC2ContainerRegistryReadOnly = new Aws.Iam.RolePolicyAttachment("example-AmazonEC2ContainerRegistryReadOnly", new()
{
PolicyArn = "arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly",
Role = example.Name,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicyAttachment;
import com.pulumi.aws.iam.RolePolicyAttachmentArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Role("example", RoleArgs.builder()
.name("eks-node-group-example")
.assumeRolePolicy(serializeJson(
jsonObject(
jsonProperty("Statement", jsonArray(jsonObject(
jsonProperty("Action", "sts:AssumeRole"),
jsonProperty("Effect", "Allow"),
jsonProperty("Principal", jsonObject(
jsonProperty("Service", "ec2.amazonaws.com")
))
))),
jsonProperty("Version", "2012-10-17")
)))
.build());
var example_AmazonEKSWorkerNodePolicy = new RolePolicyAttachment("example-AmazonEKSWorkerNodePolicy", RolePolicyAttachmentArgs.builder()
.policyArn("arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy")
.role(example.name())
.build());
var example_AmazonEKSCNIPolicy = new RolePolicyAttachment("example-AmazonEKSCNIPolicy", RolePolicyAttachmentArgs.builder()
.policyArn("arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy")
.role(example.name())
.build());
var example_AmazonEC2ContainerRegistryReadOnly = new RolePolicyAttachment("example-AmazonEC2ContainerRegistryReadOnly", RolePolicyAttachmentArgs.builder()
.policyArn("arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly")
.role(example.name())
.build());
}
}
resources:
example:
type: aws:iam:Role
properties:
name: eks-node-group-example
assumeRolePolicy:
fn::toJSON:
Statement:
- Action: sts:AssumeRole
Effect: Allow
Principal:
Service: ec2.amazonaws.com
Version: 2012-10-17
example-AmazonEKSWorkerNodePolicy:
type: aws:iam:RolePolicyAttachment
properties:
policyArn: arn:aws:iam::aws:policy/AmazonEKSWorkerNodePolicy
role: ${example.name}
example-AmazonEKSCNIPolicy:
type: aws:iam:RolePolicyAttachment
name: example-AmazonEKS_CNI_Policy
properties:
policyArn: arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy
role: ${example.name}
example-AmazonEC2ContainerRegistryReadOnly:
type: aws:iam:RolePolicyAttachment
properties:
policyArn: arn:aws:iam::aws:policy/AmazonEC2ContainerRegistryReadOnly
role: ${example.name}
Example Subnets for EKS Node Group
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as std from "@pulumi/std";
const available = aws.getAvailabilityZones({
state: "available",
});
const example: aws.ec2.Subnet[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
example.push(new aws.ec2.Subnet(`example-${range.value}`, {
availabilityZone: available.then(available => available.names[range.value]),
cidrBlock: std.cidrsubnet({
input: exampleAwsVpc.cidrBlock,
newbits: 8,
netnum: range.value,
}).then(invoke => invoke.result),
vpcId: exampleAwsVpc.id,
}));
}
import pulumi
import pulumi_aws as aws
import pulumi_std as std
available = aws.get_availability_zones(state="available")
example = []
for range in [{"value": i} for i in range(0, 2)]:
example.append(aws.ec2.Subnet(f"example-{range['value']}",
availability_zone=available.names[range["value"]],
cidr_block=std.cidrsubnet(input=example_aws_vpc["cidrBlock"],
newbits=8,
netnum=range["value"]).result,
vpc_id=example_aws_vpc["id"]))
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
available, err := aws.GetAvailabilityZones(ctx, &aws.GetAvailabilityZonesArgs{
State: pulumi.StringRef("available"),
}, nil)
if err != nil {
return err
}
invokeCidrsubnet, err := std.Cidrsubnet(ctx, &std.CidrsubnetArgs{
Input: exampleAwsVpc.CidrBlock,
Newbits: 8,
Netnum: val0,
}, nil)
if err != nil {
return err
}
var example []*ec2.Subnet
for index := 0; index < 2; index++ {
key0 := index
val0 := index
__res, err := ec2.NewSubnet(ctx, fmt.Sprintf("example-%v", key0), &ec2.SubnetArgs{
AvailabilityZone: available.Names[val0],
CidrBlock: invokeCidrsubnet.Result,
VpcId: pulumi.Any(exampleAwsVpc.Id),
})
if err != nil {
return err
}
example = append(example, __res)
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var available = Aws.GetAvailabilityZones.Invoke(new()
{
State = "available",
});
var example = new List<Aws.Ec2.Subnet>();
for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
{
var range = new { Value = rangeIndex };
example.Add(new Aws.Ec2.Subnet($"example-{range.Value}", new()
{
AvailabilityZone = available.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names)[range.Value],
CidrBlock = Std.Cidrsubnet.Invoke(new()
{
Input = exampleAwsVpc.CidrBlock,
Newbits = 8,
Netnum = range.Value,
}).Apply(invoke => invoke.Result),
VpcId = exampleAwsVpc.Id,
}));
}
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
import com.pulumi.aws.ec2.Subnet;
import com.pulumi.aws.ec2.SubnetArgs;
import com.pulumi.codegen.internal.KeyedValue;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var available = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
.state("available")
.build());
for (var i = 0; i < 2; i++) {
new Subnet("example-" + i, SubnetArgs.builder()
.availabilityZone(available.applyValue(getAvailabilityZonesResult -> getAvailabilityZonesResult.names())[range.value()])
.cidrBlock(StdFunctions.cidrsubnet(CidrsubnetArgs.builder()
.input(exampleAwsVpc.cidrBlock())
.newbits(8)
.netnum(range.value())
.build()).result())
.vpcId(exampleAwsVpc.id())
.build());
}
}
}
Coming soon!
Create NodeGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NodeGroup(name: string, args: NodeGroupArgs, opts?: CustomResourceOptions);
@overload
def NodeGroup(resource_name: str,
args: NodeGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NodeGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
node_role_arn: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
cluster_name: Optional[str] = None,
scaling_config: Optional[NodeGroupScalingConfigArgs] = None,
node_group_name: Optional[str] = None,
release_version: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
launch_template: Optional[NodeGroupLaunchTemplateArgs] = None,
ami_type: Optional[str] = None,
node_group_name_prefix: Optional[str] = None,
force_update_version: Optional[bool] = None,
instance_types: Optional[Sequence[str]] = None,
remote_access: Optional[NodeGroupRemoteAccessArgs] = None,
disk_size: Optional[int] = None,
capacity_type: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
taints: Optional[Sequence[NodeGroupTaintArgs]] = None,
update_config: Optional[NodeGroupUpdateConfigArgs] = None,
version: Optional[str] = None)
func NewNodeGroup(ctx *Context, name string, args NodeGroupArgs, opts ...ResourceOption) (*NodeGroup, error)
public NodeGroup(string name, NodeGroupArgs args, CustomResourceOptions? opts = null)
public NodeGroup(String name, NodeGroupArgs args)
public NodeGroup(String name, NodeGroupArgs args, CustomResourceOptions options)
type: aws:eks:NodeGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NodeGroupArgs
- 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 NodeGroupArgs
- 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 NodeGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NodeGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NodeGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var nodeGroupResource = new Aws.Eks.NodeGroup("nodeGroupResource", new()
{
NodeRoleArn = "string",
SubnetIds = new[]
{
"string",
},
ClusterName = "string",
ScalingConfig = new Aws.Eks.Inputs.NodeGroupScalingConfigArgs
{
DesiredSize = 0,
MaxSize = 0,
MinSize = 0,
},
NodeGroupName = "string",
ReleaseVersion = "string",
Labels =
{
{ "string", "string" },
},
LaunchTemplate = new Aws.Eks.Inputs.NodeGroupLaunchTemplateArgs
{
Version = "string",
Id = "string",
Name = "string",
},
AmiType = "string",
NodeGroupNamePrefix = "string",
ForceUpdateVersion = false,
InstanceTypes = new[]
{
"string",
},
RemoteAccess = new Aws.Eks.Inputs.NodeGroupRemoteAccessArgs
{
Ec2SshKey = "string",
SourceSecurityGroupIds = new[]
{
"string",
},
},
DiskSize = 0,
CapacityType = "string",
Tags =
{
{ "string", "string" },
},
Taints = new[]
{
new Aws.Eks.Inputs.NodeGroupTaintArgs
{
Effect = "string",
Key = "string",
Value = "string",
},
},
UpdateConfig = new Aws.Eks.Inputs.NodeGroupUpdateConfigArgs
{
MaxUnavailable = 0,
MaxUnavailablePercentage = 0,
},
Version = "string",
});
example, err := eks.NewNodeGroup(ctx, "nodeGroupResource", &eks.NodeGroupArgs{
NodeRoleArn: pulumi.String("string"),
SubnetIds: pulumi.StringArray{
pulumi.String("string"),
},
ClusterName: pulumi.String("string"),
ScalingConfig: &eks.NodeGroupScalingConfigArgs{
DesiredSize: pulumi.Int(0),
MaxSize: pulumi.Int(0),
MinSize: pulumi.Int(0),
},
NodeGroupName: pulumi.String("string"),
ReleaseVersion: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
LaunchTemplate: &eks.NodeGroupLaunchTemplateArgs{
Version: pulumi.String("string"),
Id: pulumi.String("string"),
Name: pulumi.String("string"),
},
AmiType: pulumi.String("string"),
NodeGroupNamePrefix: pulumi.String("string"),
ForceUpdateVersion: pulumi.Bool(false),
InstanceTypes: pulumi.StringArray{
pulumi.String("string"),
},
RemoteAccess: &eks.NodeGroupRemoteAccessArgs{
Ec2SshKey: pulumi.String("string"),
SourceSecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
},
DiskSize: pulumi.Int(0),
CapacityType: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Taints: eks.NodeGroupTaintArray{
&eks.NodeGroupTaintArgs{
Effect: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
UpdateConfig: &eks.NodeGroupUpdateConfigArgs{
MaxUnavailable: pulumi.Int(0),
MaxUnavailablePercentage: pulumi.Int(0),
},
Version: pulumi.String("string"),
})
var nodeGroupResource = new NodeGroup("nodeGroupResource", NodeGroupArgs.builder()
.nodeRoleArn("string")
.subnetIds("string")
.clusterName("string")
.scalingConfig(NodeGroupScalingConfigArgs.builder()
.desiredSize(0)
.maxSize(0)
.minSize(0)
.build())
.nodeGroupName("string")
.releaseVersion("string")
.labels(Map.of("string", "string"))
.launchTemplate(NodeGroupLaunchTemplateArgs.builder()
.version("string")
.id("string")
.name("string")
.build())
.amiType("string")
.nodeGroupNamePrefix("string")
.forceUpdateVersion(false)
.instanceTypes("string")
.remoteAccess(NodeGroupRemoteAccessArgs.builder()
.ec2SshKey("string")
.sourceSecurityGroupIds("string")
.build())
.diskSize(0)
.capacityType("string")
.tags(Map.of("string", "string"))
.taints(NodeGroupTaintArgs.builder()
.effect("string")
.key("string")
.value("string")
.build())
.updateConfig(NodeGroupUpdateConfigArgs.builder()
.maxUnavailable(0)
.maxUnavailablePercentage(0)
.build())
.version("string")
.build());
node_group_resource = aws.eks.NodeGroup("nodeGroupResource",
node_role_arn="string",
subnet_ids=["string"],
cluster_name="string",
scaling_config={
"desiredSize": 0,
"maxSize": 0,
"minSize": 0,
},
node_group_name="string",
release_version="string",
labels={
"string": "string",
},
launch_template={
"version": "string",
"id": "string",
"name": "string",
},
ami_type="string",
node_group_name_prefix="string",
force_update_version=False,
instance_types=["string"],
remote_access={
"ec2SshKey": "string",
"sourceSecurityGroupIds": ["string"],
},
disk_size=0,
capacity_type="string",
tags={
"string": "string",
},
taints=[{
"effect": "string",
"key": "string",
"value": "string",
}],
update_config={
"maxUnavailable": 0,
"maxUnavailablePercentage": 0,
},
version="string")
const nodeGroupResource = new aws.eks.NodeGroup("nodeGroupResource", {
nodeRoleArn: "string",
subnetIds: ["string"],
clusterName: "string",
scalingConfig: {
desiredSize: 0,
maxSize: 0,
minSize: 0,
},
nodeGroupName: "string",
releaseVersion: "string",
labels: {
string: "string",
},
launchTemplate: {
version: "string",
id: "string",
name: "string",
},
amiType: "string",
nodeGroupNamePrefix: "string",
forceUpdateVersion: false,
instanceTypes: ["string"],
remoteAccess: {
ec2SshKey: "string",
sourceSecurityGroupIds: ["string"],
},
diskSize: 0,
capacityType: "string",
tags: {
string: "string",
},
taints: [{
effect: "string",
key: "string",
value: "string",
}],
updateConfig: {
maxUnavailable: 0,
maxUnavailablePercentage: 0,
},
version: "string",
});
type: aws:eks:NodeGroup
properties:
amiType: string
capacityType: string
clusterName: string
diskSize: 0
forceUpdateVersion: false
instanceTypes:
- string
labels:
string: string
launchTemplate:
id: string
name: string
version: string
nodeGroupName: string
nodeGroupNamePrefix: string
nodeRoleArn: string
releaseVersion: string
remoteAccess:
ec2SshKey: string
sourceSecurityGroupIds:
- string
scalingConfig:
desiredSize: 0
maxSize: 0
minSize: 0
subnetIds:
- string
tags:
string: string
taints:
- effect: string
key: string
value: string
updateConfig:
maxUnavailable: 0
maxUnavailablePercentage: 0
version: string
NodeGroup 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 NodeGroup resource accepts the following input properties:
- Cluster
Name string - Name of the EKS Cluster.
- Node
Role stringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- Scaling
Config NodeGroup Scaling Config - Configuration block with scaling settings. See
scaling_config
below for details. - Subnet
Ids List<string> Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- Ami
Type string - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. 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. - Disk
Size int - Disk size in GiB for worker nodes. Defaults to
50
for Windows,20
all other node groups. The 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> - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 NodeGroup Launch Template - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - Node
Group stringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - Node
Group stringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - Release
Version string - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- Remote
Access NodeGroup Remote Access - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Taints
List<Node
Group Taint> - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- Update
Config NodeGroup Update Config - Configuration block with update settings. See
update_config
below for details. - Version string
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- Cluster
Name string - Name of the EKS Cluster.
- Node
Role stringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- Scaling
Config NodeGroup Scaling Config Args - Configuration block with scaling settings. See
scaling_config
below for details. - Subnet
Ids []string Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- Ami
Type string - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. 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. - Disk
Size int - Disk size in GiB for worker nodes. Defaults to
50
for Windows,20
all other node groups. The 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 - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - Node
Group stringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - Node
Group stringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - Release
Version string - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- Remote
Access NodeGroup Remote Access Args - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - map[string]string
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - 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. See taint below for details.
- Update
Config NodeGroup Update Config Args - Configuration block with update settings. See
update_config
below for details. - Version string
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- cluster
Name String - Name of the EKS Cluster.
- node
Role StringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- scaling
Config NodeGroup Scaling Config - Configuration block with scaling settings. See
scaling_config
below for details. - subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- ami
Type String - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. 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. - disk
Size Integer - Disk size in GiB for worker nodes. Defaults to
50
for Windows,20
all other node groups. The 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> - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node
Group StringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node
Group StringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - release
Version String - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access NodeGroup Remote Access - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - taints
List<Node
Group Taint> - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update
Config NodeGroup Update Config - Configuration block with update settings. See
update_config
below for details. - version String
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- cluster
Name string - Name of the EKS Cluster.
- node
Role stringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- scaling
Config NodeGroup Scaling Config - Configuration block with scaling settings. See
scaling_config
below for details. - subnet
Ids string[] Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- ami
Type string - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. 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. - disk
Size number - Disk size in GiB for worker nodes. Defaults to
50
for Windows,20
all other node groups. The 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[] - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 NodeGroup Launch Template - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node
Group stringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node
Group stringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - release
Version string - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access NodeGroup Remote Access - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - taints
Node
Group Taint[] - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update
Config NodeGroup Update Config - Configuration block with update settings. See
update_config
below for details. - version string
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- cluster_
name str - Name of the EKS Cluster.
- node_
role_ strarn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- scaling_
config NodeGroup Scaling Config Args - Configuration block with scaling settings. See
scaling_config
below for details. - subnet_
ids Sequence[str] Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- ami_
type str - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. 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. - disk_
size int - Disk size in GiB for worker nodes. Defaults to
50
for Windows,20
all other node groups. The 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] - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node_
group_ strname - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node_
group_ strname_ prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - release_
version str - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote_
access NodeGroup Remote Access Args - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - taints
Sequence[Node
Group Taint Args] - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update_
config NodeGroup Update Config Args - Configuration block with update settings. See
update_config
below for details. - version str
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- cluster
Name String - Name of the EKS Cluster.
- node
Role StringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- scaling
Config Property Map - Configuration block with scaling settings. See
scaling_config
below for details. - subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- ami
Type String - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. 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. - disk
Size Number - Disk size in GiB for worker nodes. Defaults to
50
for Windows,20
all other node groups. The 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> - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node
Group StringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node
Group StringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - release
Version String - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access Property Map - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - Map<String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - taints List<Property Map>
- The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update
Config Property Map - Configuration block with update settings. See
update_config
below for details. - version String
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
Outputs
All input properties are implicitly available as output properties. Additionally, the NodeGroup resource produces the following output properties:
- Arn string
- Amazon Resource Name (ARN) of the EKS Node Group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Resources
List<Node
Group Resource> - List of objects containing information about underlying resources.
- Status string
- Status of the EKS Node Group.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- Amazon Resource Name (ARN) of the EKS Node Group.
- Id string
- The provider-assigned unique ID for this managed resource.
- Resources
[]Node
Group Resource - List of objects containing information about underlying resources.
- Status string
- Status of the EKS Node Group.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) of the EKS Node Group.
- id String
- The provider-assigned unique ID for this managed resource.
- resources
List<Node
Group Resource> - List of objects containing information about underlying resources.
- status String
- Status of the EKS Node Group.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- Amazon Resource Name (ARN) of the EKS Node Group.
- id string
- The provider-assigned unique ID for this managed resource.
- resources
Node
Group Resource[] - List of objects containing information about underlying resources.
- status string
- Status of the EKS Node Group.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- Amazon Resource Name (ARN) of the EKS Node Group.
- id str
- The provider-assigned unique ID for this managed resource.
- resources
Sequence[Node
Group Resource] - List of objects containing information about underlying resources.
- status str
- Status of the EKS Node Group.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- Amazon Resource Name (ARN) of the EKS Node Group.
- id String
- The provider-assigned unique ID for this managed resource.
- resources List<Property Map>
- List of objects containing information about underlying resources.
- status String
- Status of the EKS Node Group.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing NodeGroup Resource
Get an existing NodeGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NodeGroupState, opts?: CustomResourceOptions): NodeGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
ami_type: Optional[str] = None,
arn: Optional[str] = None,
capacity_type: Optional[str] = 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[NodeGroupLaunchTemplateArgs] = None,
node_group_name: Optional[str] = None,
node_group_name_prefix: Optional[str] = None,
node_role_arn: Optional[str] = None,
release_version: Optional[str] = None,
remote_access: Optional[NodeGroupRemoteAccessArgs] = None,
resources: Optional[Sequence[NodeGroupResourceArgs]] = None,
scaling_config: Optional[NodeGroupScalingConfigArgs] = None,
status: Optional[str] = None,
subnet_ids: Optional[Sequence[str]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
taints: Optional[Sequence[NodeGroupTaintArgs]] = None,
update_config: Optional[NodeGroupUpdateConfigArgs] = None,
version: Optional[str] = None) -> NodeGroup
func GetNodeGroup(ctx *Context, name string, id IDInput, state *NodeGroupState, opts ...ResourceOption) (*NodeGroup, error)
public static NodeGroup Get(string name, Input<string> id, NodeGroupState? state, CustomResourceOptions? opts = null)
public static NodeGroup get(String name, Output<String> id, NodeGroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Ami
Type string - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. This provider will only perform drift detection if a configuration value is provided.
- Arn string
- Amazon Resource Name (ARN) of the EKS Node Group.
- 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
50
for Windows,20
all other node groups. The 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> - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 NodeGroup Launch Template - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - Node
Group stringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - Node
Group stringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - Node
Role stringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- Release
Version string - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- Remote
Access NodeGroup Remote Access - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - Resources
List<Node
Group Resource> - List of objects containing information about underlying resources.
- Scaling
Config NodeGroup Scaling Config - Configuration block with scaling settings. See
scaling_config
below for details. - Status string
- Status of the EKS Node Group.
- Subnet
Ids List<string> Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Taints
List<Node
Group Taint> - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- Update
Config NodeGroup Update Config - Configuration block with update settings. See
update_config
below for details. - Version string
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- Ami
Type string - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. This provider will only perform drift detection if a configuration value is provided.
- Arn string
- Amazon Resource Name (ARN) of the EKS Node Group.
- 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
50
for Windows,20
all other node groups. The 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 - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - Node
Group stringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - Node
Group stringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - Node
Role stringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- Release
Version string - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- Remote
Access NodeGroup Remote Access Args - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - Resources
[]Node
Group Resource Args - List of objects containing information about underlying resources.
- Scaling
Config NodeGroup Scaling Config Args - Configuration block with scaling settings. See
scaling_config
below for details. - Status string
- Status of the EKS Node Group.
- Subnet
Ids []string Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - 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. See taint below for details.
- Update
Config NodeGroup Update Config Args - Configuration block with update settings. See
update_config
below for details. - Version string
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- ami
Type String - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. This provider will only perform drift detection if a configuration value is provided.
- arn String
- Amazon Resource Name (ARN) of the EKS Node Group.
- 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
50
for Windows,20
all other node groups. The 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> - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node
Group StringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node
Group StringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - node
Role StringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- release
Version String - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access NodeGroup Remote Access - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - resources
List<Node
Group Resource> - List of objects containing information about underlying resources.
- scaling
Config NodeGroup Scaling Config - Configuration block with scaling settings. See
scaling_config
below for details. - status String
- Status of the EKS Node Group.
- subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - taints
List<Node
Group Taint> - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update
Config NodeGroup Update Config - Configuration block with update settings. See
update_config
below for details. - version String
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- ami
Type string - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. This provider will only perform drift detection if a configuration value is provided.
- arn string
- Amazon Resource Name (ARN) of the EKS Node Group.
- 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
50
for Windows,20
all other node groups. The 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[] - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 NodeGroup Launch Template - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node
Group stringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node
Group stringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - node
Role stringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- release
Version string - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access NodeGroup Remote Access - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - resources
Node
Group Resource[] - List of objects containing information about underlying resources.
- scaling
Config NodeGroup Scaling Config - Configuration block with scaling settings. See
scaling_config
below for details. - status string
- Status of the EKS Node Group.
- subnet
Ids string[] Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - taints
Node
Group Taint[] - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update
Config NodeGroup Update Config - Configuration block with update settings. See
update_config
below for details. - version string
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- ami_
type str - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. This provider will only perform drift detection if a configuration value is provided.
- arn str
- Amazon Resource Name (ARN) of the EKS Node Group.
- 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
50
for Windows,20
all other node groups. The 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] - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node_
group_ strname - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node_
group_ strname_ prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - node_
role_ strarn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- release_
version str - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote_
access NodeGroup Remote Access Args - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - resources
Sequence[Node
Group Resource Args] - List of objects containing information about underlying resources.
- scaling_
config NodeGroup Scaling Config Args - Configuration block with scaling settings. See
scaling_config
below for details. - status str
- Status of the EKS Node Group.
- subnet_
ids Sequence[str] Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - taints
Sequence[Node
Group Taint Args] - The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update_
config NodeGroup Update Config Args - Configuration block with update settings. See
update_config
below for details. - version str
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
- ami
Type String - Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values. This provider will only perform drift detection if a configuration value is provided.
- arn String
- Amazon Resource Name (ARN) of the EKS Node Group.
- 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
50
for Windows,20
all other node groups. The 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> - List of instance types associated with the EKS Node Group. Defaults to
["t3.medium"]
. The provider will only perform drift detection if a configuration value is provided. - 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 - Configuration block with Launch Template settings. See
launch_template
below for details. Conflicts withremote_access
. - node
Group StringName - Name of the EKS Node Group. If omitted, the provider will assign a random, unique name. Conflicts with
node_group_name_prefix
. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. - node
Group StringName Prefix - Creates a unique name beginning with the specified prefix. Conflicts with
node_group_name
. - node
Role StringArn - Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group.
- release
Version String - AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version.
- remote
Access Property Map - Configuration block with remote access settings. See
remote_access
below for details. Conflicts withlaunch_template
. - resources List<Property Map>
- List of objects containing information about underlying resources.
- scaling
Config Property Map - Configuration block with scaling settings. See
scaling_config
below for details. - status String
- Status of the EKS Node Group.
- subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group.
The following arguments are optional:
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - taints List<Property Map>
- The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See taint below for details.
- update
Config Property Map - Configuration block with update settings. See
update_config
below for details. - version String
- Kubernetes version. Defaults to EKS Cluster Kubernetes version. The provider will only perform drift detection if a configuration value is provided.
Supporting Types
NodeGroupLaunchTemplate, NodeGroupLaunchTemplateArgs
- Version string
- EC2 Launch Template version number. While the API accepts values like
$Default
and$Latest
, the API will convert the value to the associated version number (e.g.,1
) on read and the provider will show a difference on next plan. Using thedefault_version
orlatest_version
attribute of theaws.ec2.LaunchTemplate
resource or data source is recommended for this argument. - Id string
- Identifier of the EC2 Launch Template. Conflicts with
name
. - Name string
- Name of the EC2 Launch Template. Conflicts with
id
.
- Version string
- EC2 Launch Template version number. While the API accepts values like
$Default
and$Latest
, the API will convert the value to the associated version number (e.g.,1
) on read and the provider will show a difference on next plan. Using thedefault_version
orlatest_version
attribute of theaws.ec2.LaunchTemplate
resource or data source is recommended for this argument. - Id string
- Identifier of the EC2 Launch Template. Conflicts with
name
. - Name string
- Name of the EC2 Launch Template. Conflicts with
id
.
- version String
- EC2 Launch Template version number. While the API accepts values like
$Default
and$Latest
, the API will convert the value to the associated version number (e.g.,1
) on read and the provider will show a difference on next plan. Using thedefault_version
orlatest_version
attribute of theaws.ec2.LaunchTemplate
resource or data source is recommended for this argument. - id String
- Identifier of the EC2 Launch Template. Conflicts with
name
. - name String
- Name of the EC2 Launch Template. Conflicts with
id
.
- version string
- EC2 Launch Template version number. While the API accepts values like
$Default
and$Latest
, the API will convert the value to the associated version number (e.g.,1
) on read and the provider will show a difference on next plan. Using thedefault_version
orlatest_version
attribute of theaws.ec2.LaunchTemplate
resource or data source is recommended for this argument. - id string
- Identifier of the EC2 Launch Template. Conflicts with
name
. - name string
- Name of the EC2 Launch Template. Conflicts with
id
.
- version str
- EC2 Launch Template version number. While the API accepts values like
$Default
and$Latest
, the API will convert the value to the associated version number (e.g.,1
) on read and the provider will show a difference on next plan. Using thedefault_version
orlatest_version
attribute of theaws.ec2.LaunchTemplate
resource or data source is recommended for this argument. - id str
- Identifier of the EC2 Launch Template. Conflicts with
name
. - name str
- Name of the EC2 Launch Template. Conflicts with
id
.
- version String
- EC2 Launch Template version number. While the API accepts values like
$Default
and$Latest
, the API will convert the value to the associated version number (e.g.,1
) on read and the provider will show a difference on next plan. Using thedefault_version
orlatest_version
attribute of theaws.ec2.LaunchTemplate
resource or data source is recommended for this argument. - id String
- Identifier of the EC2 Launch Template. Conflicts with
name
. - name String
- Name of the EC2 Launch Template. Conflicts with
id
.
NodeGroupRemoteAccess, NodeGroupRemoteAccessArgs
- Ec2Ssh
Key string - EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify
source_security_group_ids
when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes. - Source
Security List<string>Group Ids - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify
ec2_ssh_key
, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).
- Ec2Ssh
Key string - EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify
source_security_group_ids
when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes. - Source
Security []stringGroup Ids - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify
ec2_ssh_key
, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).
- ec2Ssh
Key String - EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify
source_security_group_ids
when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes. - source
Security List<String>Group Ids - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify
ec2_ssh_key
, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).
- ec2Ssh
Key string - EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify
source_security_group_ids
when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes. - source
Security string[]Group Ids - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify
ec2_ssh_key
, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).
- ec2_
ssh_ strkey - EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify
source_security_group_ids
when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes. - source_
security_ Sequence[str]group_ ids - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify
ec2_ssh_key
, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).
- ec2Ssh
Key String - EC2 Key Pair name that provides access for remote communication with the worker nodes in the EKS Node Group. If you specify this configuration, but do not specify
source_security_group_ids
when you create an EKS Node Group, either port 3389 for Windows, or port 22 for all other operating systems is opened on the worker nodes to the Internet (0.0.0.0/0). For Windows nodes, this will allow you to use RDP, for all others this allows you to SSH into the worker nodes. - source
Security List<String>Group Ids - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. If you specify
ec2_ssh_key
, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0).
NodeGroupResource, NodeGroupResourceArgs
- Autoscaling
Groups List<NodeGroup Resource Autoscaling Group> - List of objects containing information about AutoScaling Groups.
- Remote
Access stringSecurity Group Id - Identifier of the remote access EC2 Security Group.
- Autoscaling
Groups []NodeGroup Resource Autoscaling Group - List of objects containing information about AutoScaling Groups.
- Remote
Access stringSecurity Group Id - Identifier of the remote access EC2 Security Group.
- autoscaling
Groups List<NodeGroup Resource Autoscaling Group> - List of objects containing information about AutoScaling Groups.
- remote
Access StringSecurity Group Id - Identifier of the remote access EC2 Security Group.
- autoscaling
Groups NodeGroup Resource Autoscaling Group[] - List of objects containing information about AutoScaling Groups.
- remote
Access stringSecurity Group Id - Identifier of the remote access EC2 Security Group.
- autoscaling_
groups Sequence[NodeGroup Resource Autoscaling Group] - List of objects containing information about AutoScaling Groups.
- remote_
access_ strsecurity_ group_ id - Identifier of the remote access EC2 Security Group.
- autoscaling
Groups List<Property Map> - List of objects containing information about AutoScaling Groups.
- remote
Access StringSecurity Group Id - Identifier of the remote access EC2 Security Group.
NodeGroupResourceAutoscalingGroup, NodeGroupResourceAutoscalingGroupArgs
- Name string
- Name of the AutoScaling Group.
- Name string
- Name of the AutoScaling Group.
- name String
- Name of the AutoScaling Group.
- name string
- Name of the AutoScaling Group.
- name str
- Name of the AutoScaling Group.
- name String
- Name of the AutoScaling Group.
NodeGroupScalingConfig, NodeGroupScalingConfigArgs
- Desired
Size int - Desired number of worker nodes.
- Max
Size int - Maximum number of worker nodes.
- Min
Size int - Minimum number of worker nodes.
- Desired
Size int - Desired number of worker nodes.
- Max
Size int - Maximum number of worker nodes.
- Min
Size int - Minimum number of worker nodes.
- desired
Size Integer - Desired number of worker nodes.
- max
Size Integer - Maximum number of worker nodes.
- min
Size Integer - Minimum number of worker nodes.
- desired
Size number - Desired number of worker nodes.
- max
Size number - Maximum number of worker nodes.
- min
Size number - Minimum number of worker nodes.
- desired_
size int - Desired number of worker nodes.
- max_
size int - Maximum number of worker nodes.
- min_
size int - Minimum number of worker nodes.
- desired
Size Number - Desired number of worker nodes.
- max
Size Number - Maximum number of worker nodes.
- min
Size Number - Minimum number of worker nodes.
NodeGroupTaint, NodeGroupTaintArgs
NodeGroupUpdateConfig, NodeGroupUpdateConfigArgs
- int
- Desired max number of unavailable worker nodes during node group update.
- int
- Desired max percentage of unavailable worker nodes during node group update.
- int
- Desired max number of unavailable worker nodes during node group update.
- int
- Desired max percentage of unavailable worker nodes during node group update.
- Integer
- Desired max number of unavailable worker nodes during node group update.
- Integer
- Desired max percentage of unavailable worker nodes during node group update.
- number
- Desired max number of unavailable worker nodes during node group update.
- number
- Desired max percentage of unavailable worker nodes during node group update.
- int
- Desired max number of unavailable worker nodes during node group update.
- int
- Desired max percentage of unavailable worker nodes during node group update.
- Number
- Desired max number of unavailable worker nodes during node group update.
- Number
- Desired max percentage of unavailable worker nodes during node group update.
Import
Using pulumi import
, import EKS Node Groups using the cluster_name
and node_group_name
separated by a colon (:
). For example:
$ pulumi import aws:eks/nodeGroup:NodeGroup my_node_group my_cluster:my_node_group
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.