@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
113 lines (112 loc) • 4.18 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get a Compute Region Instance Group within GCE.
* For more information, see [the official documentation](https://cloud.google.com/compute/docs/instance-groups/distributing-instances-with-regional-instance-groups) and [API](https://cloud.google.com/compute/docs/reference/latest/regionInstanceGroups).
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const group = gcp.compute.getRegionInstanceGroup({
* name: "instance-group-name",
* });
* ```
*
* The most common use of this datasource will be to fetch information about the instances inside regional managed instance groups, for instance:
*/
export declare function getRegionInstanceGroup(args?: GetRegionInstanceGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetRegionInstanceGroupResult>;
/**
* A collection of arguments for invoking getRegionInstanceGroup.
*/
export interface GetRegionInstanceGroupArgs {
/**
* The name of the instance group. One of `name` or `selfLink` must be provided.
*/
name?: string;
/**
* The ID of the project in which the resource belongs.
* If `selfLink` is provided, this value is ignored. If neither `selfLink`
* nor `project` are provided, the provider project is used.
*/
project?: string;
/**
* The region in which the resource belongs. If `selfLink`
* is provided, this value is ignored. If neither `selfLink` nor `region` are
* provided, the provider region is used.
*/
region?: string;
/**
* The link to the instance group. One of `name` or `selfLink` must be provided.
*
* - - -
*/
selfLink?: string;
}
/**
* A collection of values returned by getRegionInstanceGroup.
*/
export interface GetRegionInstanceGroupResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* List of instances in the group, as a list of resources, each containing:
*/
readonly instances: outputs.compute.GetRegionInstanceGroupInstance[];
/**
* String port name
*/
readonly name: string;
readonly project: string;
readonly region: string;
readonly selfLink: string;
/**
* The number of instances in the group.
*/
readonly size: number;
}
/**
* Get a Compute Region Instance Group within GCE.
* For more information, see [the official documentation](https://cloud.google.com/compute/docs/instance-groups/distributing-instances-with-regional-instance-groups) and [API](https://cloud.google.com/compute/docs/reference/latest/regionInstanceGroups).
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const group = gcp.compute.getRegionInstanceGroup({
* name: "instance-group-name",
* });
* ```
*
* The most common use of this datasource will be to fetch information about the instances inside regional managed instance groups, for instance:
*/
export declare function getRegionInstanceGroupOutput(args?: GetRegionInstanceGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRegionInstanceGroupResult>;
/**
* A collection of arguments for invoking getRegionInstanceGroup.
*/
export interface GetRegionInstanceGroupOutputArgs {
/**
* The name of the instance group. One of `name` or `selfLink` must be provided.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If `selfLink` is provided, this value is ignored. If neither `selfLink`
* nor `project` are provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The region in which the resource belongs. If `selfLink`
* is provided, this value is ignored. If neither `selfLink` nor `region` are
* provided, the provider region is used.
*/
region?: pulumi.Input<string>;
/**
* The link to the instance group. One of `name` or `selfLink` must be provided.
*
* - - -
*/
selfLink?: pulumi.Input<string>;
}