GetRegionInstanceGroup

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

The most common use of this datasource will be to fetch information about the instances inside regional managed instance groups, for instance:

Using GetRegionInstanceGroup

function getRegionInstanceGroup(args: GetRegionInstanceGroupArgs, opts?: InvokeOptions): Promise<GetRegionInstanceGroupResult>

function  get_region_instance_group(name=None, project=None, region=None, self_link=None, opts=None)

func GetRegionInstanceGroup(ctx *Context, args *GetRegionInstanceGroupArgs, opts ...InvokeOption) (*GetRegionInstanceGroupResult, error)

public static class GetRegionInstanceGroup {
    public static Task<GetRegionInstanceGroupResult> InvokeAsync(GetRegionInstanceGroupArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the instance group. One of name or self_link must be provided.
Project string: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
Region string: The region in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor region are provided, the provider region is used.
SelfLink string: The link to the instance group. One of name or self_link must be provided.

Name string: The name of the instance group. One of name or self_link must be provided.
Project string: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
Region string: The region in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor region are provided, the provider region is used.
SelfLink string: The link to the instance group. One of name or self_link must be provided.

name string: The name of the instance group. One of name or self_link must be provided.
project string: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
region string: The region in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor region are provided, the provider region is used.
selfLink string: The link to the instance group. One of name or self_link must be provided.

name str: The name of the instance group. One of name or self_link must be provided.
project str: The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
region str: The region in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor region are provided, the provider region is used.
self_link str: The link to the instance group. One of name or self_link must be provided.

GetRegionInstanceGroup Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Instances List<GetRegionInstanceGroupInstance>: List of instances in the group, as a list of resources, each containing:
Name string: String port name
Project string
Region string
SelfLink string
Size int: The number of instances in the group.

Id string: The provider-assigned unique ID for this managed resource.
Instances []GetRegionInstanceGroupInstance: List of instances in the group, as a list of resources, each containing:
Name string: String port name
Project string
Region string
SelfLink string
Size int: The number of instances in the group.

id string: The provider-assigned unique ID for this managed resource.
instances GetRegionInstanceGroupInstance[]: List of instances in the group, as a list of resources, each containing:
name string: String port name
project string
region string
selfLink string
size number: The number of instances in the group.

id str: The provider-assigned unique ID for this managed resource.
instances List[GetRegionInstanceGroupInstance]: List of instances in the group, as a list of resources, each containing:
name str: String port name
project str
region str
self_link str
size float: The number of instances in the group.

Supporting Types

GetRegionInstanceGroupInstance

See the output API doc for this type.

Instance string: URL to the instance.
NamedPorts List<GetRegionInstanceGroupInstanceNamedPortArgs>: List of named ports in the group, as a list of resources, each containing:
Status string: String description of current state of the instance.

Instance string: URL to the instance.
NamedPorts []GetRegionInstanceGroupInstanceNamedPort: List of named ports in the group, as a list of resources, each containing:
Status string: String description of current state of the instance.

instance string: URL to the instance.
namedPorts GetRegionInstanceGroupInstanceNamedPort[]: List of named ports in the group, as a list of resources, each containing:
status string: String description of current state of the instance.

instance str: URL to the instance.
named_ports List[GetRegionInstanceGroupInstanceNamedPort]: List of named ports in the group, as a list of resources, each containing:
status str: String description of current state of the instance.

GetRegionInstanceGroupInstanceNamedPort

See the output API doc for this type.

Name string: The name of the instance group. One of name or self_link must be provided.
Port int: Integer port number

Name string: The name of the instance group. One of name or self_link must be provided.
Port int: Integer port number

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

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

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