ScheduledActionProps¶
-
class
aws_cdk.aws_autoscaling.
ScheduledActionProps
(*, schedule, desired_capacity=None, end_time=None, max_capacity=None, min_capacity=None, start_time=None, auto_scaling_group)¶ Bases:
aws_cdk.aws_autoscaling.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.auto_scaling_group (
IAutoScalingGroup
) – The AutoScalingGroup to apply the scheduled actions to.
Attributes
-
auto_scaling_group
¶ The AutoScalingGroup to apply the scheduled actions to.
- Return type
-
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.
- Return type
Union
[int
,float
,None
]
-
end_time
¶ When this scheduled action expires.
- Default
The rule never expires.
- Return type
Optional
[datetime
]
-
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.
- Return type
Union
[int
,float
,None
]
-
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.
- Return type
Union
[int
,float
,None
]
-
schedule
¶ When to perform this action.
Supports cron expressions.
For more information about cron expressions, see https://en.wikipedia.org/wiki/Cron.
Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826 08 * * ?
- Return type
-
start_time
¶ When this scheduled action becomes active.
- Default
The rule is activate immediately.
- Return type
Optional
[datetime
]