1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. ess
  5. ScheduledTask
Alibaba Cloud v3.51.0 published on Saturday, Mar 23, 2024 by Pulumi

alicloud.ess.ScheduledTask

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.51.0 published on Saturday, Mar 23, 2024 by Pulumi

    Provides a ESS schedule resource.

    For information about ess schedule task, see Scheduled Tasks.

    NOTE: Available since v1.60.0.

    Create ScheduledTask Resource

    new ScheduledTask(name: string, args?: ScheduledTaskArgs, opts?: CustomResourceOptions);
    @overload
    def ScheduledTask(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      description: Optional[str] = None,
                      desired_capacity: Optional[int] = None,
                      launch_expiration_time: Optional[int] = None,
                      launch_time: Optional[str] = None,
                      max_value: Optional[int] = None,
                      min_value: Optional[int] = None,
                      recurrence_end_time: Optional[str] = None,
                      recurrence_type: Optional[str] = None,
                      recurrence_value: Optional[str] = None,
                      scaling_group_id: Optional[str] = None,
                      scheduled_action: Optional[str] = None,
                      scheduled_task_name: Optional[str] = None,
                      task_enabled: Optional[bool] = None)
    @overload
    def ScheduledTask(resource_name: str,
                      args: Optional[ScheduledTaskArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    func NewScheduledTask(ctx *Context, name string, args *ScheduledTaskArgs, opts ...ResourceOption) (*ScheduledTask, error)
    public ScheduledTask(string name, ScheduledTaskArgs? args = null, CustomResourceOptions? opts = null)
    public ScheduledTask(String name, ScheduledTaskArgs args)
    public ScheduledTask(String name, ScheduledTaskArgs args, CustomResourceOptions options)
    
    type: alicloud:ess:ScheduledTask
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ScheduledTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScheduledTaskArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScheduledTaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScheduledTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScheduledTaskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScheduledTask Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ScheduledTask resource accepts the following input properties:

    Description string
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    DesiredCapacity int
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    LaunchExpirationTime int
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    LaunchTime string
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    MaxValue int
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    MinValue int
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    RecurrenceEndTime string
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    RecurrenceType string
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    RecurrenceValue string
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    ScalingGroupId string
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledAction string
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledTaskName string
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    TaskEnabled bool
    Specifies whether to start the scheduled task. Default to true.
    Description string
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    DesiredCapacity int
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    LaunchExpirationTime int
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    LaunchTime string
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    MaxValue int
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    MinValue int
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    RecurrenceEndTime string
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    RecurrenceType string
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    RecurrenceValue string
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    ScalingGroupId string
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledAction string
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledTaskName string
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    TaskEnabled bool
    Specifies whether to start the scheduled task. Default to true.
    description String
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desiredCapacity Integer
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launchExpirationTime Integer
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launchTime String
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    maxValue Integer
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    minValue Integer
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrenceEndTime String
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrenceType String
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrenceValue String
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scalingGroupId String
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledAction String
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledTaskName String
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    taskEnabled Boolean
    Specifies whether to start the scheduled task. Default to true.
    description string
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desiredCapacity number
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launchExpirationTime number
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launchTime string
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    maxValue number
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    minValue number
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrenceEndTime string
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrenceType string
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrenceValue string
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scalingGroupId string
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledAction string
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledTaskName string
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    taskEnabled boolean
    Specifies whether to start the scheduled task. Default to true.
    description str
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desired_capacity int
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launch_expiration_time int
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launch_time str
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    max_value int
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    min_value int
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrence_end_time str
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrence_type str
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrence_value str
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scaling_group_id str
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduled_action str
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduled_task_name str
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    task_enabled bool
    Specifies whether to start the scheduled task. Default to true.
    description String
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desiredCapacity Number
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launchExpirationTime Number
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launchTime String
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    maxValue Number
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    minValue Number
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrenceEndTime String
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrenceType String
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrenceValue String
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scalingGroupId String
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledAction String
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledTaskName String
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    taskEnabled Boolean
    Specifies whether to start the scheduled task. Default to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScheduledTask resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ScheduledTask Resource

    Get an existing ScheduledTask resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ScheduledTaskState, opts?: CustomResourceOptions): ScheduledTask
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            desired_capacity: Optional[int] = None,
            launch_expiration_time: Optional[int] = None,
            launch_time: Optional[str] = None,
            max_value: Optional[int] = None,
            min_value: Optional[int] = None,
            recurrence_end_time: Optional[str] = None,
            recurrence_type: Optional[str] = None,
            recurrence_value: Optional[str] = None,
            scaling_group_id: Optional[str] = None,
            scheduled_action: Optional[str] = None,
            scheduled_task_name: Optional[str] = None,
            task_enabled: Optional[bool] = None) -> ScheduledTask
    func GetScheduledTask(ctx *Context, name string, id IDInput, state *ScheduledTaskState, opts ...ResourceOption) (*ScheduledTask, error)
    public static ScheduledTask Get(string name, Input<string> id, ScheduledTaskState? state, CustomResourceOptions? opts = null)
    public static ScheduledTask get(String name, Output<String> id, ScheduledTaskState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    DesiredCapacity int
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    LaunchExpirationTime int
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    LaunchTime string
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    MaxValue int
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    MinValue int
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    RecurrenceEndTime string
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    RecurrenceType string
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    RecurrenceValue string
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    ScalingGroupId string
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledAction string
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledTaskName string
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    TaskEnabled bool
    Specifies whether to start the scheduled task. Default to true.
    Description string
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    DesiredCapacity int
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    LaunchExpirationTime int
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    LaunchTime string
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    MaxValue int
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    MinValue int
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    RecurrenceEndTime string
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    RecurrenceType string
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    RecurrenceValue string
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    ScalingGroupId string
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledAction string
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    ScheduledTaskName string
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    TaskEnabled bool
    Specifies whether to start the scheduled task. Default to true.
    description String
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desiredCapacity Integer
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launchExpirationTime Integer
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launchTime String
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    maxValue Integer
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    minValue Integer
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrenceEndTime String
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrenceType String
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrenceValue String
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scalingGroupId String
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledAction String
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledTaskName String
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    taskEnabled Boolean
    Specifies whether to start the scheduled task. Default to true.
    description string
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desiredCapacity number
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launchExpirationTime number
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launchTime string
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    maxValue number
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    minValue number
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrenceEndTime string
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrenceType string
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrenceValue string
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scalingGroupId string
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledAction string
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledTaskName string
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    taskEnabled boolean
    Specifies whether to start the scheduled task. Default to true.
    description str
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desired_capacity int
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launch_expiration_time int
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launch_time str
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    max_value int
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    min_value int
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrence_end_time str
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrence_type str
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrence_value str
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scaling_group_id str
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduled_action str
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduled_task_name str
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    task_enabled bool
    Specifies whether to start the scheduled task. Default to true.
    description String
    Description of the scheduled task, which is 2-200 characters (English or Chinese) long.
    desiredCapacity Number
    The expected number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group. NOTE: You must specify the DesiredCapacity parameter when you create the scaling group.
    launchExpirationTime Number
    The time period during which a failed scheduled task is retried. Unit: seconds. Valid values: 0 to 21600. Default value: 600
    launchTime String
    The time at which the scheduled task is triggered. 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 time point later than 90 days from the date of scheduled task creation. If the recurrence_type parameter is specified, the task is executed repeatedly at the time specified by LaunchTime. Otherwise, the task is only executed once at the date and time specified by LaunchTime.
    maxValue Number
    The maximum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    minValue Number
    The minimum number of instances in a scaling group when the scaling method of the scheduled task is to specify the number of instances in a scaling group.
    recurrenceEndTime String
    Specifies the end time after which the scheduled task is no longer repeated. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC. You cannot enter a time point later than 365 days from the date of scheduled task creation. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time.
    recurrenceType String
    Specifies the recurrence type of the scheduled task. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. 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: (Available in 1.60.0+) The scheduled task is executed based on the specified cron expression.
    recurrenceValue String
    Specifies how often a scheduled task recurs. NOTE: You must specify RecurrenceType, RecurrenceValue, and RecurrenceEndTime at the same time. The valid value depends on recurrence_type

    • Daily: You can enter one value. Valid values: 1 to 31.
    • Weekly: You can enter multiple values and separate them with commas (,). For example, the values 0 to 6 correspond to the days of the week in sequence from Sunday to Saturday.
    • Monthly: You can enter two values in A-B format. Valid values of A and B: 1 to 31. The value of B must be greater than or equal to the value of A.
    • Cron: You can enter a cron expression which is written in UTC and consists of five fields: minute, hour, day of month (date), month, and day of week. The expression can contain wildcard characters including commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), forward slashes (/), and the L and W letters.
    scalingGroupId String
    The ID of the scaling group where the number of instances is modified when the scheduled task is triggered. After the ScalingGroupId parameter is specified, the scaling method of the scheduled task is to specify the number of instances in a scaling group. You must specify at least one of the following parameters: MinValue, MaxValue, and DesiredCapacity. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledAction String
    The operation to be performed when a scheduled task is triggered. Enter the unique identifier of a scaling rule. NOTE: You cannot specify scheduled_action and scaling_group_id at the same time.
    scheduledTaskName String
    Display name of the scheduled task, which must be 2-40 characters (English or Chinese) long.
    taskEnabled Boolean
    Specifies whether to start the scheduled task. Default to true.

    Import

    ESS schedule task can be imported using the id, e.g.

    $ pulumi import alicloud:ess/scheduledTask:ScheduledTask example abc123456
    

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.51.0 published on Saturday, Mar 23, 2024 by Pulumi