ALIYUN::SchedulerX::WorkFlow -

The ALIYUN::SchedulerX::WorkFlow resource creates a workflow.

Syntax

{
  "Type": "ALIYUN::SchedulerX::WorkFlow",
  "Properties": {
    "GroupId": String,
    "Namespace": String,
    "TimeType": Integer,
    "WorkflowName": String,
    "Description": String,
    "MaxConcurrency": Integer,
    "NamespaceSource": String,
    "Timezone": String,
    "TimeExpression": String
  }
}

Properties

Parameter	Type	Required	Editable	Description	Constraints
GroupId	String	Yes	No	The ID of the application group. You can find this ID on the application management page in the console.	None
Namespace	String	Yes	No	The ID of the namespace. You can find this ID on the namespace page in the console.	None
TimeType	Integer	Yes	Yes	The trigger type for the workflow.	Valid values: cron: 1 api: 100
WorkflowName	String	Yes	Yes	The workflow name.	None
Description	String	No	Yes	The workflow description.	None
MaxConcurrency	Integer	No	No	The maximum number of concurrent workflow instances.	The default value is 1. If a previous run is not complete, the next run will not start even if the scheduled time is reached.
NamespaceSource	String	No	No	The source of the namespace, required for specific third-party integrations.	None
TimeExpression	String	No	Yes	The time expression.	The format of this expression depends on the `TimeType` value. - If TimeType is 1 (cron), specify a standard cron expression. Online validation is supported. - If TimeType is 100 (api), this property is not used.
Timezone	String	No	No	The time zone for the schedule.	None

Return values

Fn::GetAtt

WorkFlowId: The workflow ID.
Description: The workflow description.
WorkflowName: The workflow name.
MaxConcurrency: The maximum number of concurrent workflow instances.
TimeExpression: The time expression.
Namespace: The namespace ID.
TimeType: The time type.
GroupId: The application group ID.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Description:
    AssociationProperty: TextArea
    Description: The description of the workflow.
    Required: false
    Type: String
  GroupId:
    Description: The ID of the application group. You can obtain this ID from the application
      management page in the console.
    Required: true
    Type: String
  MaxConcurrency:
    Description: 'The maximum number of concurrent workflow instances. The default
      value is 1. If a previous run has not completed, the next run will not start
      even if the scheduled time is reached.'
    Required: false
    Type: Number
  Namespace:
    Description: The ID of the namespace. You can obtain this ID from the namespace
      page in the console.
    Required: true
    Type: String
  NamespaceSource:
    Description: Specifies the source of the namespace, which is required for specific
      third-party integrations.
    Required: false
    Type: String
  TimeExpression:
    Description: 'The time expression. This property is configured based on the value of
      TimeType.

      - If `TimeType` is `1` (cron), specify a standard cron expression.

      - If `TimeType` is `100` (api), this property is not used.'
    Required: false
    Type: String
  TimeType:
    AllowedValues:
      - 1
      - 100
    Description: 'The time type that triggers the workflow. Valid values:

      - 1: cron

      - 100: api'
    Required: true
    Type: Number
  Timezone:
    Description: The time zone for the schedule.
    Required: false
    Type: String
  WorkflowName:
    Description: The name of the workflow.
    Required: true
    Type: String
Resources:
  ExtensionResource:
    Properties:
      Description:
        Ref: Description
      GroupId:
        Ref: GroupId
      MaxConcurrency:
        Ref: MaxConcurrency
      Namespace:
        Ref: Namespace
      NamespaceSource:
        Ref: NamespaceSource
      TimeExpression:
        Ref: TimeExpression
      TimeType:
        Ref: TimeType
      Timezone:
        Ref: Timezone
      WorkflowName:
        Ref: WorkflowName
    Type: ALIYUN::SchedulerX::WorkFlow
Outputs:
  Description:
    Description: The description of the workflow.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Description
  GroupId:
    Description: The ID of the application group.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - GroupId
  MaxConcurrency:
    Description: The maximum number of concurrent workflow instances.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - MaxConcurrency
  Namespace:
    Description: The ID of the namespace.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Namespace
  TimeExpression:
    Description: The time expression.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TimeExpression
  TimeType:
    Description: The time type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - TimeType
  WorkFlowId:
    Description: The ID of the workflow.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WorkFlowId
  WorkflowName:
    Description: The name of the workflow.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - WorkflowName

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Timezone": {
      "Type": "String",
      "Description": "The time zone for the schedule.",
      "Required": false
    },
    "Description": {
      "Type": "String",
      "AssociationProperty": "TextArea",
      "Description": "The description of the workflow.",
      "Required": false
    },
    "WorkflowName": {
      "Type": "String",
      "Description": "The name of the workflow.",
      "Required": true
    },
    "NamespaceSource": {
      "Type": "String",
      "Description": "Specifies the source of the namespace, which is required for specific third-party integrations.",
      "Required": false
    },
    "MaxConcurrency": {
      "Type": "Number",
      "Description": "The maximum number of concurrent workflow instances. The default value is 1. If a previous run has not completed, the next run will not start even if the scheduled time is reached.",
      "Required": false
    },
    "TimeExpression": {
      "Type": "String",
      "Description": "The time expression. This property is configured based on the value of TimeType.\n- If `TimeType` is `1` (cron), specify a standard cron expression.\n- If `TimeType` is `100` (api), this property is not used.",
      "Required": false
    },
    "Namespace": {
      "Type": "String",
      "Description": "The ID of the namespace. You can obtain this ID from the namespace page in the console.",
      "Required": true
    },
    "TimeType": {
      "Type": "Number",
      "Description": "The time type that triggers the workflow. Valid values:\n- 1: cron\n- 100: api",
      "AllowedValues": [
        1,
        100
      ],
      "Required": true
    },
    "GroupId": {
      "Type": "String",
      "Description": "The ID of the application group. You can obtain this ID from the application management page in the console.",
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::SchedulerX::WorkFlow",
      "Properties": {
        "Timezone": {
          "Ref": "Timezone"
        },
        "Description": {
          "Ref": "Description"
        },
        "WorkflowName": {
          "Ref": "WorkflowName"
        },
        "NamespaceSource": {
          "Ref": "NamespaceSource"
        },
        "MaxConcurrency": {
          "Ref": "MaxConcurrency"
        },
        "TimeExpression": {
          "Ref": "TimeExpression"
        },
        "Namespace": {
          "Ref": "Namespace"
        },
        "TimeType": {
          "Ref": "TimeType"
        },
        "GroupId": {
          "Ref": "GroupId"
        }
      }
    }
  },
  "Outputs": {
    "WorkFlowId": {
      "Description": "The ID of the workflow.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WorkFlowId"
        ]
      }
    },
    "Description": {
      "Description": "The description of the workflow.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "WorkflowName": {
      "Description": "The name of the workflow.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "WorkflowName"
        ]
      }
    },
    "MaxConcurrency": {
      "Description": "The maximum number of concurrent workflow instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "MaxConcurrency"
        ]
      }
    },
    "TimeExpression": {
      "Description": "The time expression.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TimeExpression"
        ]
      }
    },
    "Namespace": {
      "Description": "The ID of the namespace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Namespace"
        ]
      }
    },
    "TimeType": {
      "Description": "The time type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TimeType"
        ]
      }
    },
    "GroupId": {
      "Description": "The ID of the application group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "GroupId"
        ]
      }
    }
  }
}