Class: AutoScalingGroup

AutoScaling.AutoScalingGroup

new AutoScalingGroup()

Properties:
Name Type Description
AvailabilityZones String Required: Conditional. Contains a list of availability zones for the group.Update requires: No interruption
Cooldown String Required: No. The number of seconds after a scaling activity is completed before any further scaling activities can start.Update requires: No interruption
DesiredCapacity String Required: No. Specifies the desired capacity for the Auto Scaling group.If SpotPrice is not set in the AWS::AutoScaling::LaunchConfiguration for this Auto Scaling group, then Auto Scaling will begin to bring instances online based on DesiredCapacity. CloudFormation will not mark the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) until the desired capacity is reached.If SpotPrice is set, then DesiredCapacity will not be used as a criteria for success, since instances will only be started when the spot price has been matched. After the spot price has been matched, however, Auto Scaling uses DesiredCapacity as the target capacity for the group.Update requires: No interruption
HealthCheckGracePeriod Number Required: No. The length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.Update requires: No interruption
HealthCheckType String Required: No. The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.Update requires: No interruption
InstanceId String Required: Conditional. The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this property if you want to create an Auto Scaling group that uses an existing Amazon EC2 instance instead of a launch configuration.When you use an Amazon EC2 instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its properties from the instance, with the exception of BlockDeviceMapping and AssociatePublicIpAddress.Update requires: Replacement
LaunchConfigurationName String Required: Conditional. Specifies the name of the associated AWS::AutoScaling::LaunchConfiguration.NoteIf this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute.Update requires: No interruptionImportantWhen you update the LaunchConfigurationName, existing Amazon EC2 instances continue to run with the configuration that they were originally launched with. To update existing instances, specify an update policy attribute for this Auto Scaling group. For more information, see UpdatePolicy.
LoadBalancerNames String Required: No. A list of Classic load balancers associated with this Auto Scaling group. To specify Application load balancers, use TargetGroupARNs.Update requires: ReplacementImportant When you update LoadBalancerNames, the entire Auto Scaling group is replaced.
MaxSize String Required: Yes. The maximum size of the Auto Scaling group.Update requires: No interruption
MetricsCollection AutoScalingMetricsCollection Required: No. Enables the monitoring of group metrics of an Auto Scaling group.Update requires: No interruption
MinSize String Required: Yes. The minimum size of the Auto Scaling group.Update requires: No interruption
NotificationConfigurations AutoScalingNotificationConfigurations Required: No. An embedded property that configures an Auto Scaling group to send notifications when specified events take place.Update requires: No interruption
PlacementGroup String Required: No. The name of an existing cluster placement group into which you want to launch your instances. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group.Update requires: No interruption
Tags AutoScalingTags Required: No. The tags you want to attach to this resource.For more information about tags, go to Tagging Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling User Guide.Update requires: No interruption
TargetGroupARNs String Required: No. A list of Amazon Resource Names (ARN) of target groups to associate with the Auto Scaling group.Update requires: No interruption
TerminationPolicies String Required: No. A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the Auto Scaling User Guide. Update requires: No interruption
VPCZoneIdentifier String Required: Conditional. A list of subnet identifiers of Amazon Virtual Private Cloud (Amazon VPCs).If you specify the AvailabilityZones property, the subnets that you specify for this property must reside in those Availability Zones.For more information, go to Using EC2 Dedicated Instances Within Your VPC in the Auto Scaling User Guide.Update requires: Some interruptionsNoteWhen you update VPCZoneIdentifier, the instances are replaced, but not the Auto Scaling group.
Source:

Extends

  • WKResource

AutoScaling.AutoScalingGroup

new AutoScalingGroup()

Properties:
Name Type Description
AvailabilityZones String Required: Conditional. Contains a list of availability zones for the group.Update requires: No interruption
Cooldown String Required: No. The number of seconds after a scaling activity is completed before any further scaling activities can start.Update requires: No interruption
DesiredCapacity String Required: No. Specifies the desired capacity for the Auto Scaling group.If SpotPrice is not set in the AWS::AutoScaling::LaunchConfiguration for this Auto Scaling group, then Auto Scaling will begin to bring instances online based on DesiredCapacity. CloudFormation will not mark the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) until the desired capacity is reached.If SpotPrice is set, then DesiredCapacity will not be used as a criteria for success, since instances will only be started when the spot price has been matched. After the spot price has been matched, however, Auto Scaling uses DesiredCapacity as the target capacity for the group.Update requires: No interruption
HealthCheckGracePeriod Number Required: No. The length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.Update requires: No interruption
HealthCheckType String Required: No. The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Valid values are EC2 or ELB.Update requires: No interruption
InstanceId String Required: Conditional. The ID of the Amazon EC2 instance you want to use to create the Auto Scaling group. Use this property if you want to create an Auto Scaling group that uses an existing Amazon EC2 instance instead of a launch configuration.When you use an Amazon EC2 instance to create an Auto Scaling group, a new launch configuration is first created and then associated with the Auto Scaling group. The new launch configuration derives all its properties from the instance, with the exception of BlockDeviceMapping and AssociatePublicIpAddress.Update requires: Replacement
LaunchConfigurationName String Required: Conditional. Specifies the name of the associated AWS::AutoScaling::LaunchConfiguration.NoteIf this resource has a public IP address and is also in a VPC that is defined in the same template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment. For more information, see DependsOn Attribute.Update requires: No interruptionImportantWhen you update the LaunchConfigurationName, existing Amazon EC2 instances continue to run with the configuration that they were originally launched with. To update existing instances, specify an update policy attribute for this Auto Scaling group. For more information, see UpdatePolicy.
LoadBalancerNames String Required: No. A list of Classic load balancers associated with this Auto Scaling group. To specify Application load balancers, use TargetGroupARNs.Update requires: ReplacementImportant When you update LoadBalancerNames, the entire Auto Scaling group is replaced.
MaxSize String Required: Yes. The maximum size of the Auto Scaling group.Update requires: No interruption
MetricsCollection AutoScalingMetricsCollection Required: No. Enables the monitoring of group metrics of an Auto Scaling group.Update requires: No interruption
MinSize String Required: Yes. The minimum size of the Auto Scaling group.Update requires: No interruption
NotificationConfigurations AutoScalingNotificationConfigurations Required: No. An embedded property that configures an Auto Scaling group to send notifications when specified events take place.Update requires: No interruption
PlacementGroup String Required: No. The name of an existing cluster placement group into which you want to launch your instances. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group.Update requires: No interruption
Tags AutoScalingTags Required: No. The tags you want to attach to this resource.For more information about tags, go to Tagging Auto Scaling Groups and Amazon EC2 Instances in the Auto Scaling User Guide.Update requires: No interruption
TargetGroupARNs String Required: No. A list of Amazon Resource Names (ARN) of target groups to associate with the Auto Scaling group.Update requires: No interruption
TerminationPolicies String Required: No. A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information on configuring a termination policy for your Auto Scaling group, see Instance Termination Policy for Your Auto Scaling Group in the Auto Scaling User Guide. Update requires: No interruption
VPCZoneIdentifier String Required: Conditional. A list of subnet identifiers of Amazon Virtual Private Cloud (Amazon VPCs).If you specify the AvailabilityZones property, the subnets that you specify for this property must reside in those Availability Zones.For more information, go to Using EC2 Dedicated Instances Within Your VPC in the Auto Scaling User Guide.Update requires: Some interruptionsNoteWhen you update VPCZoneIdentifier, the instances are replaced, but not the Auto Scaling group.
Source:

Extends

  • WKResource