Flow

This class encapsulates and extends the ROS resource type DATASOURCE::FNF::Flow.

Initializers

from ros_cdk_fnf import datasource
datasource.Flow(
  scope: Construct,
  id: str,
  flow_name: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
flow_name	typing.Union[str, ros_cdk_core.IResolvable]	Property flowName: The name of the flow.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

flow_name^Required

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

Property flowName: The name of the flow.

The name must be unique within a region for the same Alibaba Cloud account.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

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

---

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

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The time when the flow was created.
attr_definition	ros_cdk_core.IResolvable	Attribute Definition: The flow definition, which follows the flow definition language (FDL) syntax standard.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the flow.
attr_flow_id	ros_cdk_core.IResolvable	Attribute FlowId: The unique ID of the flow.
attr_flow_name	ros_cdk_core.IResolvable	Attribute FlowName: The name of the flow.
attr_last_modified_time	ros_cdk_core.IResolvable	Attribute LastModifiedTime: The time when the flow was last modified.
attr_role_arn	ros_cdk_core.IResolvable	Attribute RoleArn: The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies.
attr_type	ros_cdk_core.IResolvable	Attribute Type: The type of the flow.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the flow was created.

---

attr_definition^Required

attr_definition: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Definition: The flow definition, which follows the flow definition language (FDL) syntax standard.

Considering compatibility, the system supports the two flow definition specifications.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the flow.

---

attr_flow_id^Required

attr_flow_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute FlowId: The unique ID of the flow.

---

attr_flow_name^Required

attr_flow_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute FlowName: The name of the flow.

The name must be unique within a region for the same Alibaba Cloud account.

---

attr_last_modified_time^Required

attr_last_modified_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LastModifiedTime: The time when the flow was last modified.

---

attr_role_arn^Required

attr_role_arn: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RoleArn: The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies.

During the execution of the flow, CloudFlow assumes the role to call API operations of relevant services.

---

attr_type^Required

attr_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Type: The type of the flow.

Valid values are FDL or DEFAULT.

---