1. Docs
  2. Reference
  3. API
  4. GCP
  5. compute
  6. RegionInstanceGroupManager

RegionInstanceGroupManager

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. For more information, see the official documentation and API

Note: Use gcp.compute.InstanceGroupManager to create a single-zone instance group manager.

Create a RegionInstanceGroupManager Resource

new RegionInstanceGroupManager(name: string, args: RegionInstanceGroupManagerArgs, opts?: CustomResourceOptions);
def RegionInstanceGroupManager(resource_name, opts=None, auto_healing_policies=None, base_instance_name=None, description=None, distribution_policy_zones=None, name=None, named_ports=None, project=None, region=None, stateful_disks=None, target_pools=None, target_size=None, update_policy=None, versions=None, wait_for_instances=None, __props__=None);
func NewRegionInstanceGroupManager(ctx *Context, name string, args RegionInstanceGroupManagerArgs, opts ...ResourceOption) (*RegionInstanceGroupManager, error)
public RegionInstanceGroupManager(string name, RegionInstanceGroupManagerArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RegionInstanceGroupManagerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RegionInstanceGroupManagerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RegionInstanceGroupManagerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

RegionInstanceGroupManager Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The RegionInstanceGroupManager resource accepts the following input properties:

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

Region string

The region where the managed instance group resides.

Versions List<RegionInstanceGroupManagerVersionArgs>

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

AutoHealingPolicies RegionInstanceGroupManagerAutoHealingPoliciesArgs

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.

Description string

An optional textual description of the instance group manager.

DistributionPolicyZones List<string>

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

Name string
  • Version name.
NamedPorts List<RegionInstanceGroupManagerNamedPortArgs>

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

Project string

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

StatefulDisks List<RegionInstanceGroupManagerStatefulDiskArgs>

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

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

TargetSize int
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
UpdatePolicy RegionInstanceGroupManagerUpdatePolicyArgs

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

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

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

Region string

The region where the managed instance group resides.

Versions []RegionInstanceGroupManagerVersion

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

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

Description string

An optional textual description of the instance group manager.

DistributionPolicyZones []string

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

Name string
  • Version name.
NamedPorts []RegionInstanceGroupManagerNamedPort

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

Project string

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

StatefulDisks []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 update_policy.

TargetPools []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.

TargetSize int
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
UpdatePolicy RegionInstanceGroupManagerUpdatePolicy

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

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

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

region string

The region where the managed instance group resides.

versions RegionInstanceGroupManagerVersion[]

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

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

description string

An optional textual description of the instance group manager.

distributionPolicyZones string[]

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

name string
  • Version name.
namedPorts RegionInstanceGroupManagerNamedPort[]

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

project string

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

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

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

targetSize number
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
updatePolicy RegionInstanceGroupManagerUpdatePolicy

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

waitForInstances boolean

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.

base_instance_name str

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.

region str

The region where the managed instance group resides.

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

auto_healing_policies Dict[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.

description str

An optional textual description of the instance group manager.

distribution_policy_zones List[str]

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

name str
  • Version name.
named_ports List[RegionInstanceGroupManagerNamedPort]

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

project str

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

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

target_pools List[str]

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.

target_size float
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
update_policy Dict[RegionInstanceGroupManagerUpdatePolicy]

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

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

Outputs

All input properties are implicitly available as output properties. Additionally, the RegionInstanceGroupManager resource produces the following output properties:

Fingerprint string

The fingerprint of the instance group manager.

Id string
The provider-assigned unique ID for this managed resource.
InstanceGroup string

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

SelfLink string

The URL of the created resource.

Fingerprint string

The fingerprint of the instance group manager.

Id string
The provider-assigned unique ID for this managed resource.
InstanceGroup string

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

SelfLink string

The URL of the created resource.

fingerprint string

The fingerprint of the instance group manager.

id string
The provider-assigned unique ID for this managed resource.
instanceGroup string

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

selfLink string

The URL of the created resource.

fingerprint str

The fingerprint of the instance group manager.

id str
The provider-assigned unique ID for this managed resource.
instance_group str

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

self_link str

The URL of the created resource.

Look up an Existing RegionInstanceGroupManager Resource

Get an existing RegionInstanceGroupManager resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RegionInstanceGroupManagerState, opts?: CustomResourceOptions): RegionInstanceGroupManager
static get(resource_name, id, opts=None, auto_healing_policies=None, base_instance_name=None, description=None, distribution_policy_zones=None, fingerprint=None, instance_group=None, name=None, named_ports=None, project=None, region=None, self_link=None, stateful_disks=None, target_pools=None, target_size=None, update_policy=None, versions=None, wait_for_instances=None, __props__=None);
func GetRegionInstanceGroupManager(ctx *Context, name string, id IDInput, state *RegionInstanceGroupManagerState, opts ...ResourceOption) (*RegionInstanceGroupManager, error)
public static RegionInstanceGroupManager Get(string name, Input<string> id, RegionInstanceGroupManagerState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoHealingPolicies RegionInstanceGroupManagerAutoHealingPoliciesArgs

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.

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

Description string

An optional textual description of the instance group manager.

DistributionPolicyZones List<string>

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

Fingerprint string

The fingerprint of the instance group manager.

InstanceGroup string

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

Name string
  • Version name.
NamedPorts List<RegionInstanceGroupManagerNamedPortArgs>

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

Project string

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

Region string

The region where the managed instance group resides.

SelfLink string

The URL of the created resource.

StatefulDisks List<RegionInstanceGroupManagerStatefulDiskArgs>

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

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

TargetSize int
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
UpdatePolicy RegionInstanceGroupManagerUpdatePolicyArgs

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

Versions List<RegionInstanceGroupManagerVersionArgs>

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

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

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

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

Description string

An optional textual description of the instance group manager.

DistributionPolicyZones []string

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

Fingerprint string

The fingerprint of the instance group manager.

InstanceGroup string

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

Name string
  • Version name.
NamedPorts []RegionInstanceGroupManagerNamedPort

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

Project string

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

Region string

The region where the managed instance group resides.

SelfLink string

The URL of the created resource.

StatefulDisks []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 update_policy.

TargetPools []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.

TargetSize int
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
UpdatePolicy RegionInstanceGroupManagerUpdatePolicy

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

Versions []RegionInstanceGroupManagerVersion

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

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

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

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

description string

An optional textual description of the instance group manager.

distributionPolicyZones string[]

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

fingerprint string

The fingerprint of the instance group manager.

instanceGroup string

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

name string
  • Version name.
namedPorts RegionInstanceGroupManagerNamedPort[]

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

project string

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

region string

The region where the managed instance group resides.

selfLink string

The URL of the created resource.

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

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

targetSize number
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
updatePolicy RegionInstanceGroupManagerUpdatePolicy

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

versions RegionInstanceGroupManagerVersion[]

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

waitForInstances boolean

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.

auto_healing_policies Dict[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.

base_instance_name str

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.

description str

An optional textual description of the instance group manager.

distribution_policy_zones List[str]

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

fingerprint str

The fingerprint of the instance group manager.

instance_group str

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

name str
  • Version name.
named_ports List[RegionInstanceGroupManagerNamedPort]

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

project str

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

region str

The region where the managed instance group resides.

self_link str

The URL of the created resource.

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

target_pools List[str]

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.

target_size float
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
update_policy Dict[RegionInstanceGroupManagerUpdatePolicy]

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

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

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

Supporting Types

RegionInstanceGroupManagerAutoHealingPolicies

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

HealthCheck string

The health check resource that signals autohealing.

InitialDelaySec int

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600.

HealthCheck string

The health check resource that signals autohealing.

InitialDelaySec int

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600.

healthCheck string

The health check resource that signals autohealing.

initialDelaySec number

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600.

healthCheck str

The health check resource that signals autohealing.

initialDelaySec float

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600.

RegionInstanceGroupManagerNamedPort

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string
  • Version name.
Port int

The port number.

Name string
  • Version name.
Port int

The port number.

name string
  • Version name.
port number

The port number.

name str
  • Version name.
port float

The port number.

RegionInstanceGroupManagerStatefulDisk

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

DeviceName string

, The device name of the disk to be attached.

DeleteRule string

, A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group. The default is NEVER.

DeviceName string

, The device name of the disk to be attached.

DeleteRule string

, A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group. The default is NEVER.

deviceName string

, The device name of the disk to be attached.

deleteRule string

, A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group. The default is NEVER.

device_name str

, The device name of the disk to be attached.

deleteRule str

, A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group. The default is NEVER.

RegionInstanceGroupManagerUpdatePolicy

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

MinimalAction string
  • Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Type string
  • The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
InstanceRedistributionType string
  • The instance redistribution policy for regional managed instance groups. Valid values are: "PROACTIVE", "NONE". If PROACTIVE (default), the group attempts to maintain an even distribution of VM instances across zones in the region. If NONE, proactive redistribution is disabled.
MaxSurgeFixed int

, The maximum number of instances that can be created above the specified targetSize during the update process. Conflicts with max_surge_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

MaxSurgePercent int

, The maximum number of instances(calculated as percentage) that can be created above the specified targetSize during the update process. Conflicts with max_surge_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

MaxUnavailableFixed int

, The maximum number of instances that can be unavailable during the update process. Conflicts with max_unavailable_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

MaxUnavailablePercent int

, The maximum number of instances(calculated as percentage) that can be unavailable during the update process. Conflicts with max_unavailable_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

MinReadySec int

, Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]

MinimalAction string
  • Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
Type string
  • The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
InstanceRedistributionType string
  • The instance redistribution policy for regional managed instance groups. Valid values are: "PROACTIVE", "NONE". If PROACTIVE (default), the group attempts to maintain an even distribution of VM instances across zones in the region. If NONE, proactive redistribution is disabled.
MaxSurgeFixed int

, The maximum number of instances that can be created above the specified targetSize during the update process. Conflicts with max_surge_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

MaxSurgePercent int

, The maximum number of instances(calculated as percentage) that can be created above the specified targetSize during the update process. Conflicts with max_surge_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

MaxUnavailableFixed int

, The maximum number of instances that can be unavailable during the update process. Conflicts with max_unavailable_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

MaxUnavailablePercent int

, The maximum number of instances(calculated as percentage) that can be unavailable during the update process. Conflicts with max_unavailable_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

MinReadySec int

, Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]

minimalAction string
  • Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
type string
  • The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
instanceRedistributionType string
  • The instance redistribution policy for regional managed instance groups. Valid values are: "PROACTIVE", "NONE". If PROACTIVE (default), the group attempts to maintain an even distribution of VM instances across zones in the region. If NONE, proactive redistribution is disabled.
maxSurgeFixed number

, The maximum number of instances that can be created above the specified targetSize during the update process. Conflicts with max_surge_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

maxSurgePercent number

, The maximum number of instances(calculated as percentage) that can be created above the specified targetSize during the update process. Conflicts with max_surge_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

maxUnavailableFixed number

, The maximum number of instances that can be unavailable during the update process. Conflicts with max_unavailable_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

maxUnavailablePercent number

, The maximum number of instances(calculated as percentage) that can be unavailable during the update process. Conflicts with max_unavailable_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

minReadySec number

, Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]

minimal_action str
  • Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.
type str
  • The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).
instanceRedistributionType str
  • The instance redistribution policy for regional managed instance groups. Valid values are: "PROACTIVE", "NONE". If PROACTIVE (default), the group attempts to maintain an even distribution of VM instances across zones in the region. If NONE, proactive redistribution is disabled.
maxSurgeFixed float

, The maximum number of instances that can be created above the specified targetSize during the update process. Conflicts with max_surge_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

maxSurgePercent float

, The maximum number of instances(calculated as percentage) that can be created above the specified targetSize during the update process. Conflicts with max_surge_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

maxUnavailableFixed float

, The maximum number of instances that can be unavailable during the update process. Conflicts with max_unavailable_percent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of max_unavailable_fixed or max_surge_fixed must be greater than 0.

maxUnavailablePercent float

, The maximum number of instances(calculated as percentage) that can be unavailable during the update process. Conflicts with max_unavailable_fixed. Percent value is only allowed for regional managed instance groups with size at least 10.

minReadySec float

, Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]

RegionInstanceGroupManagerVersion

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

InstanceTemplate string
  • The full URL to an instance template from which all new instances of this version will be created.
Name string
  • Version name.
TargetSize RegionInstanceGroupManagerVersionTargetSizeArgs
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
InstanceTemplate string
  • The full URL to an instance template from which all new instances of this version will be created.
