Class GroupState

Inheritance

System.Object

InputArgs

ResourceArgs

GroupState

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.AutoScaling

Assembly: Pulumi.Aws.dll

Syntax

public sealed class GroupState : ResourceArgs

Constructors

GroupState()

Declaration

public GroupState()

Properties

Arn

The ARN for this AutoScaling Group

Declaration

public Input<string> Arn { get; set; }

Property Value

Type	Description
Input<System.String>

AvailabilityZones

A list of one or more availability zones for the group. This parameter should not be specified when using vpc_zone_identifier.

Declaration

public InputList<string> AvailabilityZones { get; set; }

Property Value

Type	Description
InputList<System.String>

DefaultCooldown

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

Declaration

public Input<int> DefaultCooldown { get; set; }

Property Value

Type	Description
Input<System.Int32>

DesiredCapacity

The number of Amazon EC2 instances that should be running in the group. (See also Waiting for Capacity below.)

Declaration

public Input<int> DesiredCapacity { get; set; }

Property Value

Type	Description
Input<System.Int32>

EnabledMetrics

A list of metrics to collect. The allowed values are GroupDesiredCapacity, GroupInServiceCapacity, GroupPendingCapacity, GroupMinSize, GroupMaxSize, GroupInServiceInstances, GroupPendingInstances, GroupStandbyInstances, GroupStandbyCapacity, GroupTerminatingCapacity, GroupTerminatingInstances, GroupTotalCapacity, GroupTotalInstances.

Declaration

public InputList<string> EnabledMetrics { get; set; }

Property Value

Type	Description
InputList<System.String>

ForceDelete

Allows deleting the autoscaling group without waiting for all instances in the pool to terminate. You can force an autoscaling 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.

Declaration

public Input<bool> ForceDelete { get; set; }

Property Value

Type	Description
Input<System.Boolean>

HealthCheckGracePeriod

Time (in seconds) after instance comes into service before checking health.

Declaration

public Input<int> HealthCheckGracePeriod { get; set; }

Property Value

Type	Description
Input<System.Int32>

HealthCheckType

"EC2" or "ELB". Controls how health checking is done.

Declaration

public Input<string> HealthCheckType { get; set; }

Property Value

Type	Description
Input<System.String>

InitialLifecycleHooks

One or more Lifecycle Hooks to attach to the autoscaling group before instances are launched. The syntax is exactly the same as the separate aws.autoscaling.LifecycleHook resource, without the autoscaling_group_name attribute. Please note that this will only work when creating a new autoscaling group. For all other use-cases, please use aws.autoscaling.LifecycleHook resource.

Declaration

public InputList<GroupInitialLifecycleHookGetArgs> InitialLifecycleHooks { get; set; }

Property Value

Type	Description
InputList<GroupInitialLifecycleHookGetArgs>

LaunchConfiguration

The name of the launch configuration to use.

Declaration

public Input<string> LaunchConfiguration { get; set; }

Property Value

Type	Description
Input<System.String>

LaunchTemplate

Nested argument containing launch template settings along with the overrides to specify multiple instance types and weights. Defined below.

Declaration

public Input<GroupLaunchTemplateGetArgs> LaunchTemplate { get; set; }

Property Value

Type	Description
Input<GroupLaunchTemplateGetArgs>

LoadBalancers

A list of elastic load balancer names to add to the autoscaling group names. Only valid for classic load balancers. For ALBs, use target_group_arns instead.

Declaration

public InputList<string> LoadBalancers { get; set; }

Property Value

Type	Description
InputList<System.String>

MaxInstanceLifetime

The maximum amount of time, in seconds, that an instance can be in service, values must be either equal to 0 or between 604800 and 31536000 seconds.

Declaration

public Input<int> MaxInstanceLifetime { get; set; }

Property Value

Type	Description
Input<System.Int32>

MaxSize

The maximum size of the auto scale group.

Declaration

public Input<int> MaxSize { get; set; }

Property Value

Type	Description
Input<System.Int32>

MetricsGranularity

The granularity to associate with the metrics to collect. The only valid value is 1Minute. Default is 1Minute.

