GroupState class
Input properties used for looking up and filtering Group resources.
Constructors
-
GroupState({Input<
String?> ? arn, Input<GroupAvailabilityZoneDistribution?> ? availabilityZoneDistribution, Input<List< ? availabilityZones, Input<String> ?>bool?> ? capacityRebalance, Input<GroupCapacityReservationSpecification?> ? capacityReservationSpecification, Input<String?> ? context, Input<int?> ? defaultCooldown, Input<int?> ? defaultInstanceWarmup, Input<int?> ? desiredCapacity, Input<String?> ? desiredCapacityType, Input<List< ? enabledMetrics, Input<Metric> ?>bool?> ? forceDelete, Input<bool?> ? forceDeleteWarmPool, Input<int?> ? healthCheckGracePeriod, Input<String?> ? healthCheckType, Input<bool?> ? ignoreFailedScalingActivities, Input<List< ? initialLifecycleHooks, Input<GroupInitialLifecycleHook> ?>GroupInstanceLifecyclePolicy?> ? instanceLifecyclePolicy, Input<GroupInstanceMaintenancePolicy?> ? instanceMaintenancePolicy, Input<GroupInstanceRefresh?> ? instanceRefresh, Input? launchConfiguration, Input<GroupLaunchTemplate?> ? launchTemplate, Input<List< ? loadBalancers, Input<String> ?>int?> ? maxInstanceLifetime, Input<int?> ? maxSize, Input? metricsGranularity, Input<int?> ? minElbCapacity, Input<int?> ? minSize, Input<GroupMixedInstancesPolicy?> ? mixedInstancesPolicy, Input<String?> ? name, Input<String?> ? namePrefix, Input? placementGroup, Input<int?> ? predictedCapacity, Input<bool?> ? protectFromScaleIn, Input<String?> ? region, Input<String?> ? serviceLinkedRoleArn, Input<List< ? suspendedProcesses, Input<String> ?>List< ? tags, Input<GroupTag> ?>List< ? targetGroupArns, Input<String> ?>List< ? terminationPolicies, Input<String> ?>List< ? trafficSources, Input<GroupTrafficSource> ?>List< ? vpcZoneIdentifiers, Input<String> ?>String?> ? waitForCapacityTimeout, Input<int?> ? waitForElbCapacity, Input<GroupWarmPool?> ? warmPool, Input<int?> ? warmPoolSize}) -
Creates a new GroupState.
arnARN for this Auto Scaling GroupavailabilityZoneDistributionThe instance capacity distribution across Availability Zones. SeeavailabilityZoneDistributionBlock below for more details.availabilityZonesA list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using thevpcZoneIdentifierattribute, or for attaching a network interface when an existing network interface ID is specified in a launch template. Conflicts withvpcZoneIdentifier.capacityRebalanceWhether capacity rebalance is enabled. Otherwise, capacity rebalance is disabled.capacityReservationSpecificationThe capacity reservation specification for the Auto Scaling group allows you to prioritize launching into On-Demand Capacity Reservations. SeecapacityReservationSpecificationBlock below for more details.contextReserved.defaultCooldownAmount of time, in seconds, after a scaling activity completes before another scaling activity can start.defaultInstanceWarmupAmount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. (See Set the default instance warmup for an Auto Scaling group)desiredCapacityNumber of Amazon EC2 instances thatdesiredCapacityTypeThe unit of measurement for the value specified fordesiredCapacity. Supported for attribute-based instance type selection only. Valid values:"units","vcpu","memory-mib".enabledMetricsList of metrics to collect. The allowed values are defined by the underlying AWS API.forceDeleteAllows deleting the Auto Scaling Group without waitingforceDeleteWarmPoolAllows deleting the Auto Scaling Group without waiting for all instances in the warm pool to terminate.healthCheckGracePeriodTime (in seconds) after instance comes into service before checking health.healthCheckType"EC2" or "ELB". Controls how health checking is done.ignoreFailedScalingActivitiesWhether to ignore failed Auto Scaling scaling activities while waiting for capacity. The default isfalse-- failed scaling activities cause errors to be returned.initialLifecycleHooksOne or moreinstanceLifecyclePolicyIf this block is configured, adds an instance lifecycle policy to the specified Auto Scaling Group. Defined below.instanceMaintenancePolicyIf this block is configured, add a instance maintenance policy to the specified Auto Scaling group. Defined below.instanceRefreshIf this block is configured, start anlaunchConfigurationName of the launch configuration to use.launchTemplateNested argument with Launch template specification to use to launch instances. SeelaunchTemplateBlock below for more details.loadBalancersList of elastic load balancer names to add to the autoscalingmaxInstanceLifetimeMaximum amount of time, in seconds, that an instance can be in service, values must be either equal to 0 or between 86400 and 31536000 seconds.maxSizeMaximum size of the Auto Scaling Group.metricsGranularityGranularity to associate with the metrics to collect. The only valid value is1Minute. Default is1Minute.minElbCapacitySetting this causes Pulumi to wait forminSizeMinimum size of the Auto Scaling Group.mixedInstancesPolicyConfiguration block containing settings to define launch targets for Auto Scaling groups. SeemixedInstancesPolicyBlock below for more details.nameName of the Auto Scaling Group. By default generated by Pulumi. Conflicts withnamePrefix.namePrefixCreates a unique name beginning with the specifiedplacementGroupName of the placement group into which you'll launch your instances, if any.predictedCapacityPredicted capacity of the group.protectFromScaleInWhether newly launched instancesregionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.serviceLinkedRoleArnARN of the service-linked role that the ASG will use to call other AWS servicessuspendedProcessesList of processes to suspend for the Auto Scaling Group. The allowed values areLaunch,Terminate,HealthCheck,ReplaceUnhealthy,AZRebalance,AlarmNotification,ScheduledActions,AddToLoadBalancer,InstanceRefresh.tagsConfiguration block(s) containing resource tags. SeetagBlock below for more details.targetGroupArnsSet ofaws.lb.TargetGroupARNs, for use with Application or Network Load Balancing. To remove all target group attachments an empty list should be specified.terminationPoliciesList of policies to decide how the instances in the Auto Scaling Group should be terminated. The allowed values areOldestInstance,NewestInstance,OldestLaunchConfiguration,ClosestToNextInstanceHour,OldestLaunchTemplate,AllocationStrategy,Default. Additionally, the ARN of a Lambda function can be specified for custom termination policies.trafficSourcesAttaches one or more traffic sources to the specified Auto Scaling group.vpcZoneIdentifiersList of subnet IDs to launch resources in. Subnets automatically determine which availability zones the group will reside. Conflicts withavailabilityZones.waitForCapacityTimeoutMaximumwaitForElbCapacitySetting this will cause Pulumi to waitwarmPoolIf this block is configured, add a Warm PoolwarmPoolSizeCurrent size of the warm pool.const -
GroupState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN for this Auto Scaling Group
final
-
availabilityZoneDistribution
→ Input<
GroupAvailabilityZoneDistribution?> ? -
The instance capacity distribution across Availability Zones. See
availabilityZoneDistributionBlock below for more details.final -
availabilityZones
→ Input<
List< ?String> ?> -
A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the
vpcZoneIdentifierattribute, or for attaching a network interface when an existing network interface ID is specified in a launch template. Conflicts withvpcZoneIdentifier.final -
capacityRebalance
→ Input<
bool?> ? -
Whether capacity rebalance is enabled. Otherwise, capacity rebalance is disabled.
final
-
capacityReservationSpecification
→ Input<
GroupCapacityReservationSpecification?> ? -
The capacity reservation specification for the Auto Scaling group allows you to prioritize launching into On-Demand Capacity Reservations. See
capacityReservationSpecificationBlock below for more details.final -
context
→ Input<
String?> ? -
Reserved.
final
-
defaultCooldown
→ Input<
int?> ? -
Amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
final
-
defaultInstanceWarmup
→ Input<
int?> ? -
Amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService state. (See Set the default instance warmup for an Auto Scaling group)
final
-
desiredCapacity
→ Input<
int?> ? -
Number of Amazon EC2 instances that
should be running in the group. (See also Waiting for
Capacity below.)
final
-
desiredCapacityType
→ Input<
String?> ? -
The unit of measurement for the value specified for
desiredCapacity. Supported for attribute-based instance type selection only. Valid values:"units","vcpu","memory-mib".final -
enabledMetrics
→ Input<
List< ?Metric> ?> -
List of metrics to collect. The allowed values are defined by the underlying AWS API.
final
-
forceDelete
→ Input<
bool?> ? -
Allows deleting the Auto Scaling Group without waiting
for all instances in the pool to terminate. You can force an Auto Scaling Group to delete
even if it's in the process of scaling a resource. Normally, this provider
drains all the instances before deleting the group. This bypasses that
behavior and potentially leaves resources dangling.
final
-
forceDeleteWarmPool
→ Input<
bool?> ? -
Allows deleting the Auto Scaling Group without waiting for all instances in the warm pool to terminate.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
healthCheckGracePeriod
→ Input<
int?> ? -
Time (in seconds) after instance comes into service before checking health.
final
-
healthCheckType
→ Input<
String?> ? -
"EC2" or "ELB". Controls how health checking is done.
final
-
ignoreFailedScalingActivities
→ Input<
bool?> ? -
Whether to ignore failed Auto Scaling scaling activities while waiting for capacity. The default is
false-- failed scaling activities cause errors to be returned.final -
initialLifecycleHooks
→ Input<
List< ?GroupInitialLifecycleHook> ?> -
One or more
Lifecycle Hooks
to attach to the Auto Scaling Group before instances are launched. The
syntax is exactly the same as the separate
aws.autoscaling.LifecycleHookresource, without theautoscalingGroupNameattribute. Please note that this will only work when creating a new Auto Scaling Group. For all other use-cases, please useaws.autoscaling.LifecycleHookresource.final -
instanceLifecyclePolicy
→ Input<
GroupInstanceLifecyclePolicy?> ? -
If this block is configured, adds an instance lifecycle policy to the specified Auto Scaling Group. Defined below.
final
-
instanceMaintenancePolicy
→ Input<
GroupInstanceMaintenancePolicy?> ? -
If this block is configured, add a instance maintenance policy to the specified Auto Scaling group. Defined below.
final
-
instanceRefresh
→ Input<
GroupInstanceRefresh?> ? -
If this block is configured, start an
Instance Refresh
when this Auto Scaling Group is updated. Defined below.
final
- launchConfiguration → Input?
-
Name of the launch configuration to use.
final
-
launchTemplate
→ Input<
GroupLaunchTemplate?> ? -
Nested argument with Launch template specification to use to launch instances. See
launchTemplateBlock below for more details.final -
loadBalancers
→ Input<
List< ?String> ?> -
List of elastic load balancer names to add to the autoscaling
group names. Only valid for classic load balancers. For ALBs, use
targetGroupArnsinstead. To remove all load balancer attachments an empty list should be specified.final -
maxInstanceLifetime
→ Input<
int?> ? -
Maximum amount of time, in seconds, that an instance can be in service, values must be either equal to 0 or between 86400 and 31536000 seconds.
final
-
maxSize
→ Input<
int?> ? -
Maximum size of the Auto Scaling Group.
final
- metricsGranularity → Input?
-
Granularity to associate with the metrics to collect. The only valid value is
1Minute. Default is1Minute.final -
minElbCapacity
→ Input<
int?> ? -
Setting this causes Pulumi to wait for
this number of instances from this Auto Scaling Group to show up healthy in the
ELB only on creation. Updates will not wait on ELB instance number changes.
(See also Waiting for Capacity below.)
final
-
minSize
→ Input<
int?> ? -
Minimum size of the Auto Scaling Group.
(See also Waiting for Capacity below.)
final
-
mixedInstancesPolicy
→ Input<
GroupMixedInstancesPolicy?> ? -
Configuration block containing settings to define launch targets for Auto Scaling groups. See
mixedInstancesPolicyBlock below for more details.final -
name
→ Input<
String?> ? -
Name of the Auto Scaling Group. By default generated by Pulumi. Conflicts with
namePrefix.final -
namePrefix
→ Input<
String?> ? -
Creates a unique name beginning with the specified
prefix. Conflicts with
name.final - placementGroup → Input?
-
Name of the placement group into which you'll launch your instances, if any.
final
-
predictedCapacity
→ Input<
int?> ? -
Predicted capacity of the group.
final
-
protectFromScaleIn
→ Input<
bool?> ? -
Whether newly launched instances
are automatically protected from termination by Amazon EC2 Auto Scaling when
scaling in. For more information about preventing instances from terminating
on scale in, see Using instance scale-in protection
in the Amazon EC2 Auto Scaling User Guide.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceLinkedRoleArn
→ Input<
String?> ? -
ARN of the service-linked role that the ASG will use to call other AWS services
final
-
suspendedProcesses
→ Input<
List< ?String> ?> -
List of processes to suspend for the Auto Scaling Group. The allowed values are
Launch,Terminate,HealthCheck,ReplaceUnhealthy,AZRebalance,AlarmNotification,ScheduledActions,AddToLoadBalancer,InstanceRefresh. Note that if you suspend either theLaunchorTerminateprocess types, it can prevent your Auto Scaling Group from functioning properly.final -
Configuration block(s) containing resource tags. See
tagBlock below for more details.final -
targetGroupArns
→ Input<
List< ?String> ?> -
Set of
aws.lb.TargetGroupARNs, for use with Application or Network Load Balancing. To remove all target group attachments an empty list should be specified.final -
terminationPolicies
→ Input<
List< ?String> ?> -
List of policies to decide how the instances in the Auto Scaling Group should be terminated. The allowed values are
OldestInstance,NewestInstance,OldestLaunchConfiguration,ClosestToNextInstanceHour,OldestLaunchTemplate,AllocationStrategy,Default. Additionally, the ARN of a Lambda function can be specified for custom termination policies.final -
trafficSources
→ Input<
List< ?GroupTrafficSource> ?> -
Attaches one or more traffic sources to the specified Auto Scaling group.
final
-
vpcZoneIdentifiers
→ Input<
List< ?String> ?> -
List of subnet IDs to launch resources in. Subnets automatically determine which availability zones the group will reside. Conflicts with
availabilityZones.final -
waitForCapacityTimeout
→ Input<
String?> ? -
Maximum
duration that the provider should
wait for ASG instances to be healthy before timing out. (See also Waiting
for Capacity below.) Setting this to "0" causes
the provider to skip all Capacity Waiting behavior.
final
-
waitForElbCapacity
→ Input<
int?> ? -
Setting this will cause Pulumi to wait
for exactly this number of healthy instances from this Auto Scaling Group in
all attached load balancers on both create and update operations. (Takes
precedence over
minElbCapacitybehavior.) (See also Waiting for Capacity below.)final -
warmPool
→ Input<
GroupWarmPool?> ? -
If this block is configured, add a Warm Pool
to the specified Auto Scaling group. Defined below
final
-
warmPoolSize
→ Input<
int?> ? -
Current size of the warm pool.
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