Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. eks
  5. getNodegroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.eks.getNodegroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::EKS::Nodegroup

    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_nodegroup(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetNodegroupResult
def get_nodegroup_output(id: Optional[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)
public static Output<GetNodegroupResult> getNodegroup(GetNodegroupArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:eks:getNodegroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Id string
    id String
    id string
    id str
    id String

    getNodegroup Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) associated with the managed node group.
    Id string
    Labels Dictionary<string, string>
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    LaunchTemplate Pulumi.AwsNative.Eks.Outputs.NodegroupLaunchTemplateSpecification
    An object representing a node group's launch template specification.
    NodeRepairConfig Pulumi.AwsNative.Eks.Outputs.NodegroupNodeRepairConfig
    The node auto repair configuration for node group.
    ReleaseVersion string
    The AMI version of the Amazon EKS-optimized AMI to use with your node group.
    ScalingConfig Pulumi.AwsNative.Eks.Outputs.NodegroupScalingConfig
    The scaling configuration details for the Auto Scaling group that is created for your node group.
    Tags Dictionary<string, string>
    The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
    Taints List<Pulumi.AwsNative.Eks.Outputs.NodegroupTaint>
    The Kubernetes taints to be applied to the nodes in the node group when they are created.
    UpdateConfig Pulumi.AwsNative.Eks.Outputs.NodegroupUpdateConfig
    The node group update configuration.
    Version string
    The Kubernetes version to use for your managed nodes.
    Arn string
    The Amazon Resource Name (ARN) associated with the managed node group.
    Id string
    Labels map[string]string
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    LaunchTemplate NodegroupLaunchTemplateSpecification
    An object representing a node group's launch template specification.
    NodeRepairConfig NodegroupNodeRepairConfig
    The node auto repair configuration for node group.
    ReleaseVersion string
    The AMI version of the Amazon EKS-optimized AMI to use with your node group.
    ScalingConfig NodegroupScalingConfig
    The scaling configuration details for the Auto Scaling group that is created for your node group.
    Tags map[string]string
    The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
    Taints []NodegroupTaint
    The Kubernetes taints to be applied to the nodes in the node group when they are created.
    UpdateConfig NodegroupUpdateConfig
    The node group update configuration.
    Version string
    The Kubernetes version to use for your managed nodes.
    arn String
    The Amazon Resource Name (ARN) associated with the managed node group.
    id String
    labels Map<String,String>
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    launchTemplate NodegroupLaunchTemplateSpecification
    An object representing a node group's launch template specification.
    nodeRepairConfig NodegroupNodeRepairConfig
    The node auto repair configuration for node group.
    releaseVersion String
    The AMI version of the Amazon EKS-optimized AMI to use with your node group.
    scalingConfig NodegroupScalingConfig
    The scaling configuration details for the Auto Scaling group that is created for your node group.
    tags Map<String,String>
    The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
    taints List<NodegroupTaint>
    The Kubernetes taints to be applied to the nodes in the node group when they are created.
    updateConfig NodegroupUpdateConfig
    The node group update configuration.
    version String
    The Kubernetes version to use for your managed nodes.
    arn string
    The Amazon Resource Name (ARN) associated with the managed node group.
    id string
    labels {[key: string]: string}
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    launchTemplate NodegroupLaunchTemplateSpecification
    An object representing a node group's launch template specification.
    nodeRepairConfig NodegroupNodeRepairConfig
    The node auto repair configuration for node group.
    releaseVersion string
    The AMI version of the Amazon EKS-optimized AMI to use with your node group.
    scalingConfig NodegroupScalingConfig
    The scaling configuration details for the Auto Scaling group that is created for your node group.
    tags {[key: string]: string}
    The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
    taints NodegroupTaint[]
    The Kubernetes taints to be applied to the nodes in the node group when they are created.
    updateConfig NodegroupUpdateConfig
    The node group update configuration.
    version string
    The Kubernetes version to use for your managed nodes.
    arn str
    The Amazon Resource Name (ARN) associated with the managed node group.
    id str
    labels Mapping[str, str]
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    launch_template NodegroupLaunchTemplateSpecification
    An object representing a node group's launch template specification.
    node_repair_config NodegroupNodeRepairConfig
    The node auto repair configuration for node group.
    release_version str
    The AMI version of the Amazon EKS-optimized AMI to use with your node group.
    scaling_config NodegroupScalingConfig
    The scaling configuration details for the Auto Scaling group that is created for your node group.
    tags Mapping[str, str]
    The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
    taints Sequence[NodegroupTaint]
    The Kubernetes taints to be applied to the nodes in the node group when they are created.
    update_config NodegroupUpdateConfig
    The node group update configuration.
    version str
    The Kubernetes version to use for your managed nodes.
    arn String
    The Amazon Resource Name (ARN) associated with the managed node group.
    id String
    labels Map<String>
    The Kubernetes labels to be applied to the nodes in the node group when they are created.
    launchTemplate Property Map
    An object representing a node group's launch template specification.
    nodeRepairConfig Property Map
    The node auto repair configuration for node group.
    releaseVersion String
    The AMI version of the Amazon EKS-optimized AMI to use with your node group.
    scalingConfig Property Map
    The scaling configuration details for the Auto Scaling group that is created for your node group.
    tags Map<String>
    The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.
    taints List<Property Map>
    The Kubernetes taints to be applied to the nodes in the node group when they are created.
    updateConfig Property Map
    The node group update configuration.
    version String
    The Kubernetes version to use for your managed nodes.

    Supporting Types

    NodegroupLaunchTemplateSpecification

    Id string

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.

    Name string

    The name of the launch template.

    You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.

    Version string
    The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.
    Id string

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.

    Name string

    The name of the launch template.

    You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.

    Version string
    The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.
    id String

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.

    name String

    The name of the launch template.

    You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.

    version String
    The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.
    id string

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.

    name string

    The name of the launch template.

    You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.

    version string
    The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.
    id str

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.

    name str

    The name of the launch template.

    You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.

    version str
    The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.
    id String

    The ID of the launch template.

    You must specify either the launch template ID or the launch template name in the request, but not both. After node group creation, you cannot use a different ID.

    name String

    The name of the launch template.

    You must specify either the launch template name or the launch template ID in the request, but not both. After node group creation, you cannot use a different name.

    version String
    The version number of the launch template to use. If no version is specified, then the template's default version is used. You can use a different version for node group updates.

    NodegroupNodeRepairConfig

    Enabled bool
    Set this value to true to enable node auto repair for the node group.
    Enabled bool
    Set this value to true to enable node auto repair for the node group.
    enabled Boolean
    Set this value to true to enable node auto repair for the node group.
    enabled boolean
    Set this value to true to enable node auto repair for the node group.
    enabled bool
    Set this value to true to enable node auto repair for the node group.
    enabled Boolean
    Set this value to true to enable node auto repair for the node group.

    NodegroupScalingConfig

    DesiredSize int

    The current number of nodes that the managed node group should maintain.

    If you use the Kubernetes Cluster Autoscaler , you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

    Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

    This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize .

    MaxSize int
    The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
    MinSize int
    The minimum number of nodes that the managed node group can scale in to.
    DesiredSize int

    The current number of nodes that the managed node group should maintain.

    If you use the Kubernetes Cluster Autoscaler , you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

    Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

    This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize .

    MaxSize int
    The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
    MinSize int
    The minimum number of nodes that the managed node group can scale in to.
    desiredSize Integer

    The current number of nodes that the managed node group should maintain.

    If you use the Kubernetes Cluster Autoscaler , you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

    Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

    This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize .

    maxSize Integer
    The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
    minSize Integer
    The minimum number of nodes that the managed node group can scale in to.
    desiredSize number

    The current number of nodes that the managed node group should maintain.

    If you use the Kubernetes Cluster Autoscaler , you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

    Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

    This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize .

    maxSize number
    The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
    minSize number
    The minimum number of nodes that the managed node group can scale in to.
    desired_size int

    The current number of nodes that the managed node group should maintain.

    If you use the Kubernetes Cluster Autoscaler , you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

    Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

    This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize .

    max_size int
    The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
    min_size int
    The minimum number of nodes that the managed node group can scale in to.
    desiredSize Number

    The current number of nodes that the managed node group should maintain.

    If you use the Kubernetes Cluster Autoscaler , you shouldn't change the desiredSize value directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale down.

    Whenever this parameter changes, the number of worker nodes in the node group is updated to the specified size. If this parameter is given a value that is smaller than the current number of running worker nodes, the necessary number of worker nodes are terminated to match the given value. When using CloudFormation, no action occurs if you remove this parameter from your CFN template.

    This parameter can be different from minSize in some cases, such as when starting with extra hosts for testing. This parameter can also be different when you want to start with an estimated number of needed hosts, but let the Cluster Autoscaler reduce the number if there are too many. When the Cluster Autoscaler is used, the desiredSize parameter is altered by the Cluster Autoscaler (but can be out-of-date for short periods of time). the Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than maxSize .

    maxSize Number
    The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide .
    minSize Number
    The minimum number of nodes that the managed node group can scale in to.

    NodegroupTaint

    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.

    NodegroupUpdateConfig

    MaxUnavailable double
    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    MaxUnavailablePercentage double
    The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
    UpdateStrategy string
    The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action.
    MaxUnavailable float64
    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    MaxUnavailablePercentage float64
    The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
    UpdateStrategy string
    The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action.
    maxUnavailable Double
    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    maxUnavailablePercentage Double
    The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
    updateStrategy String
    The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action.
    maxUnavailable number
    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    maxUnavailablePercentage number
    The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
    updateStrategy string
    The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action.
    max_unavailable float
    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    max_unavailable_percentage float
    The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
    update_strategy str
    The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action.
    maxUnavailable Number
    The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.
    maxUnavailablePercentage Number
    The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
    updateStrategy String
    The configuration for the behavior to follow during an node group version update of this managed node group. You choose between two possible strategies for replacing nodes during an UpdateNodegroupVersion action.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native