interface ScheduledActionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AutoScaling.ScheduledActionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsautoscaling#ScheduledActionProps |
![]() | software.amazon.awscdk.services.autoscaling.ScheduledActionProps |
![]() | aws_cdk.aws_autoscaling.ScheduledActionProps |
![]() | aws-cdk-lib » aws_autoscaling » ScheduledActionProps |
Properties for a scheduled action on an AutoScalingGroup.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
declare const autoScalingGroup: autoscaling.AutoScalingGroup;
declare const schedule: autoscaling.Schedule;
const scheduledActionProps: autoscaling.ScheduledActionProps = {
autoScalingGroup: autoScalingGroup,
schedule: schedule,
// the properties below are optional
desiredCapacity: 123,
endTime: new Date(),
maxCapacity: 123,
minCapacity: 123,
startTime: new Date(),
timeZone: 'timeZone',
};
Properties
Name | Type | Description |
---|---|---|
auto | IAuto | The AutoScalingGroup to apply the scheduled actions to. |
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. |
autoScalingGroup
Type:
IAuto
The AutoScalingGroup to apply the scheduled actions to.
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.