interface BasicScheduledActionProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AutoScaling.BasicScheduledActionProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#BasicScheduledActionProps |
 Java | software.amazon.awscdk.services.autoscaling.BasicScheduledActionProps |
 Python | aws_cdk.aws_autoscaling.BasicScheduledActionProps |
 TypeScript (source) | aws-cdk-lib » aws_autoscaling » BasicScheduledActionProps |
Properties for a scheduled scaling action.
Example
declare const autoScalingGroup: autoscaling.AutoScalingGroup;
autoScalingGroup.scaleOnSchedule('PrescaleInTheMorning', {
schedule: autoscaling.Schedule.cron({ hour: '8', minute: '0' }),
minCapacity: 20,
});
autoScalingGroup.scaleOnSchedule('AllowDownscalingAtNight', {
schedule: autoscaling.Schedule.cron({ hour: '20', minute: '0' }),
minCapacity: 1
});
Properties
| Name | Type | Description |
|---|---|---|
| schedule | Schedule | When to perform this action. |
| desired | number | The new desired capacity. |
| end | date | When this scheduled action expires. |
| max | number | The new maximum capacity. |
| min | number | The new minimum capacity. |
| start | date | When this scheduled action becomes active. |
| time | string | Specifies the time zone for a cron expression. |
schedule
Type:
Schedule
When to perform this action.
Supports cron expressions.
For more information about cron expressions, see https://en.wikipedia.org/wiki/Cron.
desiredCapacity?
Type:
number
(optional, default: No new desired capacity.)
The new desired capacity.
At the scheduled time, set the desired capacity to the given capacity.
At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.
endTime?
Type:
date
(optional, default: The rule never expires.)
When this scheduled action expires.
maxCapacity?
Type:
number
(optional, default: No new maximum capacity.)
The new maximum capacity.
At the scheduled time, set the maximum capacity to the given capacity.
At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.
minCapacity?
Type:
number
(optional, default: No new minimum capacity.)
The new minimum capacity.
At the scheduled time, set the minimum capacity to the given capacity.
At least one of maxCapacity, minCapacity, or desiredCapacity must be supplied.
startTime?
Type:
date
(optional, default: The rule is activate immediately.)
When this scheduled action becomes active.
timeZone?
Type:
string
(optional, default: UTC)
Specifies the time zone for a cron expression.
If a time zone is not provided, UTC is used by default.
Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti).
For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.