@pulumi/gcp/compute/getInstanceGroup.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Get a Compute Instance Group within GCE.
 * For more information, see [the official documentation](https://cloud.google.com/compute/docs/instance-groups/#unmanaged_instance_groups)
 * and [API](https://cloud.google.com/compute/docs/reference/latest/instanceGroups)
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const all = gcp.compute.getInstanceGroup({
 *     name: "instance-group-name",
 *     zone: "us-central1-a",
 * });
 * ```
 */
export declare function getInstanceGroup(args?: GetInstanceGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceGroupResult>;
/**
 * A collection of arguments for invoking getInstanceGroup.
 */
export interface GetInstanceGroupArgs {
    /**
     * The name of the instance group. Either `name` or `selfLink` must be provided.
     */
    name?: string;
    /**
     * The ID of the project in which the resource belongs. If it
     * is not provided, the provider project is used.
     */
    project?: string;
    /**
     * The self link of the instance group. Either `name` or `selfLink` must be provided.
     */
    selfLink?: string;
    /**
     * The zone of the instance group. If referencing the instance group by name
     * and `zone` is not provided, the provider zone is used.
     */
    zone?: string;
}
/**
 * A collection of values returned by getInstanceGroup.
 */
export interface GetInstanceGroupResult {
    /**
     * Textual description of the instance group.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * List of instances in the group.
     */
    readonly instances: string[];
    readonly name?: string;
    /**
     * List of named ports in the group.
     */
    readonly namedPorts: outputs.compute.GetInstanceGroupNamedPort[];
    /**
     * The URL of the network the instance group is in.
     */
    readonly network: string;
    readonly project: string;
    /**
     * The URI of the resource.
     */
    readonly selfLink: string;
    /**
     * The number of instances in the group.
     */
    readonly size: number;
    readonly zone: string;
}
/**
 * Get a Compute Instance Group within GCE.
 * For more information, see [the official documentation](https://cloud.google.com/compute/docs/instance-groups/#unmanaged_instance_groups)
 * and [API](https://cloud.google.com/compute/docs/reference/latest/instanceGroups)
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const all = gcp.compute.getInstanceGroup({
 *     name: "instance-group-name",
 *     zone: "us-central1-a",
 * });
 * ```
 */
export declare function getInstanceGroupOutput(args?: GetInstanceGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetInstanceGroupResult>;
/**
 * A collection of arguments for invoking getInstanceGroup.
 */
export interface GetInstanceGroupOutputArgs {
    /**
     * The name of the instance group. Either `name` or `selfLink` must be provided.
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs. If it
     * is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The self link of the instance group. Either `name` or `selfLink` must be provided.
     */
    selfLink?: pulumi.Input<string>;
    /**
     * The zone of the instance group. If referencing the instance group by name
     * and `zone` is not provided, the provider zone is used.
     */
    zone?: pulumi.Input<string>;
}