Class RegionInstanceGroupManager

The Google Compute Engine Regional Instance Group Manager API creates and manages pools of homogeneous Compute Engine virtual machine instances from a common instance template. For more information, see the official documentation and API

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

Inheritance

System.Object

Resource

CustomResource

RegionInstanceGroupManager

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class RegionInstanceGroupManager : CustomResource

Constructors

View Source

RegionInstanceGroupManager(String, RegionInstanceGroupManagerArgs, CustomResourceOptions)

Create a RegionInstanceGroupManager resource with the given unique name, arguments, and options.

Declaration

public RegionInstanceGroupManager(string name, RegionInstanceGroupManagerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RegionInstanceGroupManagerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AutoHealingPolicies

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.

Declaration

public Output<RegionInstanceGroupManagerAutoHealingPolicies> AutoHealingPolicies { get; }

Property Value

Type	Description
Output<RegionInstanceGroupManagerAutoHealingPolicies>

View Source

BaseInstanceName

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.

Declaration

public Output<string> BaseInstanceName { get; }

Property Value

Type	Description
Output<System.String>

View Source

Description

An optional textual description of the instance group manager.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

DistributionPolicyZones

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

Declaration

public Output<ImmutableArray<string>> DistributionPolicyZones { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Fingerprint

The fingerprint of the instance group manager.

Declaration

public Output<string> Fingerprint { get; }

Property Value

Type	Description
Output<System.String>

View Source

InstanceGroup

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

Declaration

public Output<string> InstanceGroup { get; }

Property Value

Type	Description
Output<System.String>

View Source

Name

Version name.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

NamedPorts

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

Declaration

public Output<ImmutableArray<RegionInstanceGroupManagerNamedPort>> NamedPorts { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RegionInstanceGroupManagerNamedPort>>

View Source

Project

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

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

Region

The region where the managed instance group resides.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

SelfLink

The URL of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

View Source

StatefulDisks

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.

Declaration

public Output<ImmutableArray<RegionInstanceGroupManagerStatefulDisk>> StatefulDisks { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RegionInstanceGroupManagerStatefulDisk>>

View Source

TargetPools

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.

Declaration

public Output<ImmutableArray<string>> TargetPools { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

TargetSize

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

Declaration

public Output<int> TargetSize { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

UpdatePolicy

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

Declaration

public Output<RegionInstanceGroupManagerUpdatePolicy> UpdatePolicy { get; }

Property Value

Type	Description
Output<RegionInstanceGroupManagerUpdatePolicy>

View Source

Versions

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

Declaration

public Output<ImmutableArray<RegionInstanceGroupManagerVersion>> Versions { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<RegionInstanceGroupManagerVersion>>

View Source

WaitForInstances

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.

Declaration

public Output<bool?> WaitForInstances { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

View Source

Get(String, Input<String>, RegionInstanceGroupManagerState, CustomResourceOptions)

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

Declaration

public static RegionInstanceGroupManager Get(string name, Input<string> id, RegionInstanceGroupManagerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RegionInstanceGroupManagerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RegionInstanceGroupManager