RegionInstanceGroupManager class

The Google Compute Engine Regional Instance Group Manager API creates and manages pools of homogeneous Compute Engine virtual machine instances from a common instance template.

To get more information about regionInstanceGroupManagers, see:

• API documentation
• How-to Guides
• Regional Instance Groups Guide

> Note: Use gcp.compute.InstanceGroupManager to create a zonal instance group manager.

Example Usage

With Top Level Instance Template (Google Provider)

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

const autohealing = new gcp.compute.HealthCheck("autohealing", {
    name: "autohealing-health-check",
    checkIntervalSec: 5,
    timeoutSec: 5,
    healthyThreshold: 2,
    unhealthyThreshold: 10,
    httpHealthCheck: {
        requestPath: "/healthz",
        port: 8080,
    },
});
const appserver = new gcp.compute.RegionInstanceGroupManager("appserver", {
    name: "appserver-igm",
    baseInstanceName: "app",
    region: "us-central1",
    distributionPolicyZones: [
        "us-central1-a",
        "us-central1-f",
    ],
    versions: [{
        instanceTemplate: appserverGoogleComputeInstanceTemplate.selfLinkUnique,
    }],
    allInstancesConfig: {
        metadata: {
            metadata_key: "metadata_value",
        },
        labels: {
            label_key: "label_value",
        },
    },
    targetPools: [appserverGoogleComputeTargetPool.id],
    targetSize: 2,
    namedPorts: [{
        name: "custom",
        port: 8888,
    }],
    autoHealingPolicies: {
        healthCheck: autohealing.id,
        initialDelaySec: 300,
    },
});

import pulumi
import pulumi_gcp as gcp

autohealing = gcp.compute.HealthCheck("autohealing",
    name="autohealing-health-check",
    check_interval_sec=5,
    timeout_sec=5,
    healthy_threshold=2,
    unhealthy_threshold=10,
    http_health_check={
        "request_path": "/healthz",
        "port": 8080,
    })
appserver = gcp.compute.RegionInstanceGroupManager("appserver",
    name="appserver-igm",
    base_instance_name="app",
    region="us-central1",
    distribution_policy_zones=[
        "us-central1-a",
        "us-central1-f",
    ],
    versions=[{
        "instance_template": appserver_google_compute_instance_template["selfLinkUnique"],
    }],
    all_instances_config={
        "metadata": {
            "metadata_key": "metadata_value",
        },
        "labels": {
            "label_key": "label_value",
        },
    },
    target_pools=[appserver_google_compute_target_pool["id"]],
    target_size=2,
    named_ports=[{
        "name": "custom",
        "port": 8888,
    }],
    auto_healing_policies={
        "health_check": autohealing.id,
        "initial_delay_sec": 300,
    })

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

