Flow

• Implements: IFlow

This class encapsulates and extends the ROS resource type ALIYUN::FNF::Flow, which is used to create a flow.

Initializers

import ros_cdk_fnf
ros_cdk_fnf.Flow(
  scope: Construct,
  id: str,
  definition: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  execution_mode: typing.Union[str, IResolvable] = None,
  external_storage_location: typing.Union[str, IResolvable] = None,
  request_id: typing.Union[str, IResolvable] = None,
  role_arn: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

definition^Required

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

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

name^Required

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

Property name: The name of the flow created.

This name is unique under the account.

description^Optional

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

Property description: Create a description of the flow.

execution_mode^Optional

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

Property executionMode: The execution mode of the flow.

external_storage_location^Optional

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

Property externalStorageLocation: The external storage location for the flow.

request_id^Optional

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

role_arn^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_fnf
ros_cdk_fnf.Flow.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_created_time^Required

attr_created_time: typing.Union[str, IResolvable]

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

Attribute CreatedTime: Flow creation time.

attr_id^Required

attr_id: typing.Union[str, IResolvable]

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

Attribute Id: The unique ID of the flow.

attr_last_modified_time^Required

attr_last_modified_time: typing.Union[str, IResolvable]

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

Attribute LastModifiedTime: The most recently modified time of the flow.

attr_name^Required

attr_name: typing.Union[str, IResolvable]

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

Attribute Name: The name of the flow created.

props^Required

props: FlowProps

• Type: FlowProps