ScheduledTaskProps
Properties for defining a ScheduledTask.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ess-scheduledtask
Initializer
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkess"
&alicloudroscdkess.ScheduledTaskProps {
LaunchTime: interface{},
Description: interface{},
DesiredCapacity: interface{},
LaunchExpirationTime: interface{},
MaxValue: interface{},
MinValue: interface{},
RecurrenceEndTime: interface{},
RecurrenceType: interface{},
RecurrenceValue: interface{},
ScalingGroupId: interface{},
ScheduledAction: interface{},
ScheduledTaskName: interface{},
TaskEnabled: interface{},
}
Properties
| Name | Type | Description |
|---|---|---|
LaunchTime | interface{} | Property launchTime: Time point at which the scheduled task is triggered. |
Description | interface{} | Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long. |
DesiredCapacity | interface{} | Property desiredCapacity: The expected number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances. |
LaunchExpirationTime | interface{} | Property launchExpirationTime: Time period within which the failed scheduled task is retried. |
MaxValue | interface{} | Property maxValue: The maximum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances. |
MinValue | interface{} | Property minValue: The minimum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances. |
RecurrenceEndTime | interface{} | Property recurrenceEndTime: The end time of the scheduled task. |
RecurrenceType | interface{} | Property recurrenceType: The interval at which the scheduled task is repeatedly executed. |
RecurrenceValue | interface{} | Property recurrenceValue: Value of the scheduled task to be repeated. |
ScalingGroupId | interface{} | Property scalingGroupId: The ID of the scaling group whose number of instances is changed when the scheduled task is triggered. |
ScheduledAction | interface{} | Property scheduledAction: The scaling rule that you want to execute when the scheduled task is triggered. |
ScheduledTaskName | interface{} | Property scheduledTaskName: The name of the scheduled task. |
TaskEnabled | interface{} | Property taskEnabled: Whether to enable the scheduled task. |
LaunchTimeRequired
LaunchTime interface{}
- Type: interface{}
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 interface{}
- Type: interface{}
Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
DesiredCapacityOptional
DesiredCapacity interface{}
- Type: interface{}
Property desiredCapacity: The expected number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.
You must specify the
DesiredCapacityparameter when you create a scaling group.
LaunchExpirationTimeOptional
LaunchExpirationTime interface{}
- Type: interface{}
Property launchExpirationTime: Time period within which the failed scheduled task is retried.
The default value is 600s. Value range: [0, 21600]
MaxValueOptional
MaxValue interface{}
- Type: interface{}
Property maxValue: The maximum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.
MinValueOptional
MinValue interface{}
- Type: interface{}
Property minValue: The minimum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.
RecurrenceEndTimeOptional
RecurrenceEndTime interface{}
- Type: interface{}
Property recurrenceEndTime: The end time of the scheduled task.
Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a point in time that is later than 365 days from the point in time at which the scheduled task is created.
RecurrenceTypeOptional
RecurrenceType interface{}
- Type: interface{}
Property recurrenceType: The interval at which the scheduled task is repeatedly executed.
Valid values:
- Daily: The scheduled task is executed once every specified number of days.
- Weekly: The scheduled task is executed on each specified day of a week.
- Monthly: The scheduled task is executed on each specified day of a month.
- Cron: The scheduled task is executed based on the specified cron expression. You must specify the
RecurrenceTypeandRecurrenceValueparameters at the same time.
RecurrenceValueOptional
RecurrenceValue interface{}
- Type: interface{}
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.
- Cron: A cron expression is written in UTC time and consists of the following fields: minute, hour, day, month, and week. The expression can contain the letters L and W and the following wildcard characters: commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), and forward slashes (/). RecurrenceType, RecurrenceValue and RecurrenceEndTime must be specified.
ScalingGroupIdOptional
ScalingGroupId interface{}
- Type: interface{}
Property scalingGroupId: The ID of the scaling group whose number of instances is changed when the scheduled task is triggered.
If you specify the ScalingGroupId parameter for a scheduled task, the scaling method of the scheduled task is to specify the number of instances in the scaling group. In this case, you must specify at least one of the MinValue, MaxValue, and DesiredCapacity parameters.
You cannot specify the
ScheduledActionandScalingGroupIdparameters at the same time.
ScheduledActionOptional
ScheduledAction interface{}
- Type: interface{}
Property scheduledAction: The scaling rule that you want to execute when the scheduled task is triggered.
Specify the unique identifier of the scaling rule. If you specify the ScheduledAction parameter, you must select an existing scaling rule for the scheduled task.
You cannot specify the
ScheduledActionandScalingGroupIdparameters at the same time.
ScheduledTaskNameOptional
ScheduledTaskName interface{}
- Type: interface{}
Property scheduledTaskName: The name of the scheduled task.
The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit. The name of the scheduled task must be unique in the region and within the account. By default, the value of the ScheduledTaskId parameter is used.
TaskEnabledOptional
TaskEnabled interface{}
- Type: interface{}
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.