return await Deployment.RunAsync(() =>
{
    var autohealing = new Gcp.Compute.HealthCheck("autohealing", new()
    {
        Name = "autohealing-health-check",
        CheckIntervalSec = 5,
        TimeoutSec = 5,
        HealthyThreshold = 2,
        UnhealthyThreshold = 10,
        HttpHealthCheck = new Gcp.Compute.Inputs.HealthCheckHttpHealthCheckArgs
        {
            RequestPath = "/healthz",
            Port = 8080,
        },
    });

    var appserver = new Gcp.Compute.RegionInstanceGroupManager("appserver", new()
    {
        Name = "appserver-igm",
        BaseInstanceName = "app",
        Region = "us-central1",
        DistributionPolicyZones = new[]
        {
            "us-central1-a",
            "us-central1-f",
        },
        Versions = new[]
        {
            new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
            {
                InstanceTemplate = appserverGoogleComputeInstanceTemplate.SelfLinkUnique,
            },
        },
        AllInstancesConfig = new Gcp.Compute.Inputs.RegionInstanceGroupManagerAllInstancesConfigArgs
        {
            Metadata =
            {
                { "metadata_key", "metadata_value" },
            },
            Labels =
            {
                { "label_key", "label_value" },
            },
        },
        TargetPools = new[]
        {
            appserverGoogleComputeTargetPool.Id,
        },
        TargetSize = 2,
        NamedPorts = new[]
        {
            new Gcp.Compute.Inputs.RegionInstanceGroupManagerNamedPortArgs
            {
                Name = "custom",
                Port = 8888,
            },
        },
        AutoHealingPolicies = new Gcp.Compute.Inputs.RegionInstanceGroupManagerAutoHealingPoliciesArgs
        {
            HealthCheck = autohealing.Id,
            InitialDelaySec = 300,
        },
    });

});

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 {
		autohealing, err := compute.NewHealthCheck(ctx, "autohealing", &compute.HealthCheckArgs{
			Name:               pulumi.String("autohealing-health-check"),
			CheckIntervalSec:   pulumi.Int(5),
			TimeoutSec:         pulumi.Int(5),
			HealthyThreshold:   pulumi.Int(2),
			UnhealthyThreshold: pulumi.Int(10),
			HttpHealthCheck: &compute.HealthCheckHttpHealthCheckArgs{
				RequestPath: pulumi.String("/healthz"),
				Port:        pulumi.Int(8080),
			},
		})
		if err != nil {
			return err
		}
		_, err = compute.NewRegionInstanceGroupManager(ctx, "appserver", &compute.RegionInstanceGroupManagerArgs{
			Name:             pulumi.String("appserver-igm"),
			BaseInstanceName: pulumi.String("app"),
			Region:           pulumi.String("us-central1"),
			DistributionPolicyZones: pulumi.StringArray{
				pulumi.String("us-central1-a"),
				pulumi.String("us-central1-f"),
			},
			Versions: compute.RegionInstanceGroupManagerVersionArray{
				&compute.RegionInstanceGroupManagerVersionArgs{
					InstanceTemplate: pulumi.Any(appserverGoogleComputeInstanceTemplate.SelfLinkUnique),
				},
			},
			AllInstancesConfig: &compute.RegionInstanceGroupManagerAllInstancesConfigArgs{
				Metadata: pulumi.StringMap{
					"metadata_key": pulumi.String("metadata_value"),
				},
				Labels: pulumi.StringMap{
					"label_key": pulumi.String("label_value"),
				},
			},
			TargetPools: pulumi.StringArray{
				appserverGoogleComputeTargetPool.Id,
			},
			TargetSize: pulumi.Int(2),
			NamedPorts: compute.RegionInstanceGroupManagerNamedPortArray{
				&compute.RegionInstanceGroupManagerNamedPortArgs{
					Name: pulumi.String("custom"),
					Port: pulumi.Int(8888),
				},
			},
			AutoHealingPolicies: &compute.RegionInstanceGroupManagerAutoHealingPoliciesArgs{
				HealthCheck:     autohealing.ID().ToIDOutput().ToStringOutput(),
				InitialDelaySec: pulumi.Int(300),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_healthcheck" "autohealing" {
  name                = "autohealing-health-check"
  check_interval_sec  = 5
  timeout_sec         = 5
  healthy_threshold   = 2
  unhealthy_threshold = 10 # 50 seconds
  http_health_check = {
    request_path = "/healthz"
    port         = "8080"
  }
}
resource "gcp_compute_regioninstancegroupmanager" "appserver" {
  name                      = "appserver-igm"
  base_instance_name        = "app"
  region                    = "us-central1"
  distribution_policy_zones = ["us-central1-a", "us-central1-f"]
  versions {
    instance_template = appserverGoogleComputeInstanceTemplate.selfLinkUnique
  }
  all_instances_config = {
    metadata = {
      "metadata_key" = "metadata_value"
    }
    labels = {
      "label_key" = "label_value"
    }
  }
  target_pools = [appserverGoogleComputeTargetPool.id]
  target_size  = 2
  named_ports {
    name = "custom"
    port = 8888
  }
  auto_healing_policies = {
    health_check      = gcp_compute_healthcheck.autohealing.id
    initial_delay_sec = 300
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.HealthCheck;
import com.pulumi.gcp.compute.HealthCheckArgs;
import com.pulumi.gcp.compute.inputs.HealthCheckHttpHealthCheckArgs;
import com.pulumi.gcp.compute.RegionInstanceGroupManager;
import com.pulumi.gcp.compute.RegionInstanceGroupManagerArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerVersionArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerAllInstancesConfigArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerNamedPortArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerAutoHealingPoliciesArgs;
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 autohealing = new HealthCheck("autohealing", HealthCheckArgs.builder()
            .name("autohealing-health-check")
            .checkIntervalSec(5)
            .timeoutSec(5)
            .healthyThreshold(2)
            .unhealthyThreshold(10)
            .httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
                .requestPath("/healthz")
                .port(8080)
                .build())
            .build());

        var appserver = new RegionInstanceGroupManager("appserver", RegionInstanceGroupManagerArgs.builder()
            .name("appserver-igm")
            .baseInstanceName("app")
            .region("us-central1")
            .distributionPolicyZones(
                "us-central1-a",
                "us-central1-f")
            .versions(RegionInstanceGroupManagerVersionArgs.builder()
                .instanceTemplate(appserverGoogleComputeInstanceTemplate.get("selfLinkUnique"))
                .build())
            .allInstancesConfig(RegionInstanceGroupManagerAllInstancesConfigArgs.builder()
                .metadata(Map.of("metadata_key", "metadata_value"))
                .labels(Map.of("label_key", "label_value"))
                .build())
            .targetPools(appserverGoogleComputeTargetPool.get("id"))
            .targetSize(2)
            .namedPorts(RegionInstanceGroupManagerNamedPortArgs.builder()
                .name("custom")
                .port(8888)
                .build())
            .autoHealingPolicies(RegionInstanceGroupManagerAutoHealingPoliciesArgs.builder()
                .healthCheck(autohealing.id())
                .initialDelaySec(300)
                .build())
            .build());

    }
}

resources:
  autohealing:
    type: gcp:compute:HealthCheck
    properties:
      name: autohealing-health-check
      checkIntervalSec: 5
      timeoutSec: 5
      healthyThreshold: 2
      unhealthyThreshold: 10 # 50 seconds
      httpHealthCheck:
        requestPath: /healthz
        port: '8080'
  appserver:
    type: gcp:compute:RegionInstanceGroupManager
    properties:
      name: appserver-igm
      baseInstanceName: app
      region: us-central1
      distributionPolicyZones:
        - us-central1-a
        - us-central1-f
      versions:
        - instanceTemplate: ${appserverGoogleComputeInstanceTemplate.selfLinkUnique}
      allInstancesConfig:
        metadata:
          metadata_key: metadata_value
        labels:
          label_key: label_value
      targetPools:
        - ${appserverGoogleComputeTargetPool.id}
      targetSize: 2
      namedPorts:
        - name: custom
          port: 8888
      autoHealingPolicies:
        healthCheck: ${autohealing.id}
        initialDelaySec: 300

With Multiple Versions

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

const appserver = new gcp.compute.RegionInstanceGroupManager("appserver", {
    name: "appserver-igm",
    baseInstanceName: "app",
    region: "us-central1",
    targetSize: 5,
    versions: [
        {
            instanceTemplate: appserverGoogleComputeInstanceTemplate.selfLinkUnique,
        },
        {
            instanceTemplate: appserver_canary.selfLinkUnique,
            targetSize: {
                fixed: 1,
            },
        },
    ],
});

import pulumi
import pulumi_gcp as gcp

appserver = gcp.compute.RegionInstanceGroupManager("appserver",
    name="appserver-igm",
    base_instance_name="app",
    region="us-central1",
    target_size=5,
    versions=[
        {
            "instance_template": appserver_google_compute_instance_template["selfLinkUnique"],
        },
        {
            "instance_template": appserver_canary["selfLinkUnique"],
            "target_size": {
                "fixed": 1,
            },
        },
    ])

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

return await Deployment.RunAsync(() =>
{
    var appserver = new Gcp.Compute.RegionInstanceGroupManager("appserver", new()
    {
        Name = "appserver-igm",
        BaseInstanceName = "app",
        Region = "us-central1",
        TargetSize = 5,
        Versions = new[]
        {
            new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
            {
                InstanceTemplate = appserverGoogleComputeInstanceTemplate.SelfLinkUnique,
            },
            new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
            {
                InstanceTemplate = appserver_canary.SelfLinkUnique,
                TargetSize = new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionTargetSizeArgs
                {
                    Fixed = 1,
                },
            },
        },
    });

});

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 {
		_, err := compute.NewRegionInstanceGroupManager(ctx, "appserver", &compute.RegionInstanceGroupManagerArgs{
			Name:             pulumi.String("appserver-igm"),
			BaseInstanceName: pulumi.String("app"),
			Region:           pulumi.String("us-central1"),
			TargetSize:       pulumi.Int(5),
			Versions: compute.RegionInstanceGroupManagerVersionArray{
				&compute.RegionInstanceGroupManagerVersionArgs{
					InstanceTemplate: pulumi.Any(appserverGoogleComputeInstanceTemplate.SelfLinkUnique),
				},
				&compute.RegionInstanceGroupManagerVersionArgs{
					InstanceTemplate: pulumi.Any(appserver_canary.SelfLinkUnique),
					TargetSize: &compute.RegionInstanceGroupManagerVersionTargetSizeArgs{
						Fixed: pulumi.Int(1),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_regioninstancegroupmanager" "appserver" {
  name               = "appserver-igm"
  base_instance_name = "app"
  region             = "us-central1"
  target_size        = 5
  versions {
    instance_template = appserverGoogleComputeInstanceTemplate.selfLinkUnique
  }
  versions {
    instance_template = appserver-canary.selfLinkUnique
    target_size = {
      fixed = 1
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionInstanceGroupManager;
import com.pulumi.gcp.compute.RegionInstanceGroupManagerArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerVersionArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerVersionTargetSizeArgs;
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 appserver = new RegionInstanceGroupManager("appserver", RegionInstanceGroupManagerArgs.builder()
            .name("appserver-igm")
            .baseInstanceName("app")
            .region("us-central1")
            .targetSize(5)
            .versions(
                RegionInstanceGroupManagerVersionArgs.builder()
                    .instanceTemplate(appserverGoogleComputeInstanceTemplate.get("selfLinkUnique"))
                    .build(),
                RegionInstanceGroupManagerVersionArgs.builder()
                    .instanceTemplate(appserver_canary.get("selfLinkUnique"))
                    .targetSize(RegionInstanceGroupManagerVersionTargetSizeArgs.builder()
                        .fixed(1)
                        .build())
                    .build())
            .build());

    }
}

resources:
  appserver:
    type: gcp:compute:RegionInstanceGroupManager
    properties:
      name: appserver-igm
      baseInstanceName: app
      region: us-central1
      targetSize: 5
      versions:
        - instanceTemplate: ${appserverGoogleComputeInstanceTemplate.selfLinkUnique}
        - instanceTemplate: ${["appserver-canary"].selfLinkUnique}
          targetSize:
            fixed: 1

With Standby Policy (Google Provider)

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

const igm_sr = new gcp.compute.RegionInstanceGroupManager("igm-sr", {
    name: "tf-sr-igm",
    baseInstanceName: "tf-sr-igm-instance",
    region: "us-central1",
    targetSize: 5,
    versions: [{
        instanceTemplate: sr_igm.selfLink,
        name: "primary",
    }],
    standbyPolicy: {
        initialDelaySec: 50,
        mode: "SCALE_OUT_POOL",
    },
    targetSuspendedSize: 1,
    targetStoppedSize: 1,
});

import pulumi
import pulumi_gcp as gcp

igm_sr = gcp.compute.RegionInstanceGroupManager("igm-sr",
    name="tf-sr-igm",
    base_instance_name="tf-sr-igm-instance",
    region="us-central1",
    target_size=5,
    versions=[{
        "instance_template": sr_igm["selfLink"],
        "name": "primary",
    }],
    standby_policy={
        "initial_delay_sec": 50,
        "mode": "SCALE_OUT_POOL",
    },
    target_suspended_size=1,
    target_stopped_size=1)

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

return await Deployment.RunAsync(() =>
{
    var igm_sr = new Gcp.Compute.RegionInstanceGroupManager("igm-sr", new()
    {
        Name = "tf-sr-igm",
        BaseInstanceName = "tf-sr-igm-instance",
        Region = "us-central1",
        TargetSize = 5,
        Versions = new[]
        {
            new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
            {
                InstanceTemplate = sr_igm.SelfLink,
                Name = "primary",
            },
        },
        StandbyPolicy = new Gcp.Compute.Inputs.RegionInstanceGroupManagerStandbyPolicyArgs
        {
            InitialDelaySec = 50,
            Mode = "SCALE_OUT_POOL",
        },
        TargetSuspendedSize = 1,
        TargetStoppedSize = 1,
    });

});

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 {
		_, err := compute.NewRegionInstanceGroupManager(ctx, "igm-sr", &compute.RegionInstanceGroupManagerArgs{
			Name:             pulumi.String("tf-sr-igm"),
			BaseInstanceName: pulumi.String("tf-sr-igm-instance"),
			Region:           pulumi.String("us-central1"),
			TargetSize:       pulumi.Int(5),
			Versions: compute.RegionInstanceGroupManagerVersionArray{
				&compute.RegionInstanceGroupManagerVersionArgs{
					InstanceTemplate: pulumi.Any(sr_igm.SelfLink),
					Name:             pulumi.String("primary"),
				},
			},
			StandbyPolicy: &compute.RegionInstanceGroupManagerStandbyPolicyArgs{
				InitialDelaySec: pulumi.Int(50),
				Mode:            pulumi.String("SCALE_OUT_POOL"),
			},
			TargetSuspendedSize: pulumi.Int(1),
			TargetStoppedSize:   pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_compute_regioninstancegroupmanager" "igm-sr" {
  name               = "tf-sr-igm"
  base_instance_name = "tf-sr-igm-instance"
  region             = "us-central1"
  target_size        = 5
  versions {
    instance_template = sr-igm.selfLink
    name              = "primary"
  }
  standby_policy = {
    initial_delay_sec = 50
    mode              = "SCALE_OUT_POOL"
  }
  target_suspended_size = 1
  target_stopped_size   = 1
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.RegionInstanceGroupManager;
import com.pulumi.gcp.compute.RegionInstanceGroupManagerArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerVersionArgs;
import com.pulumi.gcp.compute.inputs.RegionInstanceGroupManagerStandbyPolicyArgs;
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 igm_sr = new RegionInstanceGroupManager("igm-sr", RegionInstanceGroupManagerArgs.builder()
            .name("tf-sr-igm")
            .baseInstanceName("tf-sr-igm-instance")
            .region("us-central1")
            .targetSize(5)
            .versions(RegionInstanceGroupManagerVersionArgs.builder()
                .instanceTemplate(sr_igm.get("selfLink"))
                .name("primary")
                .build())
            .standbyPolicy(RegionInstanceGroupManagerStandbyPolicyArgs.builder()
                .initialDelaySec(50)
                .mode("SCALE_OUT_POOL")
                .build())
            .targetSuspendedSize(1)
            .targetStoppedSize(1)
            .build());

    }
}

resources:
  igm-sr:
    type: gcp:compute:RegionInstanceGroupManager
    properties:
      name: tf-sr-igm
      baseInstanceName: tf-sr-igm-instance
      region: us-central1
      targetSize: 5
      versions:
        - instanceTemplate: ${["sr-igm"].selfLink}
          name: primary
      standbyPolicy:
        initialDelaySec: 50
        mode: SCALE_OUT_POOL
      targetSuspendedSize: 1
      targetStoppedSize: 1

Import

Instance group managers can be imported using any of these accepted formats:

• {{name}}

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

$ pulumi import gcp:compute/regionInstanceGroupManager:RegionInstanceGroupManager default {{name}}

Constructors

RegionInstanceGroupManager(String name, {RegionInstanceGroupManagerArgs? args, CustomResourceOptions? options})

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

RegionInstanceGroupManager.reference(String urn)

Creates a typed reference to an existing RegionInstanceGroupManager resource.

Properties

allInstancesConfig ↔ Output<RegionInstanceGroupManagerAllInstancesConfig?>

Properties to set on all instances in the group. After setting allInstancesConfig on the group, you must update the group's instances to apply the configuration.

late, final

autoHealingPolicies ↔ Output<RegionInstanceGroupManagerAutoHealingPolicies?>

The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

late, final

baseInstanceName ↔ Output<String>

The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTimestamp ↔ Output<String>

Creation timestamp in RFC3339 text format.

late, final

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

description ↔ Output<String?>

An optional textual description of the instance group manager.

late, final

distributionPolicyTargetShape ↔ Output<String>

The shape to which the group converges either proactively or on resize events (depending on the value set in update_policy.0.instance_redistribution_type). For more information see the official documentation.

late, final

distributionPolicyZones ↔ Output<List<String>>

The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.

late, final

fingerprint ↔ Output<String>

The fingerprint of the instance group manager.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instanceFlexibilityPolicy ↔ Output<RegionInstanceGroupManagerInstanceFlexibilityPolicy?>

The flexibility policy for managed instance group. Instance flexibility allows managed instance group to create VMs from multiple types of machines. Instance flexibility configuration on managed instance group overrides instance template configuration. Structure is documented below.

late, final

instanceGroup ↔ Output<String>

The full URL of the instance group created by the manager.

late, final

instanceGroupManagerId ↔ Output<int>

The unique identifier number for the resource. This identifier is defined by the server.

late, final

instanceLifecyclePolicy ↔ Output<RegionInstanceGroupManagerInstanceLifecyclePolicy>

The instance lifecycle policy for this managed instance group.

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

listManagedInstancesResults ↔ Output<String?>

Pagination behavior of the listManagedInstances API method for this managed instance group. Valid values are: PAGELESS, PAGINATED. If PAGELESS (default), Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response. If PAGINATED, pagination is enabled, maxResults and pageToken query parameters are respected.

late, final

name ↔ Output<String>

The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

late, final

namedPorts ↔ Output<List<RegionInstanceGroupManagerNamedPort>?>

The named port configuration. See the section below for details on configuration.

late, final

params ↔ Output<RegionInstanceGroupManagerParams?>

) Input only additional params for instance group manager creation. Structure is documented below. For more information, see API.

late, final

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

region ↔ Output<String>

The region where the managed instance group resides. If not provided, the provider region is used.

late, final

resourcePolicies ↔ Output<RegionInstanceGroupManagerResourcePolicies?>

Resource policies for this managed instance group. Structure is documented below.

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

selfLink ↔ Output<String>

The URL of the created resource.

late, final

standbyPolicy ↔ Output<RegionInstanceGroupManagerStandbyPolicy>

The standby policy for stopped and suspended instances. Structure is documented below. For more information, see the official documentation.

late, final

statefulDisks ↔ Output<List<RegionInstanceGroupManagerStatefulDisk>?>

Disks created on the instances that will be preserved on instance delete, update, etc. Structure is documented below. For more information see the official documentation. Proactive cross zone instance redistribution must be disabled before you can update stateful disks on existing instance group managers. This can be controlled via the updatePolicy.

late, final

statefulExternalIps ↔ Output<List<RegionInstanceGroupManagerStatefulExternalIp>?>

External network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. Structure is documented below.

late, final

statefulInternalIps ↔ Output<List<RegionInstanceGroupManagerStatefulInternalIp>?>

Internal network IPs assigned to the instances that will be preserved on instance delete, update, etc. This map is keyed with the network interface name. Structure is documented below.

late, final

statuses ↔ Output<List<RegionInstanceGroupManagerStatus>>

The status of this managed instance group.

late, final

targetPools ↔ Output<List<String>?>

The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

late, final

targetSize ↔ Output<int>

The target number of running instances for this managed instance group. This value will fight with autoscaler settings when set, and generally shouldn't be set when using one. If a value is required, such as to specify a creation-time target size for the MIG, lifecycle.ignore_changes can be used to prevent Terraform from modifying the value. Defaults to 0.

late, final

targetSizePolicies ↔ Output<List<RegionInstanceGroupManagerTargetSizePolicy>>

The policy that specifies how the MIG creates its VMs to achieve the target size. Structure is documented below.

late, final

targetStoppedSize ↔ Output<int>

The target number of stopped instances for this managed instance group.

late, final

targetSuspendedSize ↔ Output<int>

The target number of suspended instances for this managed instance group.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updatePolicy ↔ Output<RegionInstanceGroupManagerUpdatePolicy>

The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

late, final

urn ↔ Output<String>

late, final, inherited

versions ↔ Output<List<RegionInstanceGroupManagerVersion>>

Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

late, final

waitForInstances ↔ Output<bool?>

Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, the provider will continue trying until it times out.

late, final

waitForInstancesStatus ↔ Output<String?>

When used with waitForInstances it specifies the status to wait for. When STABLE is specified this resource will wait until the instances are stable before returning. When UPDATED is set, it will wait for the version target to be reached and any per instance configs to be effective as well as all instances to be stable before returning. The possible values are STABLE and UPDATED

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, {RegionInstanceGroupManagerState? state, CustomResourceOptions? options}) → RegionInstanceGroupManager

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