gcp.compute.RegionInstanceGroupManager
Explore with Pulumi AI
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
Note: Use gcp.compute.InstanceGroupManager to create a zonal instance group manager.
Example Usage
With Top Level Instance Template (Google
Provider)
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()
{
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()
{
BaseInstanceName = "app",
Region = "us-central1",
DistributionPolicyZones = new[]
{
"us-central1-a",
"us-central1-f",
},
Versions = new[]
{
new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
{
InstanceTemplate = google_compute_instance_template.Appserver.Self_link_unique,
},
},
AllInstancesConfig = new Gcp.Compute.Inputs.RegionInstanceGroupManagerAllInstancesConfigArgs
{
Metadata =
{
{ "metadata_key", "metadata_value" },
},
Labels =
{
{ "label_key", "label_value" },
},
},
TargetPools = new[]
{
google_compute_target_pool.Appserver.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/v7/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{
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{
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(google_compute_instance_template.Appserver.Self_link_unique),
},
},
AllInstancesConfig: &compute.RegionInstanceGroupManagerAllInstancesConfigArgs{
Metadata: pulumi.StringMap{
"metadata_key": pulumi.String("metadata_value"),
},
Labels: pulumi.StringMap{
"label_key": pulumi.String("label_value"),
},
},
TargetPools: pulumi.StringArray{
google_compute_target_pool.Appserver.Id,
},
TargetSize: pulumi.Int(2),
NamedPorts: compute.RegionInstanceGroupManagerNamedPortArray{
&compute.RegionInstanceGroupManagerNamedPortArgs{
Name: pulumi.String("custom"),
Port: pulumi.Int(8888),
},
},
AutoHealingPolicies: &compute.RegionInstanceGroupManagerAutoHealingPoliciesArgs{
HealthCheck: autohealing.ID(),
InitialDelaySec: pulumi.Int(300),
},
})
if err != nil {
return err
}
return nil
})
}
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.List;
import java.util.ArrayList;
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()
.checkIntervalSec(5)
.timeoutSec(5)
.healthyThreshold(2)
.unhealthyThreshold(10)
.httpHealthCheck(HealthCheckHttpHealthCheckArgs.builder()
.requestPath("/healthz")
.port("8080")
.build())
.build());
var appserver = new RegionInstanceGroupManager("appserver", RegionInstanceGroupManagerArgs.builder()
.baseInstanceName("app")
.region("us-central1")
.distributionPolicyZones(
"us-central1-a",
"us-central1-f")
.versions(RegionInstanceGroupManagerVersionArgs.builder()
.instanceTemplate(google_compute_instance_template.appserver().self_link_unique())
.build())
.allInstancesConfig(RegionInstanceGroupManagerAllInstancesConfigArgs.builder()
.metadata(Map.of("metadata_key", "metadata_value"))
.labels(Map.of("label_key", "label_value"))
.build())
.targetPools(google_compute_target_pool.appserver().id())
.targetSize(2)
.namedPorts(RegionInstanceGroupManagerNamedPortArgs.builder()
.name("custom")
.port(8888)
.build())
.autoHealingPolicies(RegionInstanceGroupManagerAutoHealingPoliciesArgs.builder()
.healthCheck(autohealing.id())
.initialDelaySec(300)
.build())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
autohealing = gcp.compute.HealthCheck("autohealing",
check_interval_sec=5,
timeout_sec=5,
healthy_threshold=2,
unhealthy_threshold=10,
http_health_check=gcp.compute.HealthCheckHttpHealthCheckArgs(
request_path="/healthz",
port=8080,
))
appserver = gcp.compute.RegionInstanceGroupManager("appserver",
base_instance_name="app",
region="us-central1",
distribution_policy_zones=[
"us-central1-a",
"us-central1-f",
],
versions=[gcp.compute.RegionInstanceGroupManagerVersionArgs(
instance_template=google_compute_instance_template["appserver"]["self_link_unique"],
)],
all_instances_config=gcp.compute.RegionInstanceGroupManagerAllInstancesConfigArgs(
metadata={
"metadata_key": "metadata_value",
},
labels={
"label_key": "label_value",
},
),
target_pools=[google_compute_target_pool["appserver"]["id"]],
target_size=2,
named_ports=[gcp.compute.RegionInstanceGroupManagerNamedPortArgs(
name="custom",
port=8888,
)],
auto_healing_policies=gcp.compute.RegionInstanceGroupManagerAutoHealingPoliciesArgs(
health_check=autohealing.id,
initial_delay_sec=300,
))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const autohealing = new gcp.compute.HealthCheck("autohealing", {
checkIntervalSec: 5,
timeoutSec: 5,
healthyThreshold: 2,
unhealthyThreshold: 10,
httpHealthCheck: {
requestPath: "/healthz",
port: 8080,
},
});
const appserver = new gcp.compute.RegionInstanceGroupManager("appserver", {
baseInstanceName: "app",
region: "us-central1",
distributionPolicyZones: [
"us-central1-a",
"us-central1-f",
],
versions: [{
instanceTemplate: google_compute_instance_template.appserver.self_link_unique,
}],
allInstancesConfig: {
metadata: {
metadata_key: "metadata_value",
},
labels: {
label_key: "label_value",
},
},
targetPools: [google_compute_target_pool.appserver.id],
targetSize: 2,
namedPorts: [{
name: "custom",
port: 8888,
}],
autoHealingPolicies: {
healthCheck: autohealing.id,
initialDelaySec: 300,
},
});
resources:
autohealing:
type: gcp:compute:HealthCheck
properties:
checkIntervalSec: 5
timeoutSec: 5
healthyThreshold: 2
unhealthyThreshold: 10 # 50 seconds
httpHealthCheck:
requestPath: /healthz
port: '8080'
appserver:
type: gcp:compute:RegionInstanceGroupManager
properties:
baseInstanceName: app
region: us-central1
distributionPolicyZones:
- us-central1-a
- us-central1-f
versions:
- instanceTemplate: ${google_compute_instance_template.appserver.self_link_unique}
allInstancesConfig:
metadata:
metadata_key: metadata_value
labels:
label_key: label_value
targetPools:
- ${google_compute_target_pool.appserver.id}
targetSize: 2
namedPorts:
- name: custom
port: 8888
autoHealingPolicies:
healthCheck: ${autohealing.id}
initialDelaySec: 300
With Multiple Versions
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()
{
BaseInstanceName = "app",
Region = "us-central1",
TargetSize = 5,
Versions = new[]
{
new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
{
InstanceTemplate = google_compute_instance_template.Appserver.Self_link_unique,
},
new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionArgs
{
InstanceTemplate = google_compute_instance_template.Appserver_canary.Self_link_unique,
TargetSize = new Gcp.Compute.Inputs.RegionInstanceGroupManagerVersionTargetSizeArgs
{
Fixed = 1,
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v7/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{
BaseInstanceName: pulumi.String("app"),
Region: pulumi.String("us-central1"),
TargetSize: pulumi.Int(5),
Versions: compute.RegionInstanceGroupManagerVersionArray{
&compute.RegionInstanceGroupManagerVersionArgs{
InstanceTemplate: pulumi.Any(google_compute_instance_template.Appserver.Self_link_unique),
},
&compute.RegionInstanceGroupManagerVersionArgs{
InstanceTemplate: pulumi.Any(google_compute_instance_template.AppserverCanary.Self_link_unique),
TargetSize: &compute.RegionInstanceGroupManagerVersionTargetSizeArgs{
Fixed: pulumi.Int(1),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
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.List;
import java.util.ArrayList;
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()
.baseInstanceName("app")
.region("us-central1")
.targetSize(5)
.versions(
RegionInstanceGroupManagerVersionArgs.builder()
.instanceTemplate(google_compute_instance_template.appserver().self_link_unique())
.build(),
RegionInstanceGroupManagerVersionArgs.builder()
.instanceTemplate(google_compute_instance_template.appserver-canary().self_link_unique())
.targetSize(RegionInstanceGroupManagerVersionTargetSizeArgs.builder()
.fixed(1)
.build())
.build())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
appserver = gcp.compute.RegionInstanceGroupManager("appserver",
base_instance_name="app",
region="us-central1",
target_size=5,
versions=[
gcp.compute.RegionInstanceGroupManagerVersionArgs(
instance_template=google_compute_instance_template["appserver"]["self_link_unique"],
),
gcp.compute.RegionInstanceGroupManagerVersionArgs(
instance_template=google_compute_instance_template["appserver-canary"]["self_link_unique"],
target_size=gcp.compute.RegionInstanceGroupManagerVersionTargetSizeArgs(
fixed=1,
),
),
])
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const appserver = new gcp.compute.RegionInstanceGroupManager("appserver", {
baseInstanceName: "app",
region: "us-central1",
targetSize: 5,
versions: [
{
instanceTemplate: google_compute_instance_template.appserver.self_link_unique,
},
{
instanceTemplate: google_compute_instance_template["appserver-canary"].self_link_unique,
targetSize: {
fixed: 1,
},
},
],
});
resources:
appserver:
type: gcp:compute:RegionInstanceGroupManager
properties:
baseInstanceName: app
region: us-central1
targetSize: 5
versions:
- instanceTemplate: ${google_compute_instance_template.appserver.self_link_unique}
- instanceTemplate: ${google_compute_instance_template"appserver-canary"[%!s(MISSING)].self_link_unique}
targetSize:
fixed: 1
Create RegionInstanceGroupManager Resource
new RegionInstanceGroupManager(name: string, args: RegionInstanceGroupManagerArgs, opts?: CustomResourceOptions);
@overload
def RegionInstanceGroupManager(resource_name: str,
opts: Optional[ResourceOptions] = None,
all_instances_config: Optional[RegionInstanceGroupManagerAllInstancesConfigArgs] = None,
auto_healing_policies: Optional[RegionInstanceGroupManagerAutoHealingPoliciesArgs] = None,
base_instance_name: Optional[str] = None,
description: Optional[str] = None,
distribution_policy_target_shape: Optional[str] = None,
distribution_policy_zones: Optional[Sequence[str]] = None,
instance_lifecycle_policy: Optional[RegionInstanceGroupManagerInstanceLifecyclePolicyArgs] = None,
list_managed_instances_results: Optional[str] = None,
name: Optional[str] = None,
named_ports: Optional[Sequence[RegionInstanceGroupManagerNamedPortArgs]] = None,
project: Optional[str] = None,
region: Optional[str] = None,
stateful_disks: Optional[Sequence[RegionInstanceGroupManagerStatefulDiskArgs]] = None,
stateful_external_ips: Optional[Sequence[RegionInstanceGroupManagerStatefulExternalIpArgs]] = None,
stateful_internal_ips: Optional[Sequence[RegionInstanceGroupManagerStatefulInternalIpArgs]] = None,
target_pools: Optional[Sequence[str]] = None,
target_size: Optional[int] = None,
update_policy: Optional[RegionInstanceGroupManagerUpdatePolicyArgs] = None,
versions: Optional[Sequence[RegionInstanceGroupManagerVersionArgs]] = None,
wait_for_instances: Optional[bool] = None,
wait_for_instances_status: Optional[str] = None)
@overload
def RegionInstanceGroupManager(resource_name: str,
args: RegionInstanceGroupManagerArgs,
opts: Optional[ResourceOptions] = None)
func NewRegionInstanceGroupManager(ctx *Context, name string, args RegionInstanceGroupManagerArgs, opts ...ResourceOption) (*RegionInstanceGroupManager, error)
public RegionInstanceGroupManager(string name, RegionInstanceGroupManagerArgs args, CustomResourceOptions? opts = null)
public RegionInstanceGroupManager(String name, RegionInstanceGroupManagerArgs args)
public RegionInstanceGroupManager(String name, RegionInstanceGroupManagerArgs args, CustomResourceOptions options)
type: gcp:compute:RegionInstanceGroupManager
properties: # The arguments to resource properties.
options: # 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.
- resource_name str
- The unique name of the resource.
- args RegionInstanceGroupManagerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control 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.
- name String
- The unique name of the resource.
- args RegionInstanceGroupManagerArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
The RegionInstanceGroupManager resource accepts the following input properties:
- Base
Instance stringName 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.
- Versions
List<Region
Instance Group Manager Version> Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
- All
Instances RegionConfig Instance Group Manager All Instances Config ) 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.
- Auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies 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.
- Distribution
Policy stringTarget Shape 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.
- Distribution
Policy List<string>Zones The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
- Instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy The instance lifecycle policy for this managed instance group.
- List
Managed stringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- Name 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.
- Named
Ports List<RegionInstance Group Manager Named Port> 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. If not provided, the provider region is used.
- Stateful
Disks List<RegionInstance Group Manager Stateful Disk> 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
.- Stateful
External List<RegionIps Instance Group Manager Stateful External Ip> 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.
- Stateful
Internal List<RegionIps Instance Group Manager Stateful Internal Ip> 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.
- Target
Pools 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.
- Target
Size int The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- Update
Policy RegionInstance Group Manager Update Policy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- Wait
For boolInstances 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.
- Wait
For stringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- Base
Instance stringName 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.
- Versions
[]Region
Instance Group Manager Version Args Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
- All
Instances RegionConfig Instance Group Manager All Instances Config Args ) 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.
- Auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies Args 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.
- Distribution
Policy stringTarget Shape 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.
- Distribution
Policy []stringZones The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
- Instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy Args The instance lifecycle policy for this managed instance group.
- List
Managed stringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- Name 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.
- Named
Ports []RegionInstance Group Manager Named Port Args 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. If not provided, the provider region is used.
- Stateful
Disks []RegionInstance Group Manager Stateful Disk Args 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
.- Stateful
External []RegionIps Instance Group Manager Stateful External Ip Args 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.
- Stateful
Internal []RegionIps Instance Group Manager Stateful Internal Ip Args 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.
- Target
Pools []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.
- Target
Size int The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- Update
Policy RegionInstance Group Manager Update Policy Args The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- Wait
For boolInstances 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.
- Wait
For stringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- base
Instance StringName 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.
- versions
List<Region
Instance Group Manager Version> Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
- all
Instances RegionConfig Instance Group Manager All Instances Config ) 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.
- auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies 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.
- distribution
Policy StringTarget Shape 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.
- distribution
Policy List<String>Zones The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
- instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy The instance lifecycle policy for this managed instance group.
- list
Managed StringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name 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.
- named
Ports List<RegionInstance Group Manager Named Port> 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. If not provided, the provider region is used.
- stateful
Disks List<RegionInstance Group Manager Stateful Disk> 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
.- stateful
External List<RegionIps Instance Group Manager Stateful External Ip> 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.
- stateful
Internal List<RegionIps Instance Group Manager Stateful Internal Ip> 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.
- target
Pools 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.
- target
Size Integer The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update
Policy RegionInstance Group Manager Update Policy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- wait
For BooleanInstances 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.
- wait
For StringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- base
Instance stringName 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.
- versions
Region
Instance Group Manager Version[] Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
- all
Instances RegionConfig Instance Group Manager All Instances Config ) 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.
- auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies 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.
- distribution
Policy stringTarget Shape 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.
- distribution
Policy string[]Zones The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
- instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy The instance lifecycle policy for this managed instance group.
- list
Managed stringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name 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.
- named
Ports RegionInstance Group Manager Named Port[] 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. If not provided, the provider region is used.
- stateful
Disks RegionInstance Group Manager Stateful Disk[] 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
.- stateful
External RegionIps Instance Group Manager Stateful External Ip[] 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.
- stateful
Internal RegionIps Instance Group Manager Stateful Internal Ip[] 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.
- target
Pools 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.
- target
Size number The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update
Policy RegionInstance Group Manager Update Policy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- wait
For booleanInstances 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.
- wait
For stringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- base_
instance_ strname 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.
- versions
Sequence[Region
Instance Group Manager Version Args] Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
- all_
instances_ Regionconfig Instance Group Manager All Instances Config Args ) 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.
- auto_
healing_ Regionpolicies Instance Group Manager Auto Healing Policies Args 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_ strtarget_ shape 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.
- distribution_
policy_ Sequence[str]zones The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
- instance_
lifecycle_ Regionpolicy Instance Group Manager Instance Lifecycle Policy Args The instance lifecycle policy for this managed instance group.
- list_
managed_ strinstances_ results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name str
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.
- named_
ports Sequence[RegionInstance Group Manager Named Port Args] 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. If not provided, the provider region is used.
- stateful_
disks Sequence[RegionInstance Group Manager Stateful Disk Args] 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
.- stateful_
external_ Sequence[Regionips Instance Group Manager Stateful External Ip Args] 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.
- stateful_
internal_ Sequence[Regionips Instance Group Manager Stateful Internal Ip Args] 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.
- target_
pools Sequence[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 int The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update_
policy RegionInstance Group Manager Update Policy Args The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- wait_
for_ boolinstances 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.
- wait_
for_ strinstances_ status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- base
Instance StringName 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.
- versions List<Property Map>
Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
- all
Instances Property MapConfig ) 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.
- auto
Healing Property MapPolicies 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.
- distribution
Policy StringTarget Shape 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.
- distribution
Policy List<String>Zones The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
- instance
Lifecycle Property MapPolicy The instance lifecycle policy for this managed instance group.
- list
Managed StringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name 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.
- named
Ports List<Property Map> 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. If not provided, the provider region is used.
- stateful
Disks List<Property Map> 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
.- stateful
External List<Property Map>Ips 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.
- stateful
Internal List<Property Map>Ips 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.
- target
Pools 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.
- target
Size Number The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update
Policy Property Map The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- wait
For BooleanInstances 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.
- wait
For StringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
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.
- Instance
Group string The full URL of the instance group created by the manager.
- Self
Link string The URL of the created resource.
- Statuses
List<Region
Instance Group Manager Status> The status of this managed instance group.
- Fingerprint string
The fingerprint of the instance group manager.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Group string The full URL of the instance group created by the manager.
- Self
Link string The URL of the created resource.
- Statuses
[]Region
Instance Group Manager Status The status of this managed instance group.
- fingerprint String
The fingerprint of the instance group manager.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Group String The full URL of the instance group created by the manager.
- self
Link String The URL of the created resource.
- statuses
List<Region
Instance Group Manager Status> The status of this managed instance group.
- fingerprint string
The fingerprint of the instance group manager.
- id string
The provider-assigned unique ID for this managed resource.
- instance
Group string The full URL of the instance group created by the manager.
- self
Link string The URL of the created resource.
- statuses
Region
Instance Group Manager Status[] The status of this managed instance group.
- 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.
- statuses
Sequence[Region
Instance Group Manager Status] The status of this managed instance group.
- fingerprint String
The fingerprint of the instance group manager.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Group String The full URL of the instance group created by the manager.
- self
Link String The URL of the created resource.
- statuses List<Property Map>
The status of this managed instance group.
Look up 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
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
all_instances_config: Optional[RegionInstanceGroupManagerAllInstancesConfigArgs] = None,
auto_healing_policies: Optional[RegionInstanceGroupManagerAutoHealingPoliciesArgs] = None,
base_instance_name: Optional[str] = None,
description: Optional[str] = None,
distribution_policy_target_shape: Optional[str] = None,
distribution_policy_zones: Optional[Sequence[str]] = None,
fingerprint: Optional[str] = None,
instance_group: Optional[str] = None,
instance_lifecycle_policy: Optional[RegionInstanceGroupManagerInstanceLifecyclePolicyArgs] = None,
list_managed_instances_results: Optional[str] = None,
name: Optional[str] = None,
named_ports: Optional[Sequence[RegionInstanceGroupManagerNamedPortArgs]] = None,
project: Optional[str] = None,
region: Optional[str] = None,
self_link: Optional[str] = None,
stateful_disks: Optional[Sequence[RegionInstanceGroupManagerStatefulDiskArgs]] = None,
stateful_external_ips: Optional[Sequence[RegionInstanceGroupManagerStatefulExternalIpArgs]] = None,
stateful_internal_ips: Optional[Sequence[RegionInstanceGroupManagerStatefulInternalIpArgs]] = None,
statuses: Optional[Sequence[RegionInstanceGroupManagerStatusArgs]] = None,
target_pools: Optional[Sequence[str]] = None,
target_size: Optional[int] = None,
update_policy: Optional[RegionInstanceGroupManagerUpdatePolicyArgs] = None,
versions: Optional[Sequence[RegionInstanceGroupManagerVersionArgs]] = None,
wait_for_instances: Optional[bool] = None,
wait_for_instances_status: Optional[str] = None) -> RegionInstanceGroupManager
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)
public static RegionInstanceGroupManager get(String name, Output<String> id, RegionInstanceGroupManagerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- 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.
- All
Instances RegionConfig Instance Group Manager All Instances Config ) 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.
- Auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies 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 stringName 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.
- Distribution
Policy stringTarget Shape 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.
- Distribution
Policy List<string>Zones 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.
- Instance
Group string The full URL of the instance group created by the manager.
- Instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy The instance lifecycle policy for this managed instance group.
- List
Managed stringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- Name 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.
- Named
Ports List<RegionInstance Group Manager Named Port> 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. If not provided, the provider region is used.
- Self
Link string The URL of the created resource.
- Stateful
Disks List<RegionInstance Group Manager Stateful Disk> 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
.- Stateful
External List<RegionIps Instance Group Manager Stateful External Ip> 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.
- Stateful
Internal List<RegionIps Instance Group Manager Stateful Internal Ip> 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.
- Statuses
List<Region
Instance Group Manager Status> The status of this managed instance group.
- Target
Pools 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.
- Target
Size int The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- Update
Policy RegionInstance Group Manager Update Policy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- Versions
List<Region
Instance Group Manager Version> 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 boolInstances 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.
- Wait
For stringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- All
Instances RegionConfig Instance Group Manager All Instances Config Args ) 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.
- Auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies Args 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 stringName 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.
- Distribution
Policy stringTarget Shape 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.
- Distribution
Policy []stringZones 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.
- Instance
Group string The full URL of the instance group created by the manager.
- Instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy Args The instance lifecycle policy for this managed instance group.
- List
Managed stringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- Name 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.
- Named
Ports []RegionInstance Group Manager Named Port Args 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. If not provided, the provider region is used.
- Self
Link string The URL of the created resource.
- Stateful
Disks []RegionInstance Group Manager Stateful Disk Args 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
.- Stateful
External []RegionIps Instance Group Manager Stateful External Ip Args 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.
- Stateful
Internal []RegionIps Instance Group Manager Stateful Internal Ip Args 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.
- Statuses
[]Region
Instance Group Manager Status Args The status of this managed instance group.
- Target
Pools []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.
- Target
Size int The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- Update
Policy RegionInstance Group Manager Update Policy Args The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- Versions
[]Region
Instance Group Manager Version Args 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 boolInstances 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.
- Wait
For stringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- all
Instances RegionConfig Instance Group Manager All Instances Config ) 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.
- auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies 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 StringName 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.
- distribution
Policy StringTarget Shape 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.
- distribution
Policy List<String>Zones 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.
- instance
Group String The full URL of the instance group created by the manager.
- instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy The instance lifecycle policy for this managed instance group.
- list
Managed StringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name 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.
- named
Ports List<RegionInstance Group Manager Named Port> 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. If not provided, the provider region is used.
- self
Link String The URL of the created resource.
- stateful
Disks List<RegionInstance Group Manager Stateful Disk> 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
.- stateful
External List<RegionIps Instance Group Manager Stateful External Ip> 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.
- stateful
Internal List<RegionIps Instance Group Manager Stateful Internal Ip> 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.
- statuses
List<Region
Instance Group Manager Status> The status of this managed instance group.
- target
Pools 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.
- target
Size Integer The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update
Policy RegionInstance Group Manager Update Policy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- versions
List<Region
Instance Group Manager Version> 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 BooleanInstances 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.
- wait
For StringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- all
Instances RegionConfig Instance Group Manager All Instances Config ) 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.
- auto
Healing RegionPolicies Instance Group Manager Auto Healing Policies 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 stringName 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.
- distribution
Policy stringTarget Shape 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.
- distribution
Policy string[]Zones 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.
- instance
Group string The full URL of the instance group created by the manager.
- instance
Lifecycle RegionPolicy Instance Group Manager Instance Lifecycle Policy The instance lifecycle policy for this managed instance group.
- list
Managed stringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name 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.
- named
Ports RegionInstance Group Manager Named Port[] 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. If not provided, the provider region is used.
- self
Link string The URL of the created resource.
- stateful
Disks RegionInstance Group Manager Stateful Disk[] 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
.- stateful
External RegionIps Instance Group Manager Stateful External Ip[] 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.
- stateful
Internal RegionIps Instance Group Manager Stateful Internal Ip[] 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.
- statuses
Region
Instance Group Manager Status[] The status of this managed instance group.
- target
Pools 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.
- target
Size number The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update
Policy RegionInstance Group Manager Update Policy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- versions
Region
Instance Group Manager Version[] 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 booleanInstances 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.
- wait
For stringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- all_
instances_ Regionconfig Instance Group Manager All Instances Config Args ) 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.
- auto_
healing_ Regionpolicies Instance Group Manager Auto Healing Policies Args 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_ strname 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_ strtarget_ shape 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.
- distribution_
policy_ Sequence[str]zones 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.
- instance_
lifecycle_ Regionpolicy Instance Group Manager Instance Lifecycle Policy Args The instance lifecycle policy for this managed instance group.
- list_
managed_ strinstances_ results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name str
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.
- named_
ports Sequence[RegionInstance Group Manager Named Port Args] 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. If not provided, the provider region is used.
- self_
link str The URL of the created resource.
- stateful_
disks Sequence[RegionInstance Group Manager Stateful Disk Args] 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
.- stateful_
external_ Sequence[Regionips Instance Group Manager Stateful External Ip Args] 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.
- stateful_
internal_ Sequence[Regionips Instance Group Manager Stateful Internal Ip Args] 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.
- statuses
Sequence[Region
Instance Group Manager Status Args] The status of this managed instance group.
- target_
pools Sequence[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 int The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update_
policy RegionInstance Group Manager Update Policy Args The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- versions
Sequence[Region
Instance Group Manager Version Args] 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_ boolinstances 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.
- wait_
for_ strinstances_ status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
- all
Instances Property MapConfig ) 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.
- auto
Healing Property MapPolicies 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 StringName 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.
- distribution
Policy StringTarget Shape 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.
- distribution
Policy List<String>Zones 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.
- instance
Group String The full URL of the instance group created by the manager.
- instance
Lifecycle Property MapPolicy The instance lifecycle policy for this managed instance group.
- list
Managed StringInstances Results Pagination behavior of the
listManagedInstances
API method for this managed instance group. Valid values are:PAGELESS
,PAGINATED
. IfPAGELESS
(default), Pagination is disabled for the group'slistManagedInstances
API method.maxResults
andpageToken
query parameters are ignored and all instances are returned in a single response. IfPAGINATED
, pagination is enabled,maxResults
andpageToken
query parameters are respected.- name 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.
- named
Ports List<Property Map> 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. If not provided, the provider region is used.
- self
Link String The URL of the created resource.
- stateful
Disks List<Property Map> 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
.- stateful
External List<Property Map>Ips 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.
- stateful
Internal List<Property Map>Ips 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.
- statuses List<Property Map>
The status of this managed instance group.
- target
Pools 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.
- target
Size Number The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.
- update
Policy Property Map The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
- versions List<Property Map>
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 BooleanInstances 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.
- wait
For StringInstances Status When used with
wait_for_instances
it specifies the status to wait for. WhenSTABLE
is specified this resource will wait until the instances are stable before returning. WhenUPDATED
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 areSTABLE
andUPDATED
Supporting Types
RegionInstanceGroupManagerAllInstancesConfig, RegionInstanceGroupManagerAllInstancesConfigArgs
- Labels Dictionary<string, string>
), The label key-value pairs that you want to patch onto the instance.
- Metadata Dictionary<string, string>
), The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.
- Labels map[string]string
), The label key-value pairs that you want to patch onto the instance.
- Metadata map[string]string
), The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.
- labels Map<String,String>
), The label key-value pairs that you want to patch onto the instance.
- metadata Map<String,String>
), The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.
- labels {[key: string]: string}
), The label key-value pairs that you want to patch onto the instance.
- metadata {[key: string]: string}
), The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.
- labels Mapping[str, str]
), The label key-value pairs that you want to patch onto the instance.
- metadata Mapping[str, str]
), The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.
- labels Map<String>
), The label key-value pairs that you want to patch onto the instance.
- metadata Map<String>
), The metadata key-value pairs that you want to patch onto the instance. For more information, see Project and instance metadata.
RegionInstanceGroupManagerAutoHealingPolicies, RegionInstanceGroupManagerAutoHealingPoliciesArgs
- Health
Check string The health check resource that signals autohealing.
- Initial
Delay intSec 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.
- Health
Check string The health check resource that signals autohealing.
- Initial
Delay intSec 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.
- health
Check String The health check resource that signals autohealing.
- initial
Delay IntegerSec 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.
- health
Check string The health check resource that signals autohealing.
- initial
Delay numberSec 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.
- health_
check str The health check resource that signals autohealing.
- initial_
delay_ intsec 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.
- health
Check String The health check resource that signals autohealing.
- initial
Delay NumberSec 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.
RegionInstanceGroupManagerInstanceLifecyclePolicy, RegionInstanceGroupManagerInstanceLifecyclePolicyArgs
- Force
Update stringOn Repair ), Specifies whether to apply the group's latest configuration when repairing a VM. Valid options are: YES, NO. If YES and you updated the group's instance template or per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If NO (default), then updates are applied in accordance with the group's update policy type.
- Force
Update stringOn Repair ), Specifies whether to apply the group's latest configuration when repairing a VM. Valid options are: YES, NO. If YES and you updated the group's instance template or per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If NO (default), then updates are applied in accordance with the group's update policy type.
- force
Update StringOn Repair ), Specifies whether to apply the group's latest configuration when repairing a VM. Valid options are: YES, NO. If YES and you updated the group's instance template or per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If NO (default), then updates are applied in accordance with the group's update policy type.
- force
Update stringOn Repair ), Specifies whether to apply the group's latest configuration when repairing a VM. Valid options are: YES, NO. If YES and you updated the group's instance template or per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If NO (default), then updates are applied in accordance with the group's update policy type.
- force_
update_ stron_ repair ), Specifies whether to apply the group's latest configuration when repairing a VM. Valid options are: YES, NO. If YES and you updated the group's instance template or per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If NO (default), then updates are applied in accordance with the group's update policy type.
- force
Update StringOn Repair ), Specifies whether to apply the group's latest configuration when repairing a VM. Valid options are: YES, NO. If YES and you updated the group's instance template or per-instance configurations after the VM was created, then these changes are applied when VM is repaired. If NO (default), then updates are applied in accordance with the group's update policy type.
RegionInstanceGroupManagerNamedPort, RegionInstanceGroupManagerNamedPortArgs
RegionInstanceGroupManagerStatefulDisk, RegionInstanceGroupManagerStatefulDiskArgs
- Device
Name string , The device name of the disk to be attached.
- Delete
Rule string , A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the disk when the VM is deleted, but do 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 isNEVER
.
- Device
Name string , The device name of the disk to be attached.
- Delete
Rule string , A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the disk when the VM is deleted, but do 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 isNEVER
.
- device
Name String , The device name of the disk to be attached.
- delete
Rule String , A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the disk when the VM is deleted, but do 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 isNEVER
.
- device
Name string , The device name of the disk to be attached.
- delete
Rule string , A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the disk when the VM is deleted, but do 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 isNEVER
.
- device_
name str , The device name of the disk to be attached.
- delete_
rule str , A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the disk when the VM is deleted, but do 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 isNEVER
.
- device
Name String , The device name of the disk to be attached.
- delete
Rule String , A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the disk when the VM is deleted, but do 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 isNEVER
.
RegionInstanceGroupManagerStatefulExternalIp, RegionInstanceGroupManagerStatefulExternalIpArgs
- Delete
Rule string , A value that prescribes what should happen to the external ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the external ip when the VM is permanently deleted from the instance group.- Interface
Name string , The network interface name of the external Ip. Possible value:
nic0
.
- Delete
Rule string , A value that prescribes what should happen to the external ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the external ip when the VM is permanently deleted from the instance group.- Interface
Name string , The network interface name of the external Ip. Possible value:
nic0
.
- delete
Rule String , A value that prescribes what should happen to the external ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the external ip when the VM is permanently deleted from the instance group.- interface
Name String , The network interface name of the external Ip. Possible value:
nic0
.
- delete
Rule string , A value that prescribes what should happen to the external ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the external ip when the VM is permanently deleted from the instance group.- interface
Name string , The network interface name of the external Ip. Possible value:
nic0
.
- delete_
rule str , A value that prescribes what should happen to the external ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the external ip when the VM is permanently deleted from the instance group.- interface_
name str , The network interface name of the external Ip. Possible value:
nic0
.
- delete
Rule String , A value that prescribes what should happen to the external ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the external ip when the VM is permanently deleted from the instance group.- interface
Name String , The network interface name of the external Ip. Possible value:
nic0
.
RegionInstanceGroupManagerStatefulInternalIp, RegionInstanceGroupManagerStatefulInternalIpArgs
- Delete
Rule string , A value that prescribes what should happen to the internal ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the internal ip when the VM is permanently deleted from the instance group.- Interface
Name string , The network interface name of the internal Ip. Possible value:
nic0
.
- Delete
Rule string , A value that prescribes what should happen to the internal ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the internal ip when the VM is permanently deleted from the instance group.- Interface
Name string , The network interface name of the internal Ip. Possible value:
nic0
.
- delete
Rule String , A value that prescribes what should happen to the internal ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the internal ip when the VM is permanently deleted from the instance group.- interface
Name String , The network interface name of the internal Ip. Possible value:
nic0
.
- delete
Rule string , A value that prescribes what should happen to the internal ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the internal ip when the VM is permanently deleted from the instance group.- interface
Name string , The network interface name of the internal Ip. Possible value:
nic0
.
- delete_
rule str , A value that prescribes what should happen to the internal ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the internal ip when the VM is permanently deleted from the instance group.- interface_
name str , The network interface name of the internal Ip. Possible value:
nic0
.
- delete
Rule String , A value that prescribes what should happen to the internal ip when the VM instance is deleted. The available options are
NEVER
andON_PERMANENT_INSTANCE_DELETION
.NEVER
- detach the ip when the VM is deleted, but do not delete the ip.ON_PERMANENT_INSTANCE_DELETION
will delete the internal ip when the VM is permanently deleted from the instance group.- interface
Name String , The network interface name of the internal Ip. Possible value:
nic0
.
RegionInstanceGroupManagerStatus, RegionInstanceGroupManagerStatusArgs
- All
Instances List<RegionConfigs Instance Group Manager Status All Instances Config> ) 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.
- Is
Stable bool A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
- Statefuls
List<Region
Instance Group Manager Status Stateful> Stateful status of the given Instance Group Manager.
- Version
Targets List<RegionInstance Group Manager Status Version Target> A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
- All
Instances []RegionConfigs Instance Group Manager Status All Instances Config ) 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.
- Is
Stable bool A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
- Statefuls
[]Region
Instance Group Manager Status Stateful Stateful status of the given Instance Group Manager.
- Version
Targets []RegionInstance Group Manager Status Version Target A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
- all
Instances List<RegionConfigs Instance Group Manager Status All Instances Config> ) 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.
- is
Stable Boolean A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
- statefuls
List<Region
Instance Group Manager Status Stateful> Stateful status of the given Instance Group Manager.
- version
Targets List<RegionInstance Group Manager Status Version Target> A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
- all
Instances RegionConfigs Instance Group Manager Status All Instances Config[] ) 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.
- is
Stable boolean A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
- statefuls
Region
Instance Group Manager Status Stateful[] Stateful status of the given Instance Group Manager.
- version
Targets RegionInstance Group Manager Status Version Target[] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
- all_
instances_ Sequence[Regionconfigs Instance Group Manager Status All Instances Config] ) 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.
- is_
stable bool A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
- statefuls
Sequence[Region
Instance Group Manager Status Stateful] Stateful status of the given Instance Group Manager.
- version_
targets Sequence[RegionInstance Group Manager Status Version Target] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
- all
Instances List<Property Map>Configs ) 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.
- is
Stable Boolean A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.
- statefuls List<Property Map>
Stateful status of the given Instance Group Manager.
- version
Targets List<Property Map> A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.
RegionInstanceGroupManagerStatusAllInstancesConfig, RegionInstanceGroupManagerStatusAllInstancesConfigArgs
- Effective bool
- Effective bool
- effective Boolean
- effective boolean
- effective bool
- effective Boolean
RegionInstanceGroupManagerStatusStateful, RegionInstanceGroupManagerStatusStatefulArgs
- Has
Stateful boolConfig A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
- Per
Instance List<RegionConfigs Instance Group Manager Status Stateful Per Instance Config> Status of per-instance configs on the instance.
- Has
Stateful boolConfig A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
- Per
Instance []RegionConfigs Instance Group Manager Status Stateful Per Instance Config Status of per-instance configs on the instance.
- has
Stateful BooleanConfig A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
- per
Instance List<RegionConfigs Instance Group Manager Status Stateful Per Instance Config> Status of per-instance configs on the instance.
- has
Stateful booleanConfig A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
- per
Instance RegionConfigs Instance Group Manager Status Stateful Per Instance Config[] Status of per-instance configs on the instance.
- has_
stateful_ boolconfig A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
- per_
instance_ Sequence[Regionconfigs Instance Group Manager Status Stateful Per Instance Config] Status of per-instance configs on the instance.
- has
Stateful BooleanConfig A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful config even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions.
- per
Instance List<Property Map>Configs Status of per-instance configs on the instance.
RegionInstanceGroupManagerStatusStatefulPerInstanceConfig, RegionInstanceGroupManagerStatusStatefulPerInstanceConfigArgs
- All
Effective bool A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status
EFFECTIVE
or there are no per-instance-configs.
- All
Effective bool A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status
EFFECTIVE
or there are no per-instance-configs.
- all
Effective Boolean A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status
EFFECTIVE
or there are no per-instance-configs.
- all
Effective boolean A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status
EFFECTIVE
or there are no per-instance-configs.
- all_
effective bool A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status
EFFECTIVE
or there are no per-instance-configs.
- all
Effective Boolean A bit indicating if all of the group's per-instance configs (listed in the output of a listPerInstanceConfigs API call) have status
EFFECTIVE
or there are no per-instance-configs.
RegionInstanceGroupManagerStatusVersionTarget, RegionInstanceGroupManagerStatusVersionTargetArgs
- Is
Reached bool
- Is
Reached bool
- is
Reached Boolean
- is
Reached boolean
- is_
reached bool
- is
Reached Boolean
RegionInstanceGroupManagerUpdatePolicy, RegionInstanceGroupManagerUpdatePolicyArgs
- Minimal
Action string Minimal action to be taken on an instance. You can specify either
REFRESH
to update without stopping instances,RESTART
to restart existing instances orREPLACE
to delete and create new instances from the target template. If you specify aREFRESH
, 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 orOPPORTUNISTIC
so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).- Instance
Redistribution stringType The instance redistribution policy for regional managed instance groups. Valid values are:
"PROACTIVE"
,"NONE"
. IfPROACTIVE
(default), the group attempts to maintain an even distribution of VM instances across zones in the region. IfNONE
, proactive redistribution is disabled.- Max
Surge intFixed , 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- Max
Surge intPercent , 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.- 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- 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.- Min
Ready intSec ), Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]
- Most
Disruptive stringAllowed Action Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
- Replacement
Method string , The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0.
- Minimal
Action string Minimal action to be taken on an instance. You can specify either
REFRESH
to update without stopping instances,RESTART
to restart existing instances orREPLACE
to delete and create new instances from the target template. If you specify aREFRESH
, 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 orOPPORTUNISTIC
so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).- Instance
Redistribution stringType The instance redistribution policy for regional managed instance groups. Valid values are:
"PROACTIVE"
,"NONE"
. IfPROACTIVE
(default), the group attempts to maintain an even distribution of VM instances across zones in the region. IfNONE
, proactive redistribution is disabled.- Max
Surge intFixed , 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- Max
Surge intPercent , 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.- 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- 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.- Min
Ready intSec ), Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]
- Most
Disruptive stringAllowed Action Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
- Replacement
Method string , The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0.
- minimal
Action String Minimal action to be taken on an instance. You can specify either
REFRESH
to update without stopping instances,RESTART
to restart existing instances orREPLACE
to delete and create new instances from the target template. If you specify aREFRESH
, 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 orOPPORTUNISTIC
so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).- instance
Redistribution StringType The instance redistribution policy for regional managed instance groups. Valid values are:
"PROACTIVE"
,"NONE"
. IfPROACTIVE
(default), the group attempts to maintain an even distribution of VM instances across zones in the region. IfNONE
, proactive redistribution is disabled.- max
Surge IntegerFixed , 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- max
Surge IntegerPercent , 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.- Integer
, 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- Integer
, 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.- min
Ready IntegerSec ), Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]
- most
Disruptive StringAllowed Action Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
- replacement
Method String , The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0.
- minimal
Action string Minimal action to be taken on an instance. You can specify either
REFRESH
to update without stopping instances,RESTART
to restart existing instances orREPLACE
to delete and create new instances from the target template. If you specify aREFRESH
, 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 orOPPORTUNISTIC
so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).- instance
Redistribution stringType The instance redistribution policy for regional managed instance groups. Valid values are:
"PROACTIVE"
,"NONE"
. IfPROACTIVE
(default), the group attempts to maintain an even distribution of VM instances across zones in the region. IfNONE
, proactive redistribution is disabled.- max
Surge numberFixed , 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- max
Surge numberPercent , 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.- 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- 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.- min
Ready numberSec ), Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]
- most
Disruptive stringAllowed Action Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
- replacement
Method string , The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0.
- minimal_
action str Minimal action to be taken on an instance. You can specify either
REFRESH
to update without stopping instances,RESTART
to restart existing instances orREPLACE
to delete and create new instances from the target template. If you specify aREFRESH
, 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 orOPPORTUNISTIC
so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).- instance_
redistribution_ strtype The instance redistribution policy for regional managed instance groups. Valid values are:
"PROACTIVE"
,"NONE"
. IfPROACTIVE
(default), the group attempts to maintain an even distribution of VM instances across zones in the region. IfNONE
, proactive redistribution is disabled.- max_
surge_ intfixed , 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- max_
surge_ intpercent , 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.- 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- 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.- min_
ready_ intsec ), Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]
- most_
disruptive_ strallowed_ action Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
- replacement_
method str , The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0.
- minimal
Action String Minimal action to be taken on an instance. You can specify either
REFRESH
to update without stopping instances,RESTART
to restart existing instances orREPLACE
to delete and create new instances from the target template. If you specify aREFRESH
, 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 orOPPORTUNISTIC
so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).- instance
Redistribution StringType The instance redistribution policy for regional managed instance groups. Valid values are:
"PROACTIVE"
,"NONE"
. IfPROACTIVE
(default), the group attempts to maintain an even distribution of VM instances across zones in the region. IfNONE
, proactive redistribution is disabled.- max
Surge NumberFixed , 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- max
Surge NumberPercent , 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.- 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 ofmax_unavailable_fixed
ormax_surge_fixed
must be greater than 0.- 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.- min
Ready NumberSec ), Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]
- most
Disruptive StringAllowed Action Most disruptive action that is allowed to be taken on an instance. You can specify either NONE to forbid any actions, REFRESH to allow actions that do not need instance restart, RESTART to allow actions that can be applied without instance replacing or REPLACE to allow all possible actions. If the Updater determines that the minimal update action needed is more disruptive than most disruptive allowed action you specify it will not perform the update at all.
- replacement
Method String , The instance replacement method for managed instance groups. Valid values are: "RECREATE", "SUBSTITUTE". If SUBSTITUTE (default), the group replaces VM instances with new instances that have randomly generated names. If RECREATE, instance names are preserved. You must also set max_unavailable_fixed or max_unavailable_percent to be greater than 0.
RegionInstanceGroupManagerVersion, RegionInstanceGroupManagerVersionArgs
- Instance
Template string The full URL to an instance template from which all new instances of this version will be created.
- Name string
Version name.
- Target
Size RegionInstance Group Manager Version Target Size The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
Exactly one
version
you specify must not have atarget_size
specified. During a rolling update, the instance group manager will fulfill thetarget_size
constraints of every otherversion
, and any remaining instances will be provisioned with the version wheretarget_size
is unset.
- Instance
Template string The full URL to an instance template from which all new instances of this version will be created.
- Name string
Version name.
- Target
Size RegionInstance Group Manager Version Target Size The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
Exactly one
version
you specify must not have atarget_size
specified. During a rolling update, the instance group manager will fulfill thetarget_size
constraints of every otherversion
, and any remaining instances will be provisioned with the version wheretarget_size
is unset.
- instance
Template String The full URL to an instance template from which all new instances of this version will be created.
- name String
Version name.
- target
Size RegionInstance Group Manager Version Target Size The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
Exactly one
version
you specify must not have atarget_size
specified. During a rolling update, the instance group manager will fulfill thetarget_size
constraints of every otherversion
, and any remaining instances will be provisioned with the version wheretarget_size
is unset.
- instance
Template string The full URL to an instance template from which all new instances of this version will be created.
- name string
Version name.
- target
Size RegionInstance Group Manager Version Target Size The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
Exactly one
version
you specify must not have atarget_size
specified. During a rolling update, the instance group manager will fulfill thetarget_size
constraints of every otherversion
, and any remaining instances will be provisioned with the version wheretarget_size
is unset.
- instance_
template 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 RegionInstance Group Manager Version Target Size The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
Exactly one
version
you specify must not have atarget_size
specified. During a rolling update, the instance group manager will fulfill thetarget_size
constraints of every otherversion
, and any remaining instances will be provisioned with the version wheretarget_size
is unset.
- instance
Template String The full URL to an instance template from which all new instances of this version will be created.
- name String
Version name.
- target
Size Property Map The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.
Exactly one
version
you specify must not have atarget_size
specified. During a rolling update, the instance group manager will fulfill thetarget_size
constraints of every otherversion
, and any remaining instances will be provisioned with the version wheretarget_size
is unset.
RegionInstanceGroupManagerVersionTargetSize, RegionInstanceGroupManagerVersionTargetSizeArgs
- 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 usingpercent
, rounding will be in favor of explicitly settarget_size
values; a managed instance group with 2 instances and 2version
s, one of which has atarget_size.percent
of60
will create 2 instances of thatversion
.
- 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 usingpercent
, rounding will be in favor of explicitly settarget_size
values; a managed instance group with 2 instances and 2version
s, one of which has atarget_size.percent
of60
will create 2 instances of thatversion
.
- fixed Integer
, The number of instances which are managed for this version. Conflicts with
percent
.- percent Integer
, The number of instances (calculated as percentage) which are managed for this version. Conflicts with
fixed
. Note that when usingpercent
, rounding will be in favor of explicitly settarget_size
values; a managed instance group with 2 instances and 2version
s, one of which has atarget_size.percent
of60
will create 2 instances of thatversion
.
- 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 usingpercent
, rounding will be in favor of explicitly settarget_size
values; a managed instance group with 2 instances and 2version
s, one of which has atarget_size.percent
of60
will create 2 instances of thatversion
.
- 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 usingpercent
, rounding will be in favor of explicitly settarget_size
values; a managed instance group with 2 instances and 2version
s, one of which has atarget_size.percent
of60
will create 2 instances of thatversion
.
- 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 usingpercent
, rounding will be in favor of explicitly settarget_size
values; a managed instance group with 2 instances and 2version
s, one of which has atarget_size.percent
of60
will create 2 instances of thatversion
.
Import
Instance group managers can be imported using any of these accepted formats* {{name}}
In Terraform v1.5.0 and later, use an import
block to import instance group managers using one of the formats above. For exampletf import {
id = “{{name}}”
to = google_compute_region_instance_group_manager.default }
$ pulumi import gcp:compute/regionInstanceGroupManager:RegionInstanceGroupManager When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), instance group managers can be imported using one of the formats above. For example
$ pulumi import gcp:compute/regionInstanceGroupManager:RegionInstanceGroupManager default {{name}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.