RegionInstanceGroupManagerArgs class

The set of arguments for RegionInstanceGroupManager. The set of arguments for RegionInstanceGroupManager.

Constructors

RegionInstanceGroupManagerArgs({Input<RegionInstanceGroupManagerAllInstancesConfig?>? allInstancesConfig, Input<RegionInstanceGroupManagerAutoHealingPolicies?>? autoHealingPolicies, required Input<String> baseInstanceName, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? distributionPolicyTargetShape, Input<List<String>?>? distributionPolicyZones, Input<RegionInstanceGroupManagerInstanceFlexibilityPolicy?>? instanceFlexibilityPolicy, Input<RegionInstanceGroupManagerInstanceLifecyclePolicy?>? instanceLifecyclePolicy, Input<String?>? listManagedInstancesResults, Input<String?>? name, Input<List<RegionInstanceGroupManagerNamedPort>?>? namedPorts, Input<RegionInstanceGroupManagerParams?>? params, Input<String?>? project, Input<String?>? region, Input<RegionInstanceGroupManagerResourcePolicies?>? resourcePolicies, Input<RegionInstanceGroupManagerStandbyPolicy?>? standbyPolicy, Input<List<RegionInstanceGroupManagerStatefulDisk>?>? statefulDisks, Input<List<RegionInstanceGroupManagerStatefulExternalIp>?>? statefulExternalIps, Input<List<RegionInstanceGroupManagerStatefulInternalIp>?>? statefulInternalIps, Input<List<String>?>? targetPools, Input<int?>? targetSize, Input<List<RegionInstanceGroupManagerTargetSizePolicy>?>? targetSizePolicies, Input<int?>? targetStoppedSize, Input<int?>? targetSuspendedSize, Input<RegionInstanceGroupManagerUpdatePolicy?>? updatePolicy, required Input<List<RegionInstanceGroupManagerVersion>> versions, Input<bool?>? waitForInstances, Input<String?>? waitForInstancesStatus})
Creates a new RegionInstanceGroupManagerArgs. allInstancesConfig Properties to set on all instances in the group. After setting autoHealingPolicies The autohealing policies for this managed instance baseInstanceName The base instance name to use for deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". description An optional textual description of the instance distributionPolicyTargetShape 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. distributionPolicyZones The distribution policy for this managed instance instanceFlexibilityPolicy The flexibility policy for managed instance group. Instance flexibility allows managed instance group to create VMs from multiple types of machines. Instance flexibility configuration on managed instance group overrides instance template configuration. Structure is documented below. instanceLifecyclePolicy The instance lifecycle policy for this managed instance group. listManagedInstancesResults Pagination behavior of the listManagedInstances API name The name of the instance group manager. Must be 1-63 namedPorts The named port configuration. See the section below params ) Input only additional params for instance group manager creation. Structure is documented below. For more information, see API. project The ID of the project in which the resource belongs. If it region The region where the managed instance group resides. If not provided, the provider region is used. resourcePolicies Resource policies for this managed instance group. Structure is documented below. standbyPolicy The standby policy for stopped and suspended instances. Structure is documented below. For more information, see the official documentation. 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 updatePolicy. statefulExternalIps 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. statefulInternalIps 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. targetPools The full URL of all target pools to which new targetSize The target number of running instances for this managed targetSizePolicies The policy that specifies how the MIG creates its VMs to achieve the target size. Structure is documented below. targetStoppedSize The target number of stopped instances for this managed instance group. targetSuspendedSize The target number of suspended instances for this managed instance group. updatePolicy The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API versions Application versions managed by this instance group. Each waitForInstances Whether to wait for all instances to be created/updated before waitForInstancesStatus When used with waitForInstances it specifies the status to wait for.
const
RegionInstanceGroupManagerArgs.fromMap(Map<String, dynamic> map)
factory

Properties

allInstancesConfig → Input<RegionInstanceGroupManagerAllInstancesConfig?>?
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.
final
autoHealingPolicies → Input<RegionInstanceGroupManagerAutoHealingPolicies?>?
The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.
final
baseInstanceName → Input<String>
The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to "DELETE". When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
An optional textual description of the instance group manager.
final
distributionPolicyTargetShape → Input<String?>?
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.
final
distributionPolicyZones → Input<List<String>?>?
The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceFlexibilityPolicy → Input<RegionInstanceGroupManagerInstanceFlexibilityPolicy?>?
The flexibility policy for managed instance group. Instance flexibility allows managed instance group to create VMs from multiple types of machines. Instance flexibility configuration on managed instance group overrides instance template configuration. Structure is documented below.
final
instanceLifecyclePolicy → Input<RegionInstanceGroupManagerInstanceLifecyclePolicy?>?
The instance lifecycle policy for this managed instance group.
final
listManagedInstancesResults → Input<String?>?
Pagination behavior of the listManagedInstances API method for this managed instance group. Valid values are: PAGELESS, PAGINATED. If PAGELESS (default), Pagination is disabled for the group's listManagedInstances API method. maxResults and pageToken query parameters are ignored and all instances are returned in a single response. If PAGINATED, pagination is enabled, maxResults and pageToken query parameters are respected.
final
name → Input<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.
final
namedPorts → Input<List<RegionInstanceGroupManagerNamedPort>?>?
The named port configuration. See the section below for details on configuration.
final
params → Input<RegionInstanceGroupManagerParams?>?
) Input only additional params for instance group manager creation. Structure is documented below. For more information, see API.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
region → Input<String?>?
The region where the managed instance group resides. If not provided, the provider region is used.
final
resourcePolicies → Input<RegionInstanceGroupManagerResourcePolicies?>?
Resource policies for this managed instance group. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
standbyPolicy → Input<RegionInstanceGroupManagerStandbyPolicy?>?
The standby policy for stopped and suspended instances. Structure is documented below. For more information, see the official documentation.
final
statefulDisks → Input<List<RegionInstanceGroupManagerStatefulDisk>?>?
Disks created on the instances that will be preserved on instance delete, update, etc. Structure is documented below. For more information see the official documentation. Proactive cross zone instance redistribution must be disabled before you can update stateful disks on existing instance group managers. This can be controlled via the updatePolicy.
final
statefulExternalIps → Input<List<RegionInstanceGroupManagerStatefulExternalIp>?>?
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.
final
statefulInternalIps → Input<List<RegionInstanceGroupManagerStatefulInternalIp>?>?
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.
final
targetPools → Input<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.
final
targetSize → Input<int?>?
The target number of running instances for this managed instance group. This value will fight with autoscaler settings when set, and generally shouldn't be set when using one. If a value is required, such as to specify a creation-time target size for the MIG, lifecycle.ignore_changes can be used to prevent Terraform from modifying the value. Defaults to 0.
final
targetSizePolicies → Input<List<RegionInstanceGroupManagerTargetSizePolicy>?>?
The policy that specifies how the MIG creates its VMs to achieve the target size. Structure is documented below.
final
targetStoppedSize → Input<int?>?
The target number of stopped instances for this managed instance group.
final
targetSuspendedSize → Input<int?>?
The target number of suspended instances for this managed instance group.
final
updatePolicy → Input<RegionInstanceGroupManagerUpdatePolicy?>?
The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API
final
versions → Input<List<RegionInstanceGroupManagerVersion>>
Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.
final
waitForInstances → Input<bool?>?
Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, the provider will continue trying until it times out.
final
waitForInstancesStatus → Input<String?>?
When used with waitForInstances it specifies the status to wait for. When STABLE is specified this resource will wait until the instances are stable before returning. When UPDATED 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 are STABLE and UPDATED
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited