Skip to content

FlowProps

Properties for defining a Flow.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-appflow-flow

Initializer

import { FlowProps } from '@alicloud/ros-cdk-appflow'
const flowProps: FlowProps = { ... }

Properties

Name Type Description
flowName string | @alicloud/ros-cdk-core.IResolvable Property flowName: The name of the flow.
flowDesc string | @alicloud/ros-cdk-core.IResolvable Property flowDesc: The description of the flow.
flowId string | @alicloud/ros-cdk-core.IResolvable Property flowId: The ID of the flow.
flowStatus string | @alicloud/ros-cdk-core.IResolvable Property flowStatus: The status of the flow.
launchFlow boolean | @alicloud/ros-cdk-core.IResolvable Property launchFlow: Whether to launch the flow.
parameters @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property parameters: The parameters for the template.
template @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property template: The template of the flow.
templateId string | @alicloud/ros-cdk-core.IResolvable Property templateId: The ID of the template.

flowNameRequired

public readonly flowName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property flowName: The name of the flow.


flowDescOptional

public readonly flowDesc: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property flowDesc: The description of the flow.


flowIdOptional

public readonly flowId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property flowId: The ID of the flow.

This parameter is required when you update a flow or create a new flow version.


flowStatusOptional

public readonly flowStatus: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property flowStatus: The status of the flow.

Allowed values: Enable: enable flow Disable: disable flow


launchFlowOptional

public readonly launchFlow: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property launchFlow: Whether to launch the flow.


parametersOptional

public readonly parameters: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property parameters: The parameters for the template.

You can specify up to 200 parameters.

This parameter is optional. If you use this parameter, you must specify both ParameterKey and ParameterValue for each entry.


templateOptional

public readonly template: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property template: The template of the flow.


templateIdOptional

public readonly templateId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateId: The ID of the template.

Specify this parameter when you create a flow from a template in the Template Center.