Skip to content

FlowProps

Properties for defining a Flow.

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

Initializer

import ros_cdk_appflow
ros_cdk_appflow.FlowProps(
  flow_name: typing.Union[str, IResolvable],
  flow_desc: typing.Union[str, IResolvable] = None,
  flow_id: typing.Union[str, IResolvable] = None,
  flow_status: typing.Union[str, IResolvable] = None,
  launch_flow: typing.Union[bool, IResolvable] = None,
  parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  template: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  template_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
flow_name typing.Union[str, ros_cdk_core.IResolvable] Property flowName: The name of the flow.
flow_desc typing.Union[str, ros_cdk_core.IResolvable] Property flowDesc: The description of the flow.
flow_id typing.Union[str, ros_cdk_core.IResolvable] Property flowId: The ID of the flow.
flow_status typing.Union[str, ros_cdk_core.IResolvable] Property flowStatus: The status of the flow.
launch_flow typing.Union[bool, ros_cdk_core.IResolvable] Property launchFlow: Whether to launch the flow.
parameters typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property parameters: The parameters for the template.
template typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property template: The template of the flow.
template_id typing.Union[str, ros_cdk_core.IResolvable] Property templateId: The ID of the template.

flow_nameRequired

flow_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property flowName: The name of the flow.


flow_descOptional

flow_desc: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property flowDesc: The description of the flow.


flow_idOptional

flow_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


flow_statusOptional

flow_status: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property flowStatus: The status of the flow.

Allowed values: Enable: enable flow Disable: disable flow


launch_flowOptional

launch_flow: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property launchFlow: Whether to launch the flow.


parametersOptional

parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.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

template: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property template: The template of the flow.


template_idOptional

template_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.