ScheduledActionProps
- class aws_cdk.aws_autoscaling.ScheduledActionProps(*, schedule, desired_capacity=None, end_time=None, max_capacity=None, min_capacity=None, start_time=None, time_zone=None, auto_scaling_group)
Bases:
BasicScheduledActionProps
Properties for a scheduled action on an AutoScalingGroup.
- Parameters:
schedule (
Schedule
) – When to perform this action. Supports cron expressions. For more information about cron expressions, see https://en.wikipedia.org/wiki/Cron.desired_capacity (
Union
[int
,float
,None
]) – 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. Default: - No new desired capacity.end_time (
Optional
[datetime
]) – When this scheduled action expires. Default: - The rule never expires.max_capacity (
Union
[int
,float
,None
]) – 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. Default: - No new maximum capacity.min_capacity (
Union
[int
,float
,None
]) – 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. Default: - No new minimum capacity.start_time (
Optional
[datetime
]) – When this scheduled action becomes active. Default: - The rule is activate immediately.time_zone (
Optional
[str
]) – 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. Default: - UTCauto_scaling_group (
IAutoScalingGroup
) – The AutoScalingGroup to apply the scheduled actions to.
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_autoscaling as autoscaling # auto_scaling_group: autoscaling.AutoScalingGroup # schedule: autoscaling.Schedule scheduled_action_props = autoscaling.ScheduledActionProps( auto_scaling_group=auto_scaling_group, schedule=schedule, # the properties below are optional desired_capacity=123, end_time=Date(), max_capacity=123, min_capacity=123, start_time=Date(), time_zone="timeZone" )
Attributes
- auto_scaling_group
The AutoScalingGroup to apply the scheduled actions to.
- 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.
- Default:
No new desired capacity.
- end_time
When this scheduled action expires.
- Default:
The rule never expires.
- max_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.
- Default:
No new maximum capacity.
- min_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.
- Default:
No new minimum capacity.
- schedule
When to perform this action.
Supports cron expressions.
For more information about cron expressions, see https://en.wikipedia.org/wiki/Cron.
- start_time
When this scheduled action becomes active.
- Default:
The rule is activate immediately.
- time_zone
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.
- Default:
UTC