ALIYUN::FNF::Schedule-Resource Orchestration Service(ROS)-阿里云帮助中心

The ALIYUN::FNF::Schedule resource creates a timed schedule.

Syntax

{
  "Type": "ALIYUN::FNF::Schedule",
  "Properties": {
    "Description": String,
    "FlowName": String,
    "Enable": Boolean,
    "Payload": String,
    "CronExpression": String,
    "ScheduleName": String
  }
}

Properties

Property name	Type	Required	Updates allowed	Description	Constraints
Description	String	No	Yes	The description of the timed schedule.	None
FlowName	String	Yes	No	The name of the workflow that is attached to the timed schedule.	None
Enable	Boolean	No	Yes	Specifies whether to enable the timed schedule.	Valid values: true false
Payload	String	No	Yes	The message that is passed to the workflow when the timed schedule is triggered.	The value must be in the JSON format. For example: `"{\"key\": \"value\"}"`.
CronExpression	String	Yes	Yes	The cron expression.	None
ScheduleName	String	Yes	No	The name of the timed schedule.	None

Return values

Fn::GetAtt

FlowName: The name of the attached workflow.
ScheduleId: The ID of the schedule.
ScheduleName: The name of the schedule.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Schedule:
    Type: ALIYUN::FNF::Schedule
    Properties:
      FlowName: TestFlow
      Enable: false
      Payload: '{"key": "value"}'
      CronExpression: 0 0 10 1 * ?
      ScheduleName: TestSchedule
Outputs: {}

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Schedule": {
      "Type": "ALIYUN::FNF::Schedule",
      "Properties": {
        "FlowName": "TestFlow",
        "Enable": false,
        "Payload": "{\"key\": \"value\"}",
        "CronExpression": "0 0 10 1 * ?",
        "ScheduleName": "TestSchedule"
      }
    }
  },
  "Outputs": {
  }
}