Declaration

public Input<string> MetricsGranularity { get; set; }

Property Value

Type	Description
Input<System.String>

MinElbCapacity

Setting this causes this provider to wait for this number of instances from this autoscaling 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.)

Declaration

public Input<int> MinElbCapacity { get; set; }

Property Value

Type	Description
Input<System.Int32>

MinSize

The minimum size of the auto scale group. (See also Waiting for Capacity below.)

Declaration

public Input<int> MinSize { get; set; }

Property Value

Type	Description
Input<System.Int32>

MixedInstancesPolicy

Configuration block containing settings to define launch targets for Auto Scaling groups. Defined below.

Declaration

public Input<GroupMixedInstancesPolicyGetArgs> MixedInstancesPolicy { get; set; }

Property Value

Type	Description
Input<GroupMixedInstancesPolicyGetArgs>

Name

The name of the auto scaling group. By default generated by this provider.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

NamePrefix

Creates a unique name beginning with the specified prefix. Conflicts with name.

Declaration

public Input<string> NamePrefix { get; set; }

Property Value

Type	Description
Input<System.String>

PlacementGroup

The name of the placement group into which you'll launch your instances, if any.

Declaration

public Input<string> PlacementGroup { get; set; }

Property Value

Type	Description
Input<System.String>

ProtectFromScaleIn

Allows setting instance protection. The autoscaling group will not select instances with this setting for terminination during scale in events.

Declaration

public Input<bool> ProtectFromScaleIn { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ServiceLinkedRoleArn

The ARN of the service-linked role that the ASG will use to call other AWS services

Declaration

public Input<string> ServiceLinkedRoleArn { get; set; }

Property Value

Type	Description
Input<System.String>

SuspendedProcesses

A list of processes to suspend for the AutoScaling Group. The allowed values are Launch, Terminate, HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions, AddToLoadBalancer. Note that if you suspend either the Launch or Terminate process types, it can prevent your autoscaling group from functioning properly.

Declaration

public InputList<string> SuspendedProcesses { get; set; }

Property Value

Type	Description
InputList<System.String>

Tags

A list of tag blocks. Tags documented below.

Declaration

public InputList<GroupTagGetArgs> Tags { get; set; }

Property Value

Type	Description
InputList<GroupTagGetArgs>

TagsCollection

A list of tag blocks (maps). Tags documented below.

Declaration

public InputList<ImmutableDictionary<string, object>> TagsCollection { get; set; }

Property Value

Type	Description
InputList<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

TargetGroupArns

A list of aws.alb.TargetGroup ARNs, for use with Application or Network Load Balancing.

Declaration

public InputList<string> TargetGroupArns { get; set; }

Property Value

Type	Description
InputList<System.String>

TerminationPolicies

A list of policies to decide how the instances in the auto scale group should be terminated. The allowed values are OldestInstance, NewestInstance, OldestLaunchConfiguration, ClosestToNextInstanceHour, OldestLaunchTemplate, AllocationStrategy, Default.

Declaration

public InputList<string> TerminationPolicies { get; set; }

Property Value

Type	Description
InputList<System.String>

VpcZoneIdentifiers

A list of subnet IDs to launch resources in.

Declaration

public InputList<string> VpcZoneIdentifiers { get; set; }

Property Value

Type	Description
InputList<System.String>

WaitForCapacityTimeout

A maximum duration that this provider should wait for ASG instances to be healthy before timing out. (See also Waiting for Capacity below.) Setting this to "0" causes this provider to skip all Capacity Waiting behavior.

Declaration

public Input<string> WaitForCapacityTimeout { get; set; }

Property Value

Type	Description
Input<System.String>

WaitForElbCapacity

Setting this will cause this provider to wait for exactly this number of healthy instances from this autoscaling group in all attached load balancers on both create and update operations. (Takes precedence over min_elb_capacity behavior.) (See also Waiting for Capacity below.)

Declaration

public Input<int> WaitForElbCapacity { get; set; }

Property Value

Type	Description
Input<System.Int32>