InstanceGroupMembership class

Represents the Instance membership to the Instance Group.

> NOTE You can use this resource instead of the instances field in the gcp.compute.InstanceGroup, however it's not recommended to use it alongside this field. It might cause inconsistencies, as they can end up competing over control.

> NOTE This resource has been added to avoid a situation, where after Instance is recreated, it's removed from Instance Group and it's needed to perform apply twice. To avoid situations like this, please use this resource with the lifecycle replaceTriggeredBy method, with the passed Instance's ID.

To get more information about InstanceGroupMembership, see:

• API documentation
• How-to Guides
• Add instances
• List instances
• Remove instances

Example Usage

Instance Group Membership

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const default_network = new gcp.compute.Network("default-network", {name: "network"});
const default_instance = new gcp.compute.Instance("default-instance", {
    name: "instance",
    machineType: "e2-medium",
    bootDisk: {
        initializeParams: {
            image: "debian-cloud/debian-11",
        },
    },
    networkInterfaces: [{
        network: default_network.name,
    }],
});
const default_instance_group = new gcp.compute.InstanceGroup("default-instance-group", {name: "instance-group"});
const default_ig_membership = new gcp.compute.InstanceGroupMembership("default-ig-membership", {
    instance: default_instance.selfLink,
    instanceGroup: default_instance_group.name,
});

import pulumi
import pulumi_gcp as gcp

default_network = gcp.compute.Network("default-network", name="network")
default_instance = gcp.compute.Instance("default-instance",
    name="instance",
    machine_type="e2-medium",
    boot_disk={
        "initialize_params": {
            "image": "debian-cloud/debian-11",
        },
    },
    network_interfaces=[{
        "network": default_network.name,
    }])
default_instance_group = gcp.compute.InstanceGroup("default-instance-group", name="instance-group")
default_ig_membership = gcp.compute.InstanceGroupMembership("default-ig-membership",
    instance=default_instance.self_link,
    instance_group=default_instance_group.name)

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

