Skip to content

ScheduledTaskProps

Properties for defining a ScheduledTask.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ess-scheduledtask

Initializer 

import { ScheduledTaskProps } from '@alicloud/ros-cdk-ess'
const scheduledTaskProps: ScheduledTaskProps = { ... }

Properties

Name Type Description
launchTime string | @alicloud/ros-cdk-core.IResolvable Property launchTime: Time point at which the scheduled task is triggered.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
desiredCapacity number | @alicloud/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.
launchExpirationTime number | @alicloud/ros-cdk-core.IResolvable Property launchExpirationTime: Time period within which the failed scheduled task is retried.
maxValue number | @alicloud/ros-cdk-core.IResolvable Property maxValue: The expected number of instances in the scaling group if you specify the ScalingGroupId parameter.
minValue number | @alicloud/ros-cdk-core.IResolvable Property minValue: The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.
recurrenceEndTime string | @alicloud/ros-cdk-core.IResolvable Property recurrenceEndTime: End time of the scheduled task to be repeated.
recurrenceType string | @alicloud/ros-cdk-core.IResolvable Property recurrenceType: Type of the scheduled task to be repeated.
recurrenceValue string | @alicloud/ros-cdk-core.IResolvable Property recurrenceValue: Value of the scheduled task to be repeated.
scalingGroupId string | @alicloud/ros-cdk-core.IResolvable Property scalingGroupId: The globally unique ID of the scheduled task.
scheduledAction string | @alicloud/ros-cdk-core.IResolvable Property scheduledAction: Operations performed when the scheduled task is triggered.
scheduledTaskName string | @alicloud/ros-cdk-core.IResolvable Property scheduledTaskName: Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
taskEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property taskEnabled: Whether to enable the scheduled task.

launchTimeRequired 

public readonly launchTime: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.

desiredCapacityOptional 

public readonly desiredCapacity: number | IResolvable;
  • Type: number | @alicloud/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.

launchExpirationTimeOptional 

public readonly launchExpirationTime: number | IResolvable;
  • Type: number | @alicloud/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]

maxValueOptional 

public readonly maxValue: number | IResolvable;
  • Type: number | @alicloud/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.

minValueOptional 

public readonly minValue: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property minValue: The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.

recurrenceEndTimeOptional 

public readonly recurrenceEndTime: string | IResolvable;
  • Type: string | @alicloud/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.

recurrenceTypeOptional 

public readonly recurrenceType: string | IResolvable;
  • Type: string | @alicloud/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.

recurrenceValueOptional 

public readonly recurrenceValue: string | IResolvable;
  • Type: string | @alicloud/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.

scalingGroupIdOptional 

public readonly scalingGroupId: string | IResolvable;
  • Type: string | @alicloud/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.

scheduledActionOptional 

public readonly scheduledAction: string | IResolvable;
  • Type: string | @alicloud/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.

scheduledTaskNameOptional 

public readonly scheduledTaskName: string | IResolvable;
  • Type: string | @alicloud/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.

taskEnabledOptional 

public readonly taskEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/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.