ScheduledTaskProps
Properties for defining a ScheduledTask.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ess-scheduledtask
Initializer
import ros_cdk_ess
ros_cdk_ess.ScheduledTaskProps(
launch_time: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
desired_capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
launch_expiration_time: typing.Union[typing.Union[int, float], IResolvable] = None,
max_value: typing.Union[typing.Union[int, float], IResolvable] = None,
min_value: typing.Union[typing.Union[int, float], IResolvable] = None,
recurrence_end_time: typing.Union[str, IResolvable] = None,
recurrence_type: typing.Union[str, IResolvable] = None,
recurrence_value: typing.Union[str, IResolvable] = None,
scaling_group_id: typing.Union[str, IResolvable] = None,
scheduled_action: typing.Union[str, IResolvable] = None,
scheduled_task_name: typing.Union[str, IResolvable] = None,
task_enabled: typing.Union[bool, IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
launch_time |
typing.Union[str, ros_cdk_core.IResolvable] |
Property launchTime: Time point at which the scheduled task is triggered. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long. |
desired_capacity |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property desiredCapacity: The ID of the scaling group whose number of instances must be modified when the scheduled task is triggered. |
launch_expiration_time |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property launchExpirationTime: Time period within which the failed scheduled task is retried. |
max_value |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property maxValue: The expected number of instances in the scaling group if you specify the ScalingGroupId parameter. |
min_value |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property minValue: The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter. |
recurrence_end_time |
typing.Union[str, ros_cdk_core.IResolvable] |
Property recurrenceEndTime: End time of the scheduled task to be repeated. |
recurrence_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property recurrenceType: Type of the scheduled task to be repeated. |
recurrence_value |
typing.Union[str, ros_cdk_core.IResolvable] |
Property recurrenceValue: Value of the scheduled task to be repeated. |
scaling_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property scalingGroupId: The globally unique ID of the scheduled task. |
scheduled_action |
typing.Union[str, ros_cdk_core.IResolvable] |
Property scheduledAction: Operations performed when the scheduled task is triggered. |
scheduled_task_name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property scheduledTaskName: Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long. |
task_enabled |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property taskEnabled: Whether to enable the scheduled task. |
launch_timeRequired
launch_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property launchTime: Time point at which the scheduled task is triggered.
The date format follows the ISO8601 standard and uses UTC time. It is in the format of YYYY-MM-DDThh:mmZ. If RecurrenceType is specified, the time point specified by this attribute is the default time point at which the circle is executed. If RecurrenceType is not specified, the task is executed once on the designated date and time. A time point 90 days after creation or modification cannot be entered.
descriptionOptional
description: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
desired_capacityOptional
desired_capacity: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property desiredCapacity: The ID of the scaling group whose number of instances must be modified when the scheduled task is triggered.
If you specify the ScalingGroupId parameter for a scheduled task, you must specify the minimum, maximum, or expected numbers of instances for a scaling group in the scheduled task. That is, you must specify at least one of the MinValue, MaxValue, and DesiredCapacity parameters.
launch_expiration_timeOptional
launch_expiration_time: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property launchExpirationTime: Time period within which the failed scheduled task is retried.
The default value is 600s. Value range: [0, 21600]
max_valueOptional
max_value: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property maxValue: The expected number of instances in the scaling group if you specify the ScalingGroupId parameter.
Note: You must specify the DesiredCapacity parameter when you create a scaling group.
min_valueOptional
min_value: typing.Union[typing.Union[int, float], IResolvable]
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property minValue: The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.
recurrence_end_timeOptional
recurrence_end_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property recurrenceEndTime: End time of the scheduled task to be repeated.
The date format follows the ISO8601 standard and uses UTC time. It is in the format of YYYY-MM-DDThh:mmZ. A time point 90 days after creation or modification cannot be entered. RecurrenceType, RecurrenceValue and RecurrenceEndTime must be specified.
recurrence_typeOptional
recurrence_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property recurrenceType: Type of the scheduled task to be repeated.
Optional values:
- Daily: Recurrence interval by day for a scheduled task.
- Weekly: Recurrence interval by week for a scheduled task.
- Monthly: Recurrence interval by month for a scheduled task. RecurrenceType, RecurrenceValue and RecurrenceEndTime must be specified.
recurrence_valueOptional
recurrence_value: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property recurrenceValue: Value of the scheduled task to be repeated.
- Daily: Only one value in the range [1,31] can be filled.
- Weekly: Multiple values can be filled. The values of Sunday to Saturday are 0 to 6 in sequence. Multiple values shall be separated by a comma ",".
- Monthly: In the format of A-B. The value range of A and B is 1 to 31, and the B value must be greater than the A value. RecurrenceType, RecurrenceValue and RecurrenceEndTime must be specified.
scaling_group_idOptional
scaling_group_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property scalingGroupId: The globally unique ID of the scheduled task.
The globally unique ID is generated by the system. Note: You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.
scheduled_actionOptional
scheduled_action: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property scheduledAction: Operations performed when the scheduled task is triggered.
Fill in the unique identifier of the scaling rule. Note: You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.
scheduled_task_nameOptional
scheduled_task_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property scheduledTaskName: Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
It must begin with a number, an upper/lower-case letter or a Chinese character and may contain numbers, "_", "-" or ".". The account name is unique in the same region. If this parameter is not specified, the default value ScheduledScalingTaskId is used.
task_enabledOptional
task_enabled: typing.Union[bool, IResolvable]
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property taskEnabled: Whether to enable the scheduled task.
- When the parameter is set to true, the task is enabled.
- When the parameter is set to false, the task is disabled. The default value is true.