Skip to content

FlowProps

Properties for defining a Flow.

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

Initializer

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

Properties

Name Type Description
definition string | @alicloud/ros-cdk-core.IResolvable Property definition: The definition of the created flow following the FDL syntax standard.
name string | @alicloud/ros-cdk-core.IResolvable Property name: The name of the flow.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Create a description of the flow.
executionMode string | @alicloud/ros-cdk-core.IResolvable Property executionMode: The execution mode of the flow.
externalStorageLocation string | @alicloud/ros-cdk-core.IResolvable Property externalStorageLocation: The external storage location for the flow.
requestId string | @alicloud/ros-cdk-core.IResolvable Property requestId: The specified Request ID for this request.
roleArn string | @alicloud/ros-cdk-core.IResolvable Property roleArn: Optional parameter, the resource descriptor information required for the execution of the flow, used to perform the assume role during FnF execution.

definitionRequired

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

Property definition: The definition of the created flow following the FDL syntax standard.


nameRequired

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

Property name: The name of the flow.

The name must be unique within the same region and cannot be changed after the flow is created. The name must meet the following requirements: - It can contain letters (a to z and A to Z), digits (0 to 9), underscores (), and hyphens (-). - It must start with a letter or an underscore (). - It is case-sensitive. - It must be 1 to 128 characters in length.


descriptionOptional

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

Property description: Create a description of the flow.


executionModeOptional

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

Property executionMode: The execution mode of the flow.


externalStorageLocationOptional

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

Property externalStorageLocation: The external storage location for the flow.


requestIdOptional

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

Property requestId: The specified Request ID for this request.

If not specified, our system will help you generate a random one.


roleArnOptional

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

Property roleArn: Optional parameter, the resource descriptor information required for the execution of the flow, used to perform the assume role during FnF execution.