InstanceGroup

Creates a group of dissimilar Compute Engine virtual machine instances. For more information, see the official documentation and API

Create a InstanceGroup Resource

new InstanceGroup(name: string, args?: InstanceGroupArgs, opts?: CustomResourceOptions);

def InstanceGroup(resource_name, opts=None, description=None, instances=None, name=None, named_ports=None, network=None, project=None, zone=None, __props__=None);

func NewInstanceGroup(ctx *Context, name string, args *InstanceGroupArgs, opts ...ResourceOption) (*InstanceGroup, error)

public InstanceGroup(string name, InstanceGroupArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InstanceGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args InstanceGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

InstanceGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The InstanceGroup resource accepts the following input properties:

Description string: An optional textual description of the instance group.
Instances List<string>: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
Name string: The name which the port will be mapped to.
NamedPorts List<InstanceGroupNamedPortArgs>: The named port configuration. See the section below for details on configuration.
Network string: 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).
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: The zone that this instance group should be created in.

Description string: An optional textual description of the instance group.
Instances []string: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
Name string: The name which the port will be mapped to.
NamedPorts []InstanceGroupNamedPortType: The named port configuration. See the section below for details on configuration.
Network string: 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).
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Zone string: The zone that this instance group should be created in.

description string: An optional textual description of the instance group.
instances string[]: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
name string: The name which the port will be mapped to.
namedPorts InstanceGroupNamedPort[]: The named port configuration. See the section below for details on configuration.
network string: 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).
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone string: The zone that this instance group should be created in.

description str: An optional textual description of the instance group.
instances List[str]: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
name str: The name which the port will be mapped to.
named_ports List[InstanceGroupNamedPort]: The named port configuration. See the section below for details on configuration.
network str: 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).
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
zone str: The zone that this instance group should be created in.

Outputs

All input properties are implicitly available as output properties. Additionally, the InstanceGroup resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
Size int: The number of instances in the group.

Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
Size int: The number of instances in the group.

id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.
size number: The number of instances in the group.

id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.
size float: The number of instances in the group.

Look up an Existing InstanceGroup Resource

Get an existing InstanceGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InstanceGroupState, opts?: CustomResourceOptions): InstanceGroup

static get(resource_name, id, opts=None, description=None, instances=None, name=None, named_ports=None, network=None, project=None, self_link=None, size=None, zone=None, __props__=None);

func GetInstanceGroup(ctx *Context, name string, id IDInput, state *InstanceGroupState, opts ...ResourceOption) (*InstanceGroup, error)

public static InstanceGroup Get(string name, Input<string> id, InstanceGroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Description string: An optional textual description of the instance group.
Instances List<string>: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
Name string: The name which the port will be mapped to.
NamedPorts List<InstanceGroupNamedPortArgs>: The named port configuration. See the section below for details on configuration.
Network string: 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).
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Size int: The number of instances in the group.
Zone string: The zone that this instance group should be created in.

Description string: An optional textual description of the instance group.
Instances []string: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
Name string: The name which the port will be mapped to.
NamedPorts []InstanceGroupNamedPortType: The named port configuration. See the section below for details on configuration.
Network string: 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).
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
Size int: The number of instances in the group.
Zone string: The zone that this instance group should be created in.

description string: An optional textual description of the instance group.
instances string[]: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
name string: The name which the port will be mapped to.
namedPorts InstanceGroupNamedPort[]: The named port configuration. See the section below for details on configuration.
network string: 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).
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
selfLink string: The URI of the created resource.
size number: The number of instances in the group.
zone string: The zone that this instance group should be created in.

description str: An optional textual description of the instance group.
instances List[str]: List of instances in the group. They should be given as either self_link or id. When adding instances they must all be in the same network and zone as the instance group.
name str: The name which the port will be mapped to.
named_ports List[InstanceGroupNamedPort]: The named port configuration. See the section below for details on configuration.
network str: 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).
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
self_link str: The URI of the created resource.
size float: The number of instances in the group.
zone str: The zone that this instance group should be created in.

Supporting Types

InstanceGroupNamedPort

See the input and output API doc for this type.

Name string: The name which the port will be mapped to.
Port int: The port number to map the name to.

Name string: The name which the port will be mapped to.
Port int: The port number to map the name to.

name string: The name which the port will be mapped to.
port number: The port number to map the name to.

name str: The name which the port will be mapped to.
port float: The port number to map the name to.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud