@pulumi/aws/eks/getNodeGroup.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Retrieve information about an EKS Node Group.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.eks.getNodeGroup({
 *     clusterName: "example",
 *     nodeGroupName: "example",
 * });
 * ```
 */
export declare function getNodeGroup(args: GetNodeGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetNodeGroupResult>;
/**
 * A collection of arguments for invoking getNodeGroup.
 */
export interface GetNodeGroupArgs {
    /**
     * Name of the cluster.
     */
    clusterName: string;
    /**
     * Name of the node group.
     */
    nodeGroupName: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Key-value map of resource tags.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getNodeGroup.
 */
export interface GetNodeGroupResult {
    /**
     * Type of Amazon Machine Image (AMI) associated with the EKS Node Group.
     */
    readonly amiType: string;
    /**
     * ARN of the EKS Node Group.
     */
    readonly arn: string;
    /**
     * Type of capacity associated with the EKS Node Group. Valid values: `ON_DEMAND`, `SPOT`.
     */
    readonly capacityType: string;
    readonly clusterName: string;
    /**
     * Disk size in GiB for worker nodes.
     */
    readonly diskSize: number;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Set of instance types associated with the EKS Node Group.
     */
    readonly instanceTypes: 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.
     */
    readonly labels: {
        [key: string]: string;
    };
    /**
     * Nested attribute containing information about the launch template used to create the EKS Node Group.
     */
    readonly launchTemplates: outputs.eks.GetNodeGroupLaunchTemplate[];
    readonly nodeGroupName: string;
    /**
     * ARN of the IAM Role that provides permissions for the EKS Node Group.
     */
    readonly nodeRoleArn: string;
    readonly region: string;
    /**
     * AMI version of the EKS Node Group.
     */
    readonly releaseVersion: string;
    /**
     * Configuration block with remote access settings.
     */
    readonly remoteAccesses: outputs.eks.GetNodeGroupRemoteAccess[];
    /**
     * List of objects containing information about underlying resources.
     */
    readonly resources: outputs.eks.GetNodeGroupResource[];
    /**
     * Configuration block with scaling settings.
     */
    readonly scalingConfigs: outputs.eks.GetNodeGroupScalingConfig[];
    /**
     * Status of the EKS Node Group.
     */
    readonly status: string;
    /**
     * Identifiers of EC2 Subnets to associate with the EKS Node Group.
     */
    readonly subnetIds: string[];
    /**
     * Key-value map of resource tags.
     */
    readonly tags: {
        [key: string]: string;
    };
    /**
     * List of objects containing information about taints applied to the nodes in the EKS Node Group.
     */
    readonly taints: outputs.eks.GetNodeGroupTaint[];
    /**
     * Kubernetes version.
     */
    readonly version: string;
}
/**
 * Retrieve information about an EKS Node Group.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.eks.getNodeGroup({
 *     clusterName: "example",
 *     nodeGroupName: "example",
 * });
 * ```
 */
export declare function getNodeGroupOutput(args: GetNodeGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNodeGroupResult>;
/**
 * A collection of arguments for invoking getNodeGroup.
 */
export interface GetNodeGroupOutputArgs {
    /**
     * Name of the cluster.
     */
    clusterName: pulumi.Input<string>;
    /**
     * Name of the node group.
     */
    nodeGroupName: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Key-value map of resource tags.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}