Name string
  • Version name.
TargetSize RegionInstanceGroupManagerVersionTargetSize
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
instanceTemplate string
  • The full URL to an instance template from which all new instances of this version will be created.
name string
  • Version name.
targetSize RegionInstanceGroupManagerVersionTargetSize
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
instanceTemplate str
  • The full URL to an instance template from which all new instances of this version will be created.
name str
  • Version name.
target_size Dict[RegionInstanceGroupManagerVersionTargetSize]
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.

RegionInstanceGroupManagerVersionTargetSize

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Fixed int

, The number of instances which are managed for this version. Conflicts with percent.

Percent int

, The number of instances (calculated as percentage) which are managed for this version. Conflicts with fixed. Note that when using percent, rounding will be in favor of explicitly set target_size values; a managed instance group with 2 instances and 2 versions, one of which has a target_size.percent of 60 will create 2 instances of that version.

Fixed int

, The number of instances which are managed for this version. Conflicts with percent.

Percent int

, The number of instances (calculated as percentage) which are managed for this version. Conflicts with fixed. Note that when using percent, rounding will be in favor of explicitly set target_size values; a managed instance group with 2 instances and 2 versions, one of which has a target_size.percent of 60 will create 2 instances of that version.

fixed number

, The number of instances which are managed for this version. Conflicts with percent.

percent number

, The number of instances (calculated as percentage) which are managed for this version. Conflicts with fixed. Note that when using percent, rounding will be in favor of explicitly set target_size values; a managed instance group with 2 instances and 2 versions, one of which has a target_size.percent of 60 will create 2 instances of that version.

fixed float

, The number of instances which are managed for this version. Conflicts with percent.

percent float

, The number of instances (calculated as percentage) which are managed for this version. Conflicts with fixed. Note that when using percent, rounding will be in favor of explicitly set target_size values; a managed instance group with 2 instances and 2 versions, one of which has a target_size.percent of 60 will create 2 instances of that version.

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.