Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. eks
  5. getNodeGroup
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.eks.getNodeGroup

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Retrieve information about an EKS Node Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.eks.getNodeGroup({
    clusterName: "example",
    nodeGroupName: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.eks.get_node_group(cluster_name="example",
    node_group_name="example")

    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.LookupNodeGroup(ctx, &eks.LookupNodeGroupArgs{
			ClusterName:   "example",
			NodeGroupName: "example",
		}, nil)
		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 = Aws.Eks.GetNodeGroup.Invoke(new()
    {
        ClusterName = "example",
        NodeGroupName = "example",
    });

});

    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());

    }
}

    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:

    ClusterName string
    Name of the cluster.
    NodeGroupName string
    Name of the node group.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    ClusterName string
    Name of the cluster.
    NodeGroupName string
    Name of the node group.
    Tags map[string]string
    Key-value map of resource tags.
    clusterName String
    Name of the cluster.
    nodeGroupName String
    Name of the node group.
    tags Map<String,String>
    Key-value map of resource tags.
    clusterName string
    Name of the cluster.
    nodeGroupName string
    Name of the node group.
    tags {[key: string]: string}
    Key-value map of resource tags.
    cluster_name str
    Name of the cluster.
    node_group_name str
    Name of the node group.
    tags Mapping[str, str]
    Key-value map of resource tags.
    clusterName String
    Name of the cluster.
    nodeGroupName String
    Name of the node group.
    tags Map<String>
    Key-value map of resource tags.

    getNodeGroup Result

    The following output properties are available:

    AmiType string
    Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
    Arn string
    ARN of the EKS Node Group.
    CapacityType string
    Type of capacity associated with the EKS Node Group. Valid values: ON_DEMAND, SPOT.
    ClusterName string
    DiskSize int
    Disk size in GiB for worker nodes.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceTypes 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.
    LaunchTemplates List<GetNodeGroupLaunchTemplate>
    Nested attribute containing information about the launch template used to create the EKS Node Group.
    NodeGroupName string
    NodeRoleArn string
    ARN of the IAM Role that provides permissions for the EKS Node Group.
    ReleaseVersion string
    AMI version of the EKS Node Group.
    RemoteAccesses List<GetNodeGroupRemoteAccess>
    Configuration block with remote access settings.
    Resources List<GetNodeGroupResource>
    List of objects containing information about underlying resources.
    ScalingConfigs List<GetNodeGroupScalingConfig>
    Configuration block with scaling settings.
    Status string
    Status of the EKS Node Group.
    SubnetIds List<string>
    Identifiers of EC2 Subnets to associate with the EKS Node Group.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    Taints List<GetNodeGroupTaint>
    List of objects containing information about taints applied to the nodes in the EKS Node Group.
    Version string
    Kubernetes version.
    AmiType string
    Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
    Arn string
    ARN of the EKS Node Group.
    CapacityType string
    Type of capacity associated with the EKS Node Group. Valid values: ON_DEMAND, SPOT.
    ClusterName string
    DiskSize int
    Disk size in GiB for worker nodes.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceTypes []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.
    LaunchTemplates []GetNodeGroupLaunchTemplate
    Nested attribute containing information about the launch template used to create the EKS Node Group.
    NodeGroupName string
    NodeRoleArn string
    ARN of the IAM Role that provides permissions for the EKS Node Group.
    ReleaseVersion string
    AMI version of the EKS Node Group.
    RemoteAccesses []GetNodeGroupRemoteAccess
    Configuration block with remote access settings.
    Resources []GetNodeGroupResource
    List of objects containing information about underlying resources.
    ScalingConfigs []GetNodeGroupScalingConfig
    Configuration block with scaling settings.
    Status string
    Status of the EKS Node Group.
    SubnetIds []string
    Identifiers of EC2 Subnets to associate with the EKS Node Group.
    Tags map[string]string
    Key-value map of resource tags.
    Taints []GetNodeGroupTaint
    List of objects containing information about taints applied to the nodes in the EKS Node Group.
    Version string
    Kubernetes version.
    amiType String
    Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
    arn String
    ARN of the EKS Node Group.
    capacityType String
    Type of capacity associated with the EKS Node Group. Valid values: ON_DEMAND, SPOT.
    clusterName String
    diskSize Integer
    Disk size in GiB for worker nodes.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceTypes 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.
    launchTemplates List<GetNodeGroupLaunchTemplate>
    Nested attribute containing information about the launch template used to create the EKS Node Group.
    nodeGroupName String
    nodeRoleArn String
    ARN of the IAM Role that provides permissions for the EKS Node Group.
    releaseVersion String
    AMI version of the EKS Node Group.
    remoteAccesses List<GetNodeGroupRemoteAccess>
    Configuration block with remote access settings.
    resources List<GetNodeGroupResource>
    List of objects containing information about underlying resources.
    scalingConfigs List<GetNodeGroupScalingConfig>
    Configuration block with scaling settings.
    status String
    Status of the EKS Node Group.
    subnetIds List<String>
    Identifiers of EC2 Subnets to associate with the EKS Node Group.
    tags Map<String,String>
    Key-value map of resource tags.
    taints List<GetNodeGroupTaint>
    List of objects containing information about taints applied to the nodes in the EKS Node Group.
    version String
    Kubernetes version.
    amiType string
    Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
    arn string
    ARN of the EKS Node Group.
    capacityType string
    Type of capacity associated with the EKS Node Group. Valid values: ON_DEMAND, SPOT.
    clusterName string
    diskSize number
    Disk size in GiB for worker nodes.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceTypes 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.
    launchTemplates GetNodeGroupLaunchTemplate[]
    Nested attribute containing information about the launch template used to create the EKS Node Group.
    nodeGroupName string
    nodeRoleArn string
    ARN of the IAM Role that provides permissions for the EKS Node Group.
    releaseVersion string
    AMI version of the EKS Node Group.
    remoteAccesses GetNodeGroupRemoteAccess[]
    Configuration block with remote access settings.
    resources GetNodeGroupResource[]
    List of objects containing information about underlying resources.
    scalingConfigs GetNodeGroupScalingConfig[]
    Configuration block with scaling settings.
    status string
    Status of the EKS Node Group.
    subnetIds string[]
    Identifiers of EC2 Subnets to associate with the EKS Node Group.
    tags {[key: string]: string}
    Key-value map of resource tags.
    taints GetNodeGroupTaint[]
    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.
    launch_templates Sequence[GetNodeGroupLaunchTemplate]
    Nested attribute containing information about the launch template used to create the EKS Node Group.
    node_group_name str
    node_role_arn str
    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[GetNodeGroupRemoteAccess]
    Configuration block with remote access settings.
    resources Sequence[GetNodeGroupResource]
    List of objects containing information about underlying resources.
    scaling_configs Sequence[GetNodeGroupScalingConfig]
    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.
    tags Mapping[str, str]
    Key-value map of resource tags.
    taints Sequence[GetNodeGroupTaint]
    List of objects containing information about taints applied to the nodes in the EKS Node Group.
    version str
    Kubernetes version.
    amiType String
    Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
    arn String
    ARN of the EKS Node Group.
    capacityType String
    Type of capacity associated with the EKS Node Group. Valid values: ON_DEMAND, SPOT.
    clusterName String
    diskSize Number
    Disk size in GiB for worker nodes.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceTypes 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.
    launchTemplates List<Property Map>
    Nested attribute containing information about the launch template used to create the EKS Node Group.
    nodeGroupName String
    nodeRoleArn String
    ARN of the IAM Role that provides permissions for the EKS Node Group.
    releaseVersion String
    AMI version of the EKS Node Group.
    remoteAccesses List<Property Map>
    Configuration block with remote access settings.
    resources List<Property Map>
    List of objects containing information about underlying resources.
    scalingConfigs List<Property Map>
    Configuration block with scaling settings.
    status String
    Status of the EKS Node Group.
    subnetIds List<String>
    Identifiers of EC2 Subnets to associate with the EKS Node Group.
    tags 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

    GetNodeGroupLaunchTemplate

    Id string
    The ID of the launch template.
    Name string
    Name of the AutoScaling Group.
    Version string
    Kubernetes version.
    Id string
    The ID of the launch template.
    Name string
    Name of the AutoScaling Group.
    Version string
    Kubernetes version.
    id String
    The ID of the launch template.
    name String
    Name of the AutoScaling Group.
    version String
    Kubernetes version.
    id string
    The ID of the launch template.
    name string
    Name of the AutoScaling Group.
    version string
    Kubernetes version.
    id str
    The ID of the launch template.
    name str
    Name of the AutoScaling Group.
    version str
    Kubernetes version.
    id String
    The ID of the launch template.
    name String
    Name of the AutoScaling Group.
    version String
    Kubernetes version.

    GetNodeGroupRemoteAccess

    Ec2SshKey string
    EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
    SourceSecurityGroupIds List<string>
    Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
    Ec2SshKey string
    EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
    SourceSecurityGroupIds []string
    Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
    ec2SshKey String
    EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
    sourceSecurityGroupIds List<String>
    Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
    ec2SshKey string
    EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
    sourceSecurityGroupIds string[]
    Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
    ec2_ssh_key str
    EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
    source_security_group_ids Sequence[str]
    Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.
    ec2SshKey String
    EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group.
    sourceSecurityGroupIds List<String>
    Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes.

    GetNodeGroupResource

    AutoscalingGroups List<GetNodeGroupResourceAutoscalingGroup>
    List of objects containing information about AutoScaling Groups.
    RemoteAccessSecurityGroupId string
    Identifier of the remote access EC2 Security Group.
    AutoscalingGroups []GetNodeGroupResourceAutoscalingGroup
    List of objects containing information about AutoScaling Groups.
    RemoteAccessSecurityGroupId string
    Identifier of the remote access EC2 Security Group.
    autoscalingGroups List<GetNodeGroupResourceAutoscalingGroup>
    List of objects containing information about AutoScaling Groups.
    remoteAccessSecurityGroupId String
    Identifier of the remote access EC2 Security Group.
    autoscalingGroups GetNodeGroupResourceAutoscalingGroup[]
    List of objects containing information about AutoScaling Groups.
    remoteAccessSecurityGroupId string
    Identifier of the remote access EC2 Security Group.
    autoscaling_groups Sequence[GetNodeGroupResourceAutoscalingGroup]
    List of objects containing information about AutoScaling Groups.
    remote_access_security_group_id str
    Identifier of the remote access EC2 Security Group.
    autoscalingGroups List<Property Map>
    List of objects containing information about AutoScaling Groups.
    remoteAccessSecurityGroupId String
    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

    DesiredSize int
    Desired number of worker nodes.
    MaxSize int
    Maximum number of worker nodes.
    MinSize int
    Minimum number of worker nodes.
    DesiredSize int
    Desired number of worker nodes.
    MaxSize int
    Maximum number of worker nodes.
    MinSize int
    Minimum number of worker nodes.
    desiredSize Integer
    Desired number of worker nodes.
    maxSize Integer
    Maximum number of worker nodes.
    minSize Integer
    Minimum number of worker nodes.
    desiredSize number
    Desired number of worker nodes.
    maxSize number
    Maximum number of worker nodes.
    minSize 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.
    desiredSize Number
    Desired number of worker nodes.
    maxSize Number
    Maximum number of worker nodes.
    minSize Number
    Minimum number of worker nodes.

    GetNodeGroupTaint

    Effect string
    The effect of the taint.
    Key string
    The key of the taint.
    Value string
    The value of the taint.
    Effect string
    The effect of the taint.
    Key string
    The key of the taint.
    Value string
    The value of the taint.
    effect String
    The effect of the taint.
    key String
    The key of the taint.
    value String
    The value of the taint.
    effect string
    The effect of the taint.
    key string
    The key of the taint.
    value string
    The value of the taint.
    effect str
    The effect of the taint.
    key str
    The key of the taint.
    value str
    The value of the taint.
    effect String
    The effect of the taint.
    key String
    The key of the taint.
    value String
    The value of the taint.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws