Compute Engine v1 API - Class InstanceGroupManager (3.2.0)

Reference documentation and code samples for the Compute Engine v1 API class InstanceGroupManager.

Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource.

Specifies configuration that overrides the instance template configuration for the group.

The autohealing policy for this managed instance group. You can specify only one value.

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.

An optional description of this resource.

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.

Gets whether the "base_instance_name" field is set

Gets whether the "creation_timestamp" field is set

Gets whether the "description" field is set

Gets whether the "fingerprint" field is set

Gets whether the "id" field is set

Gets whether the "instance_group" field is set

Gets whether the "instance_template" field is set

Gets whether the "kind" field is set

Gets whether the "list_managed_instances_results" field is set

Gets whether the "name" field is set

Gets whether the "region" field is set

Gets whether the "satisfies_pzi" field is set

Gets whether the "satisfies_pzs" field is set

Gets whether the "self_link" field is set

Gets whether the "target_size" field is set

Gets whether the "target_stopped_size" field is set

Gets whether the "target_suspended_size" field is set

Gets whether the "zone" field is set

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

[Output Only] The URL of the Instance Group resource.

The repair policy for this managed instance group.

The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.

The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

[Output Only] Reserved for future use.

[Output Only] Reserved for future use.

[Output Only] The URL for this managed instance group. The server defines this URL.

Standby policy for stopped and suspended instances.

Stateful configuration for this Instanced Group Manager

[Output Only] The status of this managed instance group.

The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.

The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.

The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.

The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.

The update policy for this managed instance group.

Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.

[Output Only] The URL of a zone where the managed instance group is located (for zonal resources).