InstanceGroupManager class

Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.

Constructors

InstanceGroupManager(String name, {InstanceGroupManagerArgs? args, CustomResourceOptions? options})

Creates a new InstanceGroupManager. name The Pulumi resource name. args Arguments used to configure this InstanceGroupManager. The set of arguments for InstanceGroupManager. options Resource options controlling this resource's behavior.

Properties

allInstancesConfig ↔ Output<InstanceGroupManagerAllInstancesConfigResponse>

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

late, final

autoHealingPolicies ↔ Output<List<Map<String, dynamic>>>

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

late, final

baseInstanceName ↔ Output<String>

The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTimestamp ↔ Output<String>

The creation timestamp for this managed instance group in RFC3339 text format.

late, final

currentActions ↔ Output<InstanceGroupManagerActionsSummaryResponse>

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

late, final

description ↔ Output<String>

An optional description of this resource.

late, final

distributionPolicy ↔ Output<DistributionPolicyResponse>

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

late, final

failoverAction ↔ Output<String>

The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.

late, final

fingerprint ↔ Output<String>

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

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instanceFlexibilityPolicy ↔ Output<InstanceGroupManagerInstanceFlexibilityPolicyResponse>

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

late, final

instanceGroup ↔ Output<String>

The URL of the Instance Group resource.

late, final

instanceLifecyclePolicy ↔ Output<InstanceGroupManagerInstanceLifecyclePolicyResponse>

The repair policy for this managed instance group.

late, final

instanceTemplate ↔ Output<String>

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

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kind ↔ Output<String>

The resource type, which is always compute#instanceGroupManager for managed instance groups.

late, final

listManagedInstancesResults ↔ Output<String>

Pagination behavior of the listManagedInstances API method for this managed instance group.

late, final

name ↔ Output<String>

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

late, final

namedPorts ↔ Output<List<Map<String, dynamic>>>

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

late, final

project ↔ Output<String>

late, final

region ↔ Output<String>

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

late, final

requestId ↔ Output<String?>

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selfLink ↔ Output<String>

The URL for this managed instance group. The server defines this URL.

late, final

selfLinkWithId ↔ Output<String>

Server-defined URL for this resource with the resource id.

late, final

serviceAccount ↔ Output<String>

The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.

late, final

standbyPolicy ↔ Output<InstanceGroupManagerStandbyPolicyResponse>

Standby policy for stopped and suspended instances.

late, final

statefulPolicy ↔ Output<StatefulPolicyResponse>

Stateful configuration for this Instanced Group Manager

late, final

status ↔ Output<InstanceGroupManagerStatusResponse>

The status of this managed instance group.

late, final

targetPools ↔ Output<List<String>>

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

late, final

targetSize ↔ Output<int>

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

late, final

targetSizeUnit ↔ Output<String>

The unit of measure for the target size.

late, final

targetStoppedSize ↔ Output<int>

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

late, final

targetSuspendedSize ↔ Output<int>

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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updatePolicy ↔ Output<InstanceGroupManagerUpdatePolicyResponse>

The update policy for this managed instance group.

late, final

urn ↔ Output<String>

late, final, inherited

versions ↔ Output<List<Map<String, dynamic>>>

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

late, final

zone ↔ Output<String>

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited