All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::AppFlow::Flow

Last Updated:Apr 30, 2025

ALIYUN::AppFlow::Flow is used to create a flow.

Syntax

{
  "Type": "ALIYUN::AppFlow::Flow",
  "Properties": {
    "FlowName": String,
    "FlowId": String,
    "FlowDesc": String,
    "FlowStatus": String,
    "LaunchFlow": Boolean,
    "Parameters": Map,
    "TemplateId": String,
    "Template": Map
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

FlowName

String

Yes

No

The name of the flow.

None.

FlowId

String

No

No

The ID of the flow.

None.

FlowDesc

String

No

No

The description of the flow.

None.

FlowStatus

String

No

Yes

The status of the flow.

Valid values:

  • Enable: The flow is enabled.

  • Disable: The flow is disabled.

LaunchFlow

Boolean

No

No

Specifies whether to launch the flow.

None.

Parameters

Map

No

Yes

The parameter configurations of the flow.

None.

TemplateId

String

No

Yes

The template ID of the flow.

None.

Template

Map

No

No

The template configurations of the flow.

None.

Return values

Fn::GetAtt

  • FlowId: the ID of the flow.

  • WebhookAddress: the webhook address of the flow.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  FlowName:
    Type: String
    Description:
      en: The name of the flow.
    Required: true
Resources:
  Flow:
    Type: ALIYUN::AppFlow::Flow
    Properties:
      FlowName:
        Ref: FlowName
Outputs:
  FlowId:
    Description: The ID of the flow.
    Value:
      Fn::GetAtt:
        - Flow
        - FlowId
  WebhookAddress:
    Description: The webhook address of the flow.
    Value:
      Fn::GetAtt:
        - Flow
        - WebhookAddress
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "FlowName": {
      "Type": "String",
      "Description": {
        "en": "The name of the flow."
      },
      "Required": true
    }
  },
  "Resources": {
    "Flow": {
      "Type": "ALIYUN::AppFlow::Flow",
      "Properties": {
        "FlowName": {
          "Ref": "FlowName"
        }
      }
    }
  },
  "Outputs": {
    "FlowId": {
      "Description": "The ID of the flow.",
      "Value": {
        "Fn::GetAtt": [
          "Flow",
          "FlowId"
        ]
      }
    },
    "WebhookAddress": {
      "Description": "The webhook address of the flow.",
      "Value": {
        "Fn::GetAtt": [
          "Flow",
          "WebhookAddress"
        ]
      }
    }
  }
}