InstanceGroupManagerArgs class

The set of arguments for InstanceGroupManager. The set of arguments for InstanceGroupManager.

Constructors

InstanceGroupManagerArgs({Input<InstanceGroupManagerAllInstancesConfig>? allInstancesConfig, Input<List<InstanceGroupManagerAutoHealingPolicy>>? autoHealingPolicies, Input<String>? baseInstanceName, Input<String>? description, Input<DistributionPolicy>? distributionPolicy, Input<InstanceGroupManagerFailoverAction>? failoverAction, Input<InstanceGroupManagerInstanceFlexibilityPolicy>? instanceFlexibilityPolicy, Input<InstanceGroupManagerInstanceLifecyclePolicy>? instanceLifecyclePolicy, Input<String>? instanceTemplate, Input<InstanceGroupManagerListManagedInstancesResults>? listManagedInstancesResults, Input<String>? name, Input<List<NamedPort>>? namedPorts, Input<String>? project, Input<String>? requestId, Input<String>? serviceAccount, Input<InstanceGroupManagerStandbyPolicy>? standbyPolicy, Input<StatefulPolicy>? statefulPolicy, Input<List<String>>? targetPools, Input<int>? targetSize, Input<InstanceGroupManagerTargetSizeUnit>? targetSizeUnit, Input<int>? targetStoppedSize, Input<int>? targetSuspendedSize, Input<InstanceGroupManagerUpdatePolicy>? updatePolicy, Input<List<InstanceGroupManagerVersion>>? versions, Input<String>? zone})
Creates a new InstanceGroupManagerArgs. allInstancesConfig Specifies configuration that overrides the instance template configuration for the group. autoHealingPolicies The autohealing policy for this managed instance group. You can specify only one value. baseInstanceName 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. description An optional description of this resource. distributionPolicy Policy specifying the intended distribution of managed instances across zones in a regional managed instance group. failoverAction The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER. instanceFlexibilityPolicy Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration. instanceLifecyclePolicy The repair policy for this managed instance group. instanceTemplate 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. listManagedInstancesResults Pagination behavior of the listManagedInstances API method for this managed instance group. name The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. namedPorts Named ports configured for the Instance Groups complementary to this Instance Group Manager. project Optional. requestId 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). serviceAccount 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. standbyPolicy Standby policy for stopped and suspended instances. statefulPolicy Stateful configuration for this Instanced Group Manager targetPools 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. targetSize 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. targetSizeUnit The unit of measure for the target size. targetStoppedSize 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. targetSuspendedSize 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. updatePolicy The update policy for this managed instance group. versions 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. zone Optional.
const
InstanceGroupManagerArgs.fromMap(Map<String, dynamic> map)
factory

Properties

allInstancesConfig → Input<InstanceGroupManagerAllInstancesConfig>?
Specifies configuration that overrides the instance template configuration for the group.
final
autoHealingPolicies → Input<List<InstanceGroupManagerAutoHealingPolicy>>?
The autohealing policy for this managed instance group. You can specify only one value.
final
baseInstanceName → Input<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.
final
description → Input<String>?
An optional description of this resource.
final
distributionPolicy → Input<DistributionPolicy>?
Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.
final
failoverAction → Input<InstanceGroupManagerFailoverAction>?
The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
final
hashCode → int
The hash code for this object.
no setterinherited
instanceFlexibilityPolicy → Input<InstanceGroupManagerInstanceFlexibilityPolicy>?
Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.
final
instanceLifecyclePolicy → Input<InstanceGroupManagerInstanceLifecyclePolicy>?
The repair policy for this managed instance group.
final
instanceTemplate → Input<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.
final
listManagedInstancesResults → Input<InstanceGroupManagerListManagedInstancesResults>?
Pagination behavior of the listManagedInstances API method for this managed instance group.
final
name → Input<String>?
The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
final
namedPorts → Input<List<NamedPort>>?
Named ports configured for the Instance Groups complementary to this Instance Group Manager.
final
project → Input<String>?
final
requestId → Input<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).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccount → Input<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.
final
standbyPolicy → Input<InstanceGroupManagerStandbyPolicy>?
Standby policy for stopped and suspended instances.
final
statefulPolicy → Input<StatefulPolicy>?
Stateful configuration for this Instanced Group Manager
final
targetPools → Input<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.
final
targetSize → Input<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.
final
targetSizeUnit → Input<InstanceGroupManagerTargetSizeUnit>?
The unit of measure for the target size.
final
targetStoppedSize → Input<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.
final
targetSuspendedSize → Input<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.
final
updatePolicy → Input<InstanceGroupManagerUpdatePolicy>?
The update policy for this managed instance group.
final
versions → Input<List<InstanceGroupManagerVersion>>?
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.
final
zone → Input<String>?
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