GetInstanceGroup

Get a Compute Instance Group within GCE. For more information, see the official documentation and API

Using GetInstanceGroup

function getInstanceGroup(args: GetInstanceGroupArgs, opts?: InvokeOptions): Promise<GetInstanceGroupResult>

function  get_instance_group(name=None, project=None, self_link=None, zone=None, opts=None)

func LookupInstanceGroup(ctx *Context, args *LookupInstanceGroupArgs, opts ...InvokeOption) (*LookupInstanceGroupResult, error)

Note: This function is named LookupInstanceGroup in the Go SDK.

public static class GetInstanceGroup {
    public static Task<GetInstanceGroupResult> InvokeAsync(GetInstanceGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the instance group. Either name or self_link must be provided.
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 self link of the instance group. Either name or self_link must be provided.
Zone string: The zone of the instance group. If referencing the instance group by name and zone is not provided, the provider zone is used.

Name string: The name of the instance group. Either name or self_link must be provided.
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 self link of the instance group. Either name or self_link must be provided.
Zone string: The zone of the instance group. If referencing the instance group by name and zone is not provided, the provider zone is used.

name string: The name of the instance group. Either name or self_link must be provided.
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 self link of the instance group. Either name or self_link must be provided.
zone string: The zone of the instance group. If referencing the instance group by name and zone is not provided, the provider zone is used.

name str: The name of the instance group. Either name or self_link must be provided.
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 self link of the instance group. Either name or self_link must be provided.
zone str: The zone of the instance group. If referencing the instance group by name and zone is not provided, the provider zone is used.

GetInstanceGroup Result

The following output properties are available:

Description string: Textual description of the instance group.
Id string: The provider-assigned unique ID for this managed resource.
Instances List<string>: List of instances in the group.
NamedPorts List<GetInstanceGroupNamedPort>: List of named ports in the group.
Network string: The URL of the network the instance group is in.
Project string
SelfLink string: The URI of the resource.
Size int: The number of instances in the group.
Zone string
Name string

Description string: Textual description of the instance group.
Id string: The provider-assigned unique ID for this managed resource.
Instances []string: List of instances in the group.
NamedPorts []GetInstanceGroupNamedPortType: List of named ports in the group.
Network string: The URL of the network the instance group is in.
Project string
SelfLink string: The URI of the resource.
Size int: The number of instances in the group.
Zone string
Name string

description string: Textual description of the instance group.
id string: The provider-assigned unique ID for this managed resource.
instances string[]: List of instances in the group.
namedPorts GetInstanceGroupNamedPort[]: List of named ports in the group.
network string: The URL of the network the instance group is in.
project string
selfLink string: The URI of the resource.
size number: The number of instances in the group.
zone string
name string

description str: Textual description of the instance group.
id str: The provider-assigned unique ID for this managed resource.
instances List[str]: List of instances in the group.
named_ports List[GetInstanceGroupNamedPort]: List of named ports in the group.
network str: The URL of the network the instance group is in.
project str
self_link str: The URI of the resource.
size float: The number of instances in the group.
zone str
name str

Supporting Types

GetInstanceGroupNamedPort

See the output API doc for this type.

Name string: The name of the instance group. Either name or self_link must be provided.
Port int

Name string: The name of the instance group. Either name or self_link must be provided.
Port int

name string: The name of the instance group. Either name or self_link must be provided.
port number

name str: The name of the instance group. Either name or self_link must be provided.
port float

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

GetInstanceGroup

Using GetInstanceGroup

GetInstanceGroup Result

Supporting Types

GetInstanceGroupNamedPort

Package Details

On This Page