aws.eks.getNodeGroup
Retrieve information about an EKS Node Group.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Eks.GetNodeGroup.Invoke(new()
{
ClusterName = "example",
NodeGroupName = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/eks"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := eks.LookupNodeGroup(ctx, &eks.LookupNodeGroupArgs{
ClusterName: "example",
NodeGroupName: "example",
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.eks.EksFunctions;
import com.pulumi.aws.eks.inputs.GetNodeGroupArgs;
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 example = EksFunctions.getNodeGroup(GetNodeGroupArgs.builder()
.clusterName("example")
.nodeGroupName("example")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.eks.get_node_group(cluster_name="example",
node_group_name="example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.eks.getNodeGroup({
clusterName: "example",
nodeGroupName: "example",
});
variables:
example:
fn::invoke:
Function: aws:eks:getNodeGroup
Arguments:
clusterName: example
nodeGroupName: example
Using getNodeGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getNodeGroup(args: GetNodeGroupArgs, opts?: InvokeOptions): Promise<GetNodeGroupResult>
function getNodeGroupOutput(args: GetNodeGroupOutputArgs, opts?: InvokeOptions): Output<GetNodeGroupResult>
def get_node_group(cluster_name: Optional[str] = None,
node_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetNodeGroupResult
def get_node_group_output(cluster_name: Optional[pulumi.Input[str]] = None,
node_group_name: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNodeGroupResult]
func LookupNodeGroup(ctx *Context, args *LookupNodeGroupArgs, opts ...InvokeOption) (*LookupNodeGroupResult, error)
func LookupNodeGroupOutput(ctx *Context, args *LookupNodeGroupOutputArgs, opts ...InvokeOption) LookupNodeGroupResultOutput
> Note: This function is named LookupNodeGroup
in the Go SDK.
public static class GetNodeGroup
{
public static Task<GetNodeGroupResult> InvokeAsync(GetNodeGroupArgs args, InvokeOptions? opts = null)
public static Output<GetNodeGroupResult> Invoke(GetNodeGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNodeGroupResult> getNodeGroup(GetNodeGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:eks/getNodeGroup:getNodeGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string Name of the cluster.
- Node
Group stringName Name of the node group.
- Dictionary<string, string>
Key-value map of resource tags.
- Cluster
Name string Name of the cluster.
- Node
Group stringName Name of the node group.
- map[string]string
Key-value map of resource tags.
- cluster
Name String Name of the cluster.
- node
Group StringName Name of the node group.
- Map<String,String>
Key-value map of resource tags.
- cluster
Name string Name of the cluster.
- node
Group stringName Name of the node group.
- {[key: string]: string}
Key-value map of resource tags.
- cluster_
name str Name of the cluster.
- node_
group_ strname Name of the node group.
- Mapping[str, str]
Key-value map of resource tags.
- cluster
Name String Name of the cluster.
- node
Group StringName Name of the node group.
- Map<String>
Key-value map of resource tags.
getNodeGroup Result
The following output properties are available:
- Ami
Type string Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
- Arn string
ARN of the EKS Node Group.
- Capacity
Type string Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
.- Cluster
Name string - Disk
Size int Disk size in GiB for worker nodes.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Types List<string> Set of instance types associated with the EKS Node Group.
- 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.
- Node
Group stringName - Node
Role stringArn ARN of the IAM Role that provides permissions for the EKS Node Group.
- Release
Version string AMI version of the EKS Node Group.
- Remote
Accesses List<Pulumi.Aws. Eks. Outputs. Get Node Group Remote Access> Configuration block with remote access settings.
- Resources
List<Pulumi.
Aws. Eks. Outputs. Get Node Group Resource> List of objects containing information about underlying resources.
- Scaling
Configs List<Pulumi.Aws. Eks. Outputs. Get Node Group Scaling Config> Configuration block with scaling settings.
- Status string
Status of the EKS Node Group.
- Subnet
Ids List<string> Identifiers of EC2 Subnets to associate with the EKS Node Group.
- Dictionary<string, string>
Key-value map of resource tags.
- Taints
List<Pulumi.
Aws. Eks. Outputs. Get Node Group Taint> List of objects containing information about taints applied to the nodes in the EKS Node Group.
- Version string
Kubernetes version.
- Ami
Type string Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
- Arn string
ARN of the EKS Node Group.
- Capacity
Type string Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
.- Cluster
Name string - Disk
Size int Disk size in GiB for worker nodes.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Types []string Set of instance types associated with the EKS Node Group.
- 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.
- Node
Group stringName - Node
Role stringArn ARN of the IAM Role that provides permissions for the EKS Node Group.
- Release
Version string AMI version of the EKS Node Group.
- Remote
Accesses []GetNode Group Remote Access Configuration block with remote access settings.
- Resources
[]Get
Node Group Resource List of objects containing information about underlying resources.
- Scaling
Configs []GetNode Group Scaling Config Configuration block with scaling settings.
- Status string
Status of the EKS Node Group.
- Subnet
Ids []string Identifiers of EC2 Subnets to associate with the EKS Node Group.
- map[string]string
Key-value map of resource tags.
- Taints
[]Get
Node Group Taint List of objects containing information about taints applied to the nodes in the EKS Node Group.
- Version string
Kubernetes version.
- ami
Type String Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
- arn String
ARN of the EKS Node Group.
- capacity
Type String Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
.- cluster
Name String - disk
Size Integer Disk size in GiB for worker nodes.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Types List<String> Set of instance types associated with the EKS Node Group.
- 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.
- node
Group StringName - node
Role StringArn ARN of the IAM Role that provides permissions for the EKS Node Group.
- release
Version String AMI version of the EKS Node Group.
- remote
Accesses List<GetNode Group Remote Access> Configuration block with remote access settings.
- resources
List<Get
Node Group Resource> List of objects containing information about underlying resources.
- scaling
Configs List<GetNode Group Scaling Config> Configuration block with scaling settings.
- status String
Status of the EKS Node Group.
- subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group.
- Map<String,String>
Key-value map of resource tags.
- taints
List<Get
Node Group Taint> List of objects containing information about taints applied to the nodes in the EKS Node Group.
- version String
Kubernetes version.
- ami
Type string Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
- arn string
ARN of the EKS Node Group.
- capacity
Type string Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
.- cluster
Name string - disk
Size number Disk size in GiB for worker nodes.
- id string
The provider-assigned unique ID for this managed resource.
- instance
Types string[] Set of instance types associated with the EKS Node Group.
- 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.
- node
Group stringName - node
Role stringArn ARN of the IAM Role that provides permissions for the EKS Node Group.
- release
Version string AMI version of the EKS Node Group.
- remote
Accesses GetNode Group Remote Access[] Configuration block with remote access settings.
- resources
Get
Node Group Resource[] List of objects containing information about underlying resources.
- scaling
Configs GetNode Group Scaling Config[] Configuration block with scaling settings.
- status string
Status of the EKS Node Group.
- subnet
Ids string[] Identifiers of EC2 Subnets to associate with the EKS Node Group.
- {[key: string]: string}
Key-value map of resource tags.
- taints
Get
Node Group Taint[] List of objects containing information about taints applied to the nodes in the EKS Node Group.
- version string
Kubernetes version.
- ami_
type str Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
- arn str
ARN of the EKS Node Group.
- capacity_
type str Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
.- cluster_
name str - disk_
size int Disk size in GiB for worker nodes.
- id str
The provider-assigned unique ID for this managed resource.
- instance_
types Sequence[str] Set of instance types associated with the EKS Node Group.
- 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.
- node_
group_ strname - node_
role_ strarn ARN of the IAM Role that provides permissions for the EKS Node Group.
- release_
version str AMI version of the EKS Node Group.
- remote_
accesses Sequence[GetNode Group Remote Access] Configuration block with remote access settings.
- resources
Sequence[Get
Node Group Resource] List of objects containing information about underlying resources.
- scaling_
configs Sequence[GetNode Group Scaling Config] Configuration block with scaling settings.
- status str
Status of the EKS Node Group.
- subnet_
ids Sequence[str] Identifiers of EC2 Subnets to associate with the EKS Node Group.
- Mapping[str, str]
Key-value map of resource tags.
- taints
Sequence[Get
Node Group Taint] List of objects containing information about taints applied to the nodes in the EKS Node Group.
- version str
Kubernetes version.
- ami
Type String Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
- arn String
ARN of the EKS Node Group.
- capacity
Type String Type of capacity associated with the EKS Node Group. Valid values:
ON_DEMAND
,SPOT
.- cluster
Name String - disk
Size Number Disk size in GiB for worker nodes.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Types List<String> Set of instance types associated with the EKS Node Group.
- 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.
- node
Group StringName - node
Role StringArn ARN of the IAM Role that provides permissions for the EKS Node Group.
- release
Version String AMI version of the EKS Node Group.
- remote
Accesses List<Property Map> Configuration block with remote access settings.
- resources List<Property Map>
List of objects containing information about underlying resources.
- scaling
Configs List<Property Map> Configuration block with scaling settings.
- status String
Status of the EKS Node Group.
- subnet
Ids List<String> Identifiers of EC2 Subnets to associate with the EKS Node Group.
- Map<String>
Key-value map of resource tags.
- taints List<Property Map>
List of objects containing information about taints applied to the nodes in the EKS Node Group.
- version String
Kubernetes version.
Supporting Types
GetNodeGroupRemoteAccess
- Ec2Ssh
Key string EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
- Source
Security List<string>Group Ids Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
- Ec2Ssh
Key string EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
- Source
Security []stringGroup Ids Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
- ec2Ssh
Key String EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
- source
Security List<String>Group Ids Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
- ec2Ssh
Key string EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
- source
Security string[]Group Ids Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
- ec2_
ssh_ strkey EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
- source_
security_ Sequence[str]group_ ids Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
- ec2Ssh
Key String EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
- source
Security List<String>Group Ids Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
GetNodeGroupResource
- Autoscaling
Groups List<Pulumi.Aws. Eks. Inputs. Get Node Group 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 []GetNode Group 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<GetNode Group 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 GetNode Group 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[GetNode Group 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.
GetNodeGroupResourceAutoscalingGroup
- 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.
GetNodeGroupScalingConfig
- 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.
GetNodeGroupTaint
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.