AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction - AWS CloudFormation
SyntaxPropertiesSee also

AWS::ApplicationAutoScaling::ScalableTarget ScheduledAction

ScheduledAction is a property of the AWS::ApplicationAutoScaling::ScalableTarget resource that specifies a scheduled action for a scalable target.

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "EndTime" : String,
  "ScalableTargetAction" : ScalableTargetAction,
  "Schedule" : String,
  "ScheduledActionName" : String,
  "StartTime" : String,
  "Timezone" : String
}

Properties

EndTime

The date and time that the action is scheduled to end, in UTC.

Required: No

Type: String

Update requires: No interruption

ScalableTargetAction

The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

Required: No

Type: ScalableTargetAction

Update requires: No interruption

Schedule

The schedule for this action. The following formats are supported:

  • At expressions - "at(yyyy-mm-ddThh:mm:ss)"

  • Rate expressions - "rate(value unit)"

  • Cron expressions - "cron(fields)"

At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.

At and cron expressions use Universal Coordinated Time (UTC) by default.

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

Required: Yes

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 1

Maximum: 1600

Update requires: No interruption

ScheduledActionName

The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.

Required: Yes

Type: String

Pattern: (?!((^[ ]+.*)|(.*([\u0000-\u001f]|[\u007f-\u009f]|[:/|])+.*)|(.*[ ]+$))).+

Minimum: 1

Maximum: 256

Update requires: No interruption

StartTime

The date and time that the action is scheduled to begin, in UTC.

Required: No

Type: String

Update requires: No interruption

Timezone

The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 1

Maximum: 1600

Update requires: No interruption

See also