gcp.compute.getInstanceGroupManager

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var igm1 = Gcp.Compute.GetInstanceGroupManager.Invoke(new()
    {
        Name = "my-igm",
        Zone = "us-central1-a",
    });

    var igm2 = Gcp.Compute.GetInstanceGroupManager.Invoke(new()
    {
        SelfLink = "https://www.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instanceGroupManagers/my-igm",
    });

});
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupInstanceGroupManager(ctx, &compute.LookupInstanceGroupManagerArgs{
			Name: pulumi.StringRef("my-igm"),
			Zone: pulumi.StringRef("us-central1-a"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = compute.LookupInstanceGroupManager(ctx, &compute.LookupInstanceGroupManagerArgs{
			SelfLink: pulumi.StringRef("https://www.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instanceGroupManagers/my-igm"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetInstanceGroupManagerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var igm1 = ComputeFunctions.getInstanceGroupManager(GetInstanceGroupManagerArgs.builder()
            .name("my-igm")
            .zone("us-central1-a")
            .build());

        final var igm2 = ComputeFunctions.getInstanceGroupManager(GetInstanceGroupManagerArgs.builder()
            .selfLink("https://www.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instanceGroupManagers/my-igm")
            .build());

    }
}
import pulumi
import pulumi_gcp as gcp

igm1 = gcp.compute.get_instance_group_manager(name="my-igm",
    zone="us-central1-a")
igm2 = gcp.compute.get_instance_group_manager(self_link="https://www.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instanceGroupManagers/my-igm")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const igm1 = gcp.compute.getInstanceGroupManager({
    name: "my-igm",
    zone: "us-central1-a",
});
const igm2 = gcp.compute.getInstanceGroupManager({
    selfLink: "https://www.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instanceGroupManagers/my-igm",
});
variables:
  igm1:
    fn::invoke:
      Function: gcp:compute:getInstanceGroupManager
      Arguments:
        name: my-igm
        zone: us-central1-a
  igm2:
    fn::invoke:
      Function: gcp:compute:getInstanceGroupManager
      Arguments:
        selfLink: https://www.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instanceGroupManagers/my-igm

Using getInstanceGroupManager

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstanceGroupManager(args: GetInstanceGroupManagerArgs, opts?: InvokeOptions): Promise<GetInstanceGroupManagerResult>
function getInstanceGroupManagerOutput(args: GetInstanceGroupManagerOutputArgs, opts?: InvokeOptions): Output<GetInstanceGroupManagerResult>
def get_instance_group_manager(name: Optional[str] = None,
                               project: Optional[str] = None,
                               self_link: Optional[str] = None,
                               zone: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetInstanceGroupManagerResult
def get_instance_group_manager_output(name: Optional[pulumi.Input[str]] = None,
                               project: Optional[pulumi.Input[str]] = None,
                               self_link: Optional[pulumi.Input[str]] = None,
                               zone: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetInstanceGroupManagerResult]
func LookupInstanceGroupManager(ctx *Context, args *LookupInstanceGroupManagerArgs, opts ...InvokeOption) (*LookupInstanceGroupManagerResult, error)
func LookupInstanceGroupManagerOutput(ctx *Context, args *LookupInstanceGroupManagerOutputArgs, opts ...InvokeOption) LookupInstanceGroupManagerResultOutput

> Note: This function is named LookupInstanceGroupManager in the Go SDK.

public static class GetInstanceGroupManager 
{
    public static Task<GetInstanceGroupManagerResult> InvokeAsync(GetInstanceGroupManagerArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceGroupManagerResult> Invoke(GetInstanceGroupManagerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceGroupManagerResult> getInstanceGroupManager(GetInstanceGroupManagerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: gcp:compute/getInstanceGroupManager:getInstanceGroupManager
  arguments:
    # arguments dictionary

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 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.

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.

getInstanceGroupManager Result

The following output properties are available:

AllInstancesConfigs List<GetInstanceGroupManagerAllInstancesConfig>
AutoHealingPolicies List<GetInstanceGroupManagerAutoHealingPolicy>
BaseInstanceName string
Description string
Fingerprint string
Id string

The provider-assigned unique ID for this managed resource.

InstanceGroup string
ListManagedInstancesResults string
NamedPorts List<GetInstanceGroupManagerNamedPort>
Operation string
StatefulDisks List<GetInstanceGroupManagerStatefulDisk>
StatefulExternalIps List<GetInstanceGroupManagerStatefulExternalIp>
StatefulInternalIps List<GetInstanceGroupManagerStatefulInternalIp>
Statuses List<GetInstanceGroupManagerStatus>
TargetPools List<string>
TargetSize int
UpdatePolicies List<GetInstanceGroupManagerUpdatePolicy>
Versions List<GetInstanceGroupManagerVersion>
WaitForInstances bool
WaitForInstancesStatus string
Name string
Project string
SelfLink string
Zone string
AllInstancesConfigs []GetInstanceGroupManagerAllInstancesConfig
AutoHealingPolicies []GetInstanceGroupManagerAutoHealingPolicy
BaseInstanceName string
Description string
Fingerprint string
Id string

The provider-assigned unique ID for this managed resource.

InstanceGroup string
ListManagedInstancesResults string
NamedPorts []GetInstanceGroupManagerNamedPort
Operation string
StatefulDisks []GetInstanceGroupManagerStatefulDisk
StatefulExternalIps []GetInstanceGroupManagerStatefulExternalIp
StatefulInternalIps []GetInstanceGroupManagerStatefulInternalIp
Statuses []GetInstanceGroupManagerStatus
TargetPools []string
TargetSize int
UpdatePolicies []GetInstanceGroupManagerUpdatePolicy
Versions []GetInstanceGroupManagerVersion
WaitForInstances bool
WaitForInstancesStatus string
Name string
Project string
SelfLink string
Zone string
allInstancesConfigs List<GetInstanceGroupManagerAllInstancesConfig>
autoHealingPolicies List<GetInstanceGroupManagerAutoHealingPolicy>
baseInstanceName String
description String
fingerprint String
id String

The provider-assigned unique ID for this managed resource.

instanceGroup String
listManagedInstancesResults String
namedPorts List<GetInstanceGroupManagerNamedPort>
operation String
statefulDisks List<GetInstanceGroupManagerStatefulDisk>
statefulExternalIps List<GetInstanceGroupManagerStatefulExternalIp>
statefulInternalIps List<GetInstanceGroupManagerStatefulInternalIp>
statuses List<GetInstanceGroupManagerStatus>
targetPools List<String>
targetSize Integer
updatePolicies List<GetInstanceGroupManagerUpdatePolicy>
versions List<GetInstanceGroupManagerVersion>
waitForInstances Boolean
waitForInstancesStatus String
name String
project String
selfLink String
zone String
allInstancesConfigs GetInstanceGroupManagerAllInstancesConfig[]
autoHealingPolicies GetInstanceGroupManagerAutoHealingPolicy[]
baseInstanceName string
description string
fingerprint string
id string

The provider-assigned unique ID for this managed resource.

instanceGroup string
listManagedInstancesResults string
namedPorts GetInstanceGroupManagerNamedPort[]
operation string
statefulDisks GetInstanceGroupManagerStatefulDisk[]
statefulExternalIps GetInstanceGroupManagerStatefulExternalIp[]
statefulInternalIps GetInstanceGroupManagerStatefulInternalIp[]
statuses GetInstanceGroupManagerStatus[]
targetPools string[]
targetSize number
updatePolicies GetInstanceGroupManagerUpdatePolicy[]
versions GetInstanceGroupManagerVersion[]
waitForInstances boolean
waitForInstancesStatus string
name string
project string
selfLink string
zone string
all_instances_configs Sequence[GetInstanceGroupManagerAllInstancesConfig]
auto_healing_policies Sequence[GetInstanceGroupManagerAutoHealingPolicy]
base_instance_name str
description str
fingerprint str
id str

The provider-assigned unique ID for this managed resource.

instance_group str
list_managed_instances_results str
named_ports Sequence[GetInstanceGroupManagerNamedPort]
operation str
stateful_disks Sequence[GetInstanceGroupManagerStatefulDisk]
stateful_external_ips Sequence[GetInstanceGroupManagerStatefulExternalIp]
stateful_internal_ips Sequence[GetInstanceGroupManagerStatefulInternalIp]
statuses Sequence[GetInstanceGroupManagerStatus]
target_pools Sequence[str]
target_size int
update_policies Sequence[GetInstanceGroupManagerUpdatePolicy]
versions Sequence[GetInstanceGroupManagerVersion]
wait_for_instances bool
wait_for_instances_status str
name str
project str
self_link str
zone str

Supporting Types

GetInstanceGroupManagerAllInstancesConfig

Labels Dictionary<string, string>
Metadata Dictionary<string, string>
Labels map[string]string
Metadata map[string]string
labels Map<String,String>
metadata Map<String,String>
labels {[key: string]: string}
metadata {[key: string]: string}
labels Mapping[str, str]
metadata Mapping[str, str]
labels Map<String>
metadata Map<String>

GetInstanceGroupManagerAutoHealingPolicy

GetInstanceGroupManagerNamedPort

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 Integer
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 int
name String

The name of the instance group. Either name or self_link must be provided.

port Number

GetInstanceGroupManagerStatefulDisk

DeleteRule string
DeviceName string
DeleteRule string
DeviceName string
deleteRule String
deviceName String
deleteRule string
deviceName string
deleteRule String
deviceName String

GetInstanceGroupManagerStatefulExternalIp

GetInstanceGroupManagerStatefulInternalIp

GetInstanceGroupManagerStatus

GetInstanceGroupManagerStatusAllInstancesConfig

effective Boolean
effective boolean
effective Boolean

GetInstanceGroupManagerStatusStateful

GetInstanceGroupManagerStatusStatefulPerInstanceConfig

allEffective Boolean
allEffective boolean
allEffective Boolean

GetInstanceGroupManagerStatusVersionTarget

isReached Boolean
isReached boolean
isReached Boolean

GetInstanceGroupManagerUpdatePolicy

GetInstanceGroupManagerVersion

InstanceTemplate string
Name string

The name of the instance group. Either name or self_link must be provided.

TargetSizes List<GetInstanceGroupManagerVersionTargetSize>
InstanceTemplate string
Name string

The name of the instance group. Either name or self_link must be provided.

TargetSizes []GetInstanceGroupManagerVersionTargetSize
instanceTemplate String
name String

The name of the instance group. Either name or self_link must be provided.

targetSizes List<GetInstanceGroupManagerVersionTargetSize>
instanceTemplate string
name string

The name of the instance group. Either name or self_link must be provided.

targetSizes GetInstanceGroupManagerVersionTargetSize[]
instance_template str
name str

The name of the instance group. Either name or self_link must be provided.

target_sizes Sequence[GetInstanceGroupManagerVersionTargetSize]
instanceTemplate String
name String

The name of the instance group. Either name or self_link must be provided.

targetSizes List<Property Map>

GetInstanceGroupManagerVersionTargetSize

Fixed int
Percent int
Fixed int
Percent int
fixed Integer
percent Integer
fixed number
percent number
fixed int
percent int
fixed Number
percent Number

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.