return await Deployment.RunAsync(() =>
{
    var default_network = new Gcp.Compute.Network("default-network", new()
    {
        Name = "network",
    });

    var default_instance = new Gcp.Compute.Instance("default-instance", new()
    {
        Name = "instance",
        MachineType = "e2-medium",
        BootDisk = new Gcp.Compute.Inputs.InstanceBootDiskArgs
        {
            InitializeParams = new Gcp.Compute.Inputs.InstanceBootDiskInitializeParamsArgs
            {
                Image = "debian-cloud/debian-11",
            },
        },
        NetworkInterfaces = new[]
        {
            new Gcp.Compute.Inputs.InstanceNetworkInterfaceArgs
            {
                Network = default_network.Name,
            },
        },
    });

    var default_instance_group = new Gcp.Compute.InstanceGroup("default-instance-group", new()
    {
        Name = "instance-group",
    });

    var default_ig_membership = new Gcp.Compute.InstanceGroupMembership("default-ig-membership", new()
    {
        Instance = default_instance.SelfLink,
        InstanceGroup = default_instance_group.Name,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		default_network, err := compute.NewNetwork(ctx, "default-network", &compute.NetworkArgs{
			Name: pulumi.String("network"),
		})
		if err != nil {
			return err
		}
		default_instance, err := compute.NewInstance(ctx, "default-instance", &compute.InstanceArgs{
			Name:        pulumi.String("instance"),
			MachineType: pulumi.String("e2-medium"),
			BootDisk: &compute.InstanceBootDiskArgs{
				InitializeParams: &compute.InstanceBootDiskInitializeParamsArgs{
					Image: pulumi.String("debian-cloud/debian-11"),
				},
			},
			NetworkInterfaces: compute.InstanceNetworkInterfaceArray{
				&compute.InstanceNetworkInterfaceArgs{
					Network: default_network.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		default_instance_group, err := compute.NewInstanceGroup(ctx, "default-instance-group", &compute.InstanceGroupArgs{
			Name: pulumi.String("instance-group"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewInstanceGroupMembership(ctx, "default-ig-membership", &compute.InstanceGroupMembershipArgs{
			Instance:      default_instance.SelfLink,
			InstanceGroup: default_instance_group.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_network" "default-network" {
  name = "network"
}
resource "gcp_compute_instance" "default-instance" {
  name         = "instance"
  machine_type = "e2-medium"
  boot_disk = {
    initialize_params = {
      image = "debian-cloud/debian-11"
    }
  }
  network_interfaces {
    network = gcp_compute_network.default-network.name
  }
}
resource "gcp_compute_instancegroup" "default-instance-group" {
  name = "instance-group"
}
resource "gcp_compute_instancegroupmembership" "default-ig-membership" {
  instance       = gcp_compute_instance.default-instance.self_link
  instance_group = gcp_compute_instancegroup.default-instance-group.name
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.Instance;
import com.pulumi.gcp.compute.InstanceArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskArgs;
import com.pulumi.gcp.compute.inputs.InstanceBootDiskInitializeParamsArgs;
import com.pulumi.gcp.compute.inputs.InstanceNetworkInterfaceArgs;
import com.pulumi.gcp.compute.InstanceGroup;
import com.pulumi.gcp.compute.InstanceGroupArgs;
import com.pulumi.gcp.compute.InstanceGroupMembership;
import com.pulumi.gcp.compute.InstanceGroupMembershipArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var default_network = new Network("default-network", NetworkArgs.builder()
            .name("network")
            .build());

        var default_instance = new Instance("default-instance", InstanceArgs.builder()
            .name("instance")
            .machineType("e2-medium")
            .bootDisk(InstanceBootDiskArgs.builder()
                .initializeParams(InstanceBootDiskInitializeParamsArgs.builder()
                    .image("debian-cloud/debian-11")
                    .build())
                .build())
            .networkInterfaces(InstanceNetworkInterfaceArgs.builder()
                .network(default_network.name())
                .build())
            .build());

        var default_instance_group = new InstanceGroup("default-instance-group", InstanceGroupArgs.builder()
            .name("instance-group")
            .build());

        var default_ig_membership = new InstanceGroupMembership("default-ig-membership", InstanceGroupMembershipArgs.builder()
            .instance(default_instance.selfLink())
            .instanceGroup(default_instance_group.name())
            .build());

    }
}

resources:
  default-network:
    type: gcp:compute:Network
    properties:
      name: network
  default-instance:
    type: gcp:compute:Instance
    properties:
      name: instance
      machineType: e2-medium
      bootDisk:
        initializeParams:
          image: debian-cloud/debian-11
      networkInterfaces:
        - network: ${["default-network"].name}
  default-instance-group:
    type: gcp:compute:InstanceGroup
    properties:
      name: instance-group
  default-ig-membership:
    type: gcp:compute:InstanceGroupMembership
    properties:
      instance: ${["default-instance"].selfLink}
      instanceGroup: ${["default-instance-group"].name}

Import

InstanceGroupMembership can be imported using any of these accepted formats:

• projects/{{project}}/zones/{{zone}}/instanceGroups/{{instance_group}}/{{instance}}
• {{project}}/{{zone}}/{{instance_group}}/{{instance}}
• {{zone}}/{{instance_group}}/{{instance}}
• {{instance_group}}/{{instance}}

When using the pulumi import command, InstanceGroupMembership can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/instanceGroupMembership:InstanceGroupMembership default projects/{{project}}/zones/{{zone}}/instanceGroups/{{instance_group}}/{{instance}}
$ pulumi import gcp:compute/instanceGroupMembership:InstanceGroupMembership default {{project}}/{{zone}}/{{instance_group}}/{{instance}}
$ pulumi import gcp:compute/instanceGroupMembership:InstanceGroupMembership default {{zone}}/{{instance_group}}/{{instance}}
$ pulumi import gcp:compute/instanceGroupMembership:InstanceGroupMembership default {{instance_group}}/{{instance}}

Constructors

InstanceGroupMembership(String name, {InstanceGroupMembershipArgs? args, CustomResourceOptions? options})

Creates a new InstanceGroupMembership. name The Pulumi resource name. args Arguments used to configure this InstanceGroupMembership. The set of arguments for InstanceGroupMembership. options Resource options controlling this resource's behavior.

InstanceGroupMembership.reference(String urn)

Creates a typed reference to an existing InstanceGroupMembership resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instance ↔ Output<String>

An instance being added to the InstanceGroup

late, final

instanceGroup ↔ Output<String>

Represents an Instance Group resource name that the instance belongs to.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

zone ↔ Output<String?>

A reference to the zone where the instance group resides.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {InstanceGroupMembershipState? state, CustomResourceOptions? options}) → InstanceGroupMembership

Gets an existing InstanceGroupMembership resource's state with the given name and id.