@pulumi/gcp

import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Creates a group of dissimilar Compute Engine virtual machine instances. * 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) * * ## Example Usage * * ### Empty Instance Group * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const test = new gcp.compute.InstanceGroup("test", { * name: "test", * description: "Test instance group", * zone: "us-central1-a", * network: _default.id, * }); * ``` * * ### Example Usage - With instances and named ports * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const webservers = new gcp.compute.InstanceGroup("webservers", { * name: "webservers", * description: "Test instance group", * instances: [ * test.id, * test2.id, * ], * namedPorts: [ * { * name: "http", * port: 8080, * }, * { * name: "https", * port: 8443, * }, * ], * zone: "us-central1-a", * }); * ``` * * ## Import * * Instance groups can be imported using the `zone` and `name` with an optional `project`, e.g. * * * `projects/{{project_id}}/zones/{{zone}}/instanceGroups/{{instance_group_id}}` * * * `{{project_id}}/{{zone}}/{{instance_group_id}}` * * * `{{zone}}/{{instance_group_id}}` * * When using the `pulumi import` command, instance groups can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/instanceGroup:InstanceGroup default {{zone}}/{{instance_group_id}} * ``` * * ```sh * $ pulumi import gcp:compute/instanceGroup:InstanceGroup default {{project_id}}/{{zone}}/{{instance_group_id}} * ``` * * ```sh * $ pulumi import gcp:compute/instanceGroup:InstanceGroup default projects/{{project_id}}/zones/{{zone}}/instanceGroups/{{instance_group_id}} * ``` */ export declare class InstanceGroup extends pulumi.CustomResource { /** * Get an existing InstanceGroup resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceGroupState, opts?: pulumi.CustomResourceOptions): InstanceGroup; /** * Returns true if the given object is an instance of InstanceGroup. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is InstanceGroup; /** * An optional textual description of the instance * group. */ readonly description: pulumi.Output<string | undefined>; /** * The list of instances in the group, in `selfLink` format. * When adding instances they must all be in the same network and zone as the instance group. */ readonly instances: pulumi.Output<string[]>; /** * The name of the instance group. Must be 1-63 * characters long and comply with * [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Supported characters * include lowercase letters, numbers, and hyphens. */ readonly name: pulumi.Output<string>; /** * The named port configuration. See the section below * for details on configuration. Structure is documented below. */ readonly namedPorts: pulumi.Output<outputs.compute.InstanceGroupNamedPort[] | undefined>; /** * The URL of the network the instance group is in. If * this is different from the network where the instances are in, the creation * fails. Defaults to the network where the instances are in (if neither * `network` nor `instances` is specified, this field will be blank). */ readonly network: pulumi.Output<string>; /** * The ID of the project in which the resource belongs. If it * is not provided, the provider project is used. */ readonly project: pulumi.Output<string>; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output<string>; /** * The number of instances in the group. */ readonly size: pulumi.Output<number>; /** * The zone that this instance group should be created in. * * - - - */ readonly zone: pulumi.Output<string>; /** * Create a InstanceGroup resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: InstanceGroupArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering InstanceGroup resources. */ export interface InstanceGroupState { /** * An optional textual description of the instance * group. */ description?: pulumi.Input<string>; /** * The list of instances in the group, in `selfLink` format. * When adding instances they must all be in the same network and zone as the instance group. */ instances?: pulumi.Input<pulumi.Input<string>[]>; /** * The name of the instance group. Must be 1-63 * characters long and comply with * [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Supported characters * include lowercase letters, numbers, and hyphens. */ name?: pulumi.Input<string>; /** * The named port configuration. See the section below * for details on configuration. Structure is documented below. */ namedPorts?: pulumi.Input<pulumi.Input<inputs.compute.InstanceGroupNamedPort>[]>; /** * The URL of the network the instance group is in. If * this is different from the network where the instances are in, the creation * fails. Defaults to the network where the instances are in (if neither * `network` nor `instances` is specified, this field will be blank). */ network?: 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 URI of the created resource. */ selfLink?: pulumi.Input<string>; /** * The number of instances in the group. */ size?: pulumi.Input<number>; /** * The zone that this instance group should be created in. * * - - - */ zone?: pulumi.Input<string>; } /** * The set of arguments for constructing a InstanceGroup resource. */ export interface InstanceGroupArgs { /** * An optional textual description of the instance * group. */ description?: pulumi.Input<string>; /** * The list of instances in the group, in `selfLink` format. * When adding instances they must all be in the same network and zone as the instance group. */ instances?: pulumi.Input<pulumi.Input<string>[]>; /** * The name of the instance group. Must be 1-63 * characters long and comply with * [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Supported characters * include lowercase letters, numbers, and hyphens. */ name?: pulumi.Input<string>; /** * The named port configuration. See the section below * for details on configuration. Structure is documented below. */ namedPorts?: pulumi.Input<pulumi.Input<inputs.compute.InstanceGroupNamedPort>[]>; /** * The URL of the network the instance group is in. If * this is different from the network where the instances are in, the creation * fails. Defaults to the network where the instances are in (if neither * `network` nor `instances` is specified, this field will be blank). */ network?: 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 zone that this instance group should be created in. * * - - - */ zone?: pulumi.Input<string>; }