CfnScheduledActionProps¶
-
class
aws_cdk.aws_autoscaling.
CfnScheduledActionProps
(*, auto_scaling_group_name, desired_capacity=None, end_time=None, max_size=None, min_size=None, recurrence=None, start_time=None, time_zone=None)¶ Bases:
object
Properties for defining a
CfnScheduledAction
.- Parameters
auto_scaling_group_name (
str
) – The name of the Auto Scaling group.desired_capacity (
Union
[int
,float
,None
]) – The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions. You must specify at least one of the following properties:MaxSize
,MinSize
, orDesiredCapacity
.end_time (
Optional
[str
]) – The date and time for the recurring schedule to end, in UTC. For example,"2021-06-01T00:00:00Z"
.max_size (
Union
[int
,float
,None
]) – The maximum size of the Auto Scaling group. You must specify at least one of the following properties:MaxSize
,MinSize
, orDesiredCapacity
.min_size (
Union
[int
,float
,None
]) – The minimum size of the Auto Scaling group. You must specify at least one of the following properties:MaxSize
,MinSize
, orDesiredCapacity
.recurrence (
Optional
[str
]) – The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see Crontab . WhenStartTime
andEndTime
are specified withRecurrence
, they form the boundaries of when the recurring action starts and stops. Cron expressions use Universal Coordinated Time (UTC) by default.start_time (
Optional
[str
]) – The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only. For example,"2021-06-01T00:00:00Z"
. If you specifyRecurrence
andStartTime
, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.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 asEtc/GMT+9
orPacific/Tahiti
). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones .
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-as-scheduledaction.html
- 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 cfn_scheduled_action_props = autoscaling.CfnScheduledActionProps( auto_scaling_group_name="autoScalingGroupName", # the properties below are optional desired_capacity=123, end_time="endTime", max_size=123, min_size=123, recurrence="recurrence", start_time="startTime", time_zone="timeZone" )
Attributes
-
auto_scaling_group_name
¶ The name of the Auto Scaling group.
-
desired_capacity
¶ The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.
It can scale beyond this capacity if you add more scaling conditions.
You must specify at least one of the following properties:
MaxSize
,MinSize
, orDesiredCapacity
.- Link
- Return type
Union
[int
,float
,None
]
-
end_time
¶ The date and time for the recurring schedule to end, in UTC.
For example,
"2021-06-01T00:00:00Z"
.
-
max_size
¶ The maximum size of the Auto Scaling group.
You must specify at least one of the following properties:
MaxSize
,MinSize
, orDesiredCapacity
.- Link
- Return type
Union
[int
,float
,None
]
-
min_size
¶ The minimum size of the Auto Scaling group.
You must specify at least one of the following properties:
MaxSize
,MinSize
, orDesiredCapacity
.- Link
- Return type
Union
[int
,float
,None
]
-
recurrence
¶ The recurring schedule for this action.
This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. For more information about this format, see Crontab .
When
StartTime
andEndTime
are specified withRecurrence
, they form the boundaries of when the recurring action starts and stops.Cron expressions use Universal Coordinated Time (UTC) by default.
-
start_time
¶ ssZ format in UTC/GMT only. For example,
"2021-06-01T00:00:00Z"
.If you specify
Recurrence
andStartTime
, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.- Link
- Type
The date and time for this action to start, in YYYY-MM-DDThh
- Type
mm
- Return type
Optional
[str
]
-
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
orPacific/Tahiti
). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones .