AWS CDK Reference

Appearance

v2.273.0

ScheduledActionProperty Struct ​

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 .

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationautoscaling as appscaling } from 'aws-cdk-lib';
const scheduledActionProperty: appscaling.CfnScalableTarget.ScheduledActionProperty = {
  schedule: 'schedule',
  scheduledActionName: 'scheduledActionName',

  // the properties below are optional
  endTime: new Date(),
  scalableTargetAction: {
    maxCapacity: 123,
    minCapacity: 123,
  },
  startTime: new Date(),
  timezone: 'timezone',
};

Properties ​

endTimedate | IResolvableend_timetyping.Union[datetime, IResolvable]endTimeInstantEndTimeDateTimeEndTimeinterface{}#
The date and time that the action is scheduled to end, in UTC.
scalableTargetActionIResolvable | CfnScalableTarget.ScalableTargetActionPropertyscalable_target_actiontyping.Union[IResolvable, ScalableTargetActionProperty]scalableTargetActionIResolvableScalableTargetActionIResolvableScalableTargetActioninterface{}#
The new minimum and maximum capacity.
notes

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.

schedulestringschedulestrscheduleStringSchedulestringSchedule*stringrequired#
The schedule for this action. The following formats are supported:.
notes
  • At expressions - " at( *yyyy* - *mm* - *dd* T *hh* : *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 .

scheduledActionNamestringscheduled_action_namestrscheduledActionNameStringScheduledActionNamestringScheduledActionName*stringrequired#
The name of the scheduled action.

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

startTimedate | IResolvablestart_timetyping.Union[datetime, IResolvable]startTimeInstantStartTimeDateTimeStartTimeinterface{}#
The date and time that the action is scheduled to begin, in UTC.
timezonestringtimezonestrtimezoneStringTimezonestringTimezone*string#
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.