ScheduledTaskProps

Properties for defining a ScheduledTask.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Ess;
new ScheduledTaskProps {
    object LaunchTime,
    object Description = null,
    object DesiredCapacity = null,
    object LaunchExpirationTime = null,
    object MaxValue = null,
    object MinValue = null,
    object RecurrenceEndTime = null,
    object RecurrenceType = null,
    object RecurrenceValue = null,
    object ScalingGroupId = null,
    object ScheduledAction = null,
    object ScheduledTaskName = null,
    object TaskEnabled = null
};

Properties

Name	Type	Description
LaunchTime	object	Property launchTime: Time point at which the scheduled task is triggered.
Description	object	Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
DesiredCapacity	object	Property desiredCapacity: The ID of the scaling group whose number of instances must be modified when the scheduled task is triggered.
LaunchExpirationTime	object	Property launchExpirationTime: Time period within which the failed scheduled task is retried.
MaxValue	object	Property maxValue: The expected number of instances in the scaling group if you specify the ScalingGroupId parameter.
MinValue	object	Property minValue: The maximum number of instances in the scaling group if you specify the ScalingGroupId parameter.
RecurrenceEndTime	object	Property recurrenceEndTime: End time of the scheduled task to be repeated.
RecurrenceType	object	Property recurrenceType: Type of the scheduled task to be repeated.
RecurrenceValue	object	Property recurrenceValue: Value of the scheduled task to be repeated.
ScalingGroupId	object	Property scalingGroupId: The globally unique ID of the scheduled task.
ScheduledAction	object	Property scheduledAction: Operations performed when the scheduled task is triggered.
ScheduledTaskName	object	Property scheduledTaskName: Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
TaskEnabled	object	Property taskEnabled: Whether to enable the scheduled task.

---

LaunchTime^Required

public object LaunchTime { get; set; }

• Type: object

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.

---

Description^Optional

public object Description { get; set; }

• Type: object

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

---

DesiredCapacity^Optional

public object DesiredCapacity { get; set; }

• Type: object

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.

---

LaunchExpirationTime^Optional

public object LaunchExpirationTime { get; set; }

• Type: object

Property launchExpirationTime: Time period within which the failed scheduled task is retried.

The default value is 600s. Value range: [0, 21600]

---

MaxValue^Optional

public object MaxValue { get; set; }

• Type: object

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.

---

MinValue^Optional

public object MinValue { get; set; }

• Type: object

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

---

RecurrenceEndTime^Optional

public object RecurrenceEndTime { get; set; }

• Type: object

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.

---

RecurrenceType^Optional

public object RecurrenceType { get; set; }

• Type: object

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.

---

RecurrenceValue^Optional

public object RecurrenceValue { get; set; }

• Type: object

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.

---

ScalingGroupId^Optional

public object ScalingGroupId { get; set; }

• Type: object

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.

---

ScheduledAction^Optional

public object ScheduledAction { get; set; }

• Type: object

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.

---

ScheduledTaskName^Optional

public object ScheduledTaskName { get; set; }

• Type: object

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.

---

TaskEnabled^Optional

public object TaskEnabled { get; set; }

• Type: object

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.

---