InstanceGroupManager(mapping=None, *, ignore_unknown_fields=False, **kwargs)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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
all_instances_config |
google.cloud.compute_v1.types.InstanceGroupManagerAllInstancesConfig
Specifies configuration that overrides the instance template configuration for the group. This field is a member of oneof_ _all_instances_config.
|
auto_healing_policies |
MutableSequence[google.cloud.compute_v1.types.InstanceGroupManagerAutoHealingPolicy]
The autohealing policy for this managed instance group. You can specify only one value. |
base_instance_name |
str
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 <([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\[[0-9]{1,10}\])?)>__
This field is a member of oneof_ _base_instance_name.
|
creation_timestamp |
str
[Output Only] The creation timestamp for this managed instance group in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
|
current_actions |
google.cloud.compute_v1.types.InstanceGroupManagerActionsSummary
[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. This field is a member of oneof_ _current_actions.
|
description |
str
An optional description of this resource. This field is a member of oneof_ _description.
|
distribution_policy |
google.cloud.compute_v1.types.DistributionPolicy
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. This field is a member of oneof_ _distribution_policy.
|
fingerprint |
str
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. This field is a member of oneof_ _fingerprint.
|
id |
int
[Output Only] A unique identifier for this resource type. The server generates this identifier. This field is a member of oneof_ _id.
|
instance_flexibility_policy |
google.cloud.compute_v1.types.InstanceGroupManagerInstanceFlexibilityPolicy
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. This field is a member of oneof_ _instance_flexibility_policy.
|
instance_group |
str
[Output Only] The URL of the Instance Group resource. This field is a member of oneof_ _instance_group.
|
instance_lifecycle_policy |
google.cloud.compute_v1.types.InstanceGroupManagerInstanceLifecyclePolicy
The repair policy for this managed instance group. This field is a member of oneof_ _instance_lifecycle_policy.
|
instance_template |
str
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. This field is a member of oneof_ _instance_template.
|
kind |
str
[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. This field is a member of oneof_ _kind.
|
list_managed_instances_results |
str
Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values. This field is a member of oneof_ _list_managed_instances_results.
|
name |
str
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. This field is a member of oneof_ _name.
|
named_ports |
MutableSequence[google.cloud.compute_v1.types.NamedPort]
[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager. |
region |
str
[Output Only] The URL of the region where the managed instance group resides (for regional resources). This field is a member of oneof_ _region.
|
satisfies_pzi |
bool
[Output Only] Reserved for future use. This field is a member of oneof_ _satisfies_pzi.
|
satisfies_pzs |
bool
[Output Only] Reserved for future use. This field is a member of oneof_ _satisfies_pzs.
|
self_link |
str
[Output Only] The URL for this managed instance group. The server defines this URL. This field is a member of oneof_ _self_link.
|
standby_policy |
google.cloud.compute_v1.types.InstanceGroupManagerStandbyPolicy
Standby policy for stopped and suspended instances. This field is a member of oneof_ _standby_policy.
|
stateful_policy |
google.cloud.compute_v1.types.StatefulPolicy
Stateful configuration for this Instanced Group Manager This field is a member of oneof_ _stateful_policy.
|
status |
google.cloud.compute_v1.types.InstanceGroupManagerStatus
[Output Only] The status of this managed instance group. This field is a member of oneof_ _status.
|
target_pools |
MutableSequence[str]
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. |
target_size |
int
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. This field is a member of oneof_ _target_size.
|
target_stopped_size |
int
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. This field is a member of oneof_ _target_stopped_size.
|
target_suspended_size |
int
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. This field is a member of oneof_ _target_suspended_size.
|
update_policy |
google.cloud.compute_v1.types.InstanceGroupManagerUpdatePolicy
The update policy for this managed instance group. This field is a member of oneof_ _update_policy.
|
versions |
MutableSequence[google.cloud.compute_v1.types.InstanceGroupManagerVersion]
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. |
zone |
str
[Output Only] The URL of a zone where the managed instance group is located (for zonal resources). This field is a member of oneof_ _zone.
|
Classes
ListManagedInstancesResults
ListManagedInstancesResults(value)Pagination behavior of the listManagedInstances API method for this managed instance group.