InstanceGroupManagerArgs class
The set of arguments for InstanceGroupManager. The set of arguments for InstanceGroupManager.
Constructors
-
InstanceGroupManagerArgs({Input<
InstanceGroupManagerAllInstancesConfig?> ? allInstancesConfig, Input<InstanceGroupManagerAutoHealingPolicies?> ? autoHealingPolicies, required Input<String> baseInstanceName, Input<String?> ? deletionPolicy, Input<String?> ? description, Input<InstanceGroupManagerInstanceLifecyclePolicy?> ? instanceLifecyclePolicy, Input<String?> ? listManagedInstancesResults, Input<String?> ? name, Input<List< ? namedPorts, Input<InstanceGroupManagerNamedPort> ?>InstanceGroupManagerParams?> ? params, Input<String?> ? project, Input<InstanceGroupManagerResourcePolicies?> ? resourcePolicies, Input<InstanceGroupManagerStandbyPolicy?> ? standbyPolicy, Input<List< ? statefulDisks, Input<InstanceGroupManagerStatefulDisk> ?>List< ? statefulExternalIps, Input<InstanceGroupManagerStatefulExternalIp> ?>List< ? statefulInternalIps, Input<InstanceGroupManagerStatefulInternalIp> ?>List< ? targetPools, Input<String> ?>int?> ? targetSize, Input<List< ? targetSizePolicies, Input<InstanceGroupManagerTargetSizePolicy> ?>int?> ? targetStoppedSize, Input<int?> ? targetSuspendedSize, Input<InstanceGroupManagerUpdatePolicy?> ? updatePolicy, required Input<List< versions, Input<InstanceGroupManagerVersion> >bool?> ? waitForInstances, Input<String?> ? waitForInstancesStatus, Input<String?> ? zone}) -
Creates a new InstanceGroupManagerArgs.
allInstancesConfigProperties to set on all instances in the group. After settingautoHealingPoliciesThe autohealing policies for this managed instancebaseInstanceNameThe base instance name to use fordeletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to "DELETE".descriptionAn optional textual description of the instanceinstanceLifecyclePolicyThe instance lifecycle policy for this managed instance group.listManagedInstancesResultsPagination behavior of thelistManagedInstancesAPInameThe name of the instance group manager. Must be 1-63namedPortsThe named port configuration. See the section belowparams) Input only additional params for instance group manager creation. Structure is documented below. For more information, see API.projectThe ID of the project in which the resource belongs. If itresourcePoliciesResource policies for this managed instance group. Structure is documented below.standbyPolicyThe standby policy for stopped and suspended instances. Structure is documented below. For more information, see the official documentation.statefulDisksDisks created on the instances that will be preserved on instance delete, update, etc. Structure is documented below. For more information see the official documentation.statefulExternalIpsExternal 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.statefulInternalIpsInternal 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.targetPoolsThe full URL of all target pools to which newtargetSizeThe target number of running instances for this managedtargetSizePoliciesThe policy that specifies how the MIG creates its VMs to achieve the target size. Structure is documented below.targetStoppedSizeThe target number of stopped instances for this managed instance group.targetSuspendedSizeThe target number of suspended instances for this managed instance group.updatePolicyThe update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API.versionsApplication versions managed by this instance group. EachwaitForInstancesWhether to wait for all instances to be created/updated beforewaitForInstancesStatusWhen used withwaitForInstancesit specifies the status to wait for.zoneThe zone that instances in this group should be createdconst -
InstanceGroupManagerArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
allInstancesConfig
→ Input<
InstanceGroupManagerAllInstancesConfig?> ? -
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<
InstanceGroupManagerAutoHealingPolicies?> ? -
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
- hashCode → int
-
The hash code for this object.
no setterinherited
-
instanceLifecyclePolicy
→ Input<
InstanceGroupManagerInstanceLifecyclePolicy?> ? -
The instance lifecycle policy for this managed instance group.
final
-
listManagedInstancesResults
→ Input<
String?> ? -
Pagination behavior of the
listManagedInstancesAPI method for this managed instance group. Valid values are:PAGELESS,PAGINATED. IfPAGELESS(default), Pagination is disabled for the group'slistManagedInstancesAPI method.maxResultsandpageTokenquery parameters are ignored and all instances are returned in a single response. IfPAGINATED, pagination is enabled,maxResultsandpageTokenquery 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< ?InstanceGroupManagerNamedPort> ?> -
The named port configuration. See the section below
for details on configuration.
final
-
params
→ Input<
InstanceGroupManagerParams?> ? -
) 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
-
resourcePolicies
→ Input<
InstanceGroupManagerResourcePolicies?> ? -
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<
InstanceGroupManagerStandbyPolicy?> ? -
The standby policy for stopped and suspended instances. Structure is documented below. For more information, see the official documentation.
final
-
statefulDisks
→ Input<
List< ?InstanceGroupManagerStatefulDisk> ?> -
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.
final
-
statefulExternalIps
→ Input<
List< ?InstanceGroupManagerStatefulExternalIp> ?> -
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< ?InstanceGroupManagerStatefulInternalIp> ?> -
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_changescan be used to prevent Terraform from modifying the value. Defaults to0.final -
targetSizePolicies
→ Input<
List< ?InstanceGroupManagerTargetSizePolicy> ?> -
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<
InstanceGroupManagerUpdatePolicy?> ? -
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< InstanceGroupManagerVersion> > -
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, this provider will
continue trying until it times out.
final
-
waitForInstancesStatus
→ Input<
String?> ? -
When used with
waitForInstancesit specifies the status to wait for. WhenSTABLEis specified this resource will wait until the instances are stable before returning. WhenUPDATEDis 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 areSTABLEandUPDATEDfinal -
zone
→ Input<
String?> ? -
The zone that instances in this group should be created
in.
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