AWS CloudFormation
User Guide (API Version 2010-05-15)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

AWS::AutoScaling::Trigger

Creates an Auto Scaling trigger that determines when scaling activities should occur for the Auto Scaling group. This type does not support updates.

Important

Triggers are a deprecated feature of Auto Scaling. We recommend that you switch from using triggers to using Auto Scaling policies and alarms. For more information, see Configuring Auto Scaling in the Auto Scaling Developer Guide.

Syntax

{
   "Type" : "AWS::AutoScaling::Trigger",
   "Properties" : {
      "AutoScalingGroupName" : String,
      "BreachDuration" : String,
      "Dimensions" : [ CloudWatch Dimension1, ... ],
      "LowerBreachScaleIncrement" : String,
      "LowerThreshold" : String,
      "MetricName" : String,
      "Namespace" : String,
      "Period" : String,
      "Statistic" : String,
      "Unit" : String,
      "UpperBreachScaleIncrement" : String,
      "UpperThreshold" : String
   }
}      

Properties

AutoScalingGroupName

The name of the Auto Scaling group.

Required: Yes

Type: String

BreachDuration

The amount of time to wait while the trigger is firing before performing scaling activities in response to the breach.

Required: Yes

Type: String

Dimensions

A list of CloudWatch dimensions used to retrieve metric statistics that the trigger uses to determine when to fire.

Required: Yes

Type: List of CloudWatch dimensions

LowerBreachScaleIncrement

The incremental amount to use when performing scaling activities when the lower threshold has been breached.

Must be a negative or positive integer, or integer percentage value.

Required: Conditional

Type: String

LowerThreshold

The lower limit for the metric. The trigger fires if all data points in the last BreachDuration seconds exceed the upper threshold or fall below the lower threshold.

Required: Yes

Type: String

MetricName

The metric name used by the trigger to determine when to fire.

Required: Yes

Type: String

Namespace

The namespace used by the trigger to determine when to fire.

Required: Yes

Type: String

Period

The period used in retrieving metric statistics used by the trigger to determine when to fire.

Required: Yes

Type: String

Statistic

The statistic used by the trigger to determine which metric statistics to examine.

Required: Yes

Type: String

Unit

The standard unit associated with a measure, used by the trigger when fetching the metric statistics it uses to determine when to activate.

Required: No

Type: String

UpperBreachScaleIncrement

The incremental amount to use when performing scaling activities when the upper threshold has been breached.

Must be a negative or positive integer, or integer percentage value.

Required: Conditional

Type: String

UpperThreshold

The upper limit of the metric used. The trigger fires if all data points in the last BreachDuration seconds exceed the upper threshold or fall below the lower threshold.

Required: Yes

Type: String

Return Value

When you specify an AWS::AutoScaling::Trigger type as an argument to the Ref function, AWS CloudFormation returns the value of the TriggerName.

For more information about using the Ref function, see Ref.