Skip to content

Flow

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

Initializers

import { datasource } from '@alicloud/ros-cdk-fnf'
new datasource.Flow(scope: Construct, id: string, props: FlowProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props FlowProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { datasource } from '@alicloud/ros-cdk-fnf'
datasource.Flow.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The time when the flow was created.
attrDefinition @alicloud/ros-cdk-core.IResolvable Attribute Definition: The flow definition, which follows the flow definition language (FDL) syntax standard.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the flow.
attrFlowId @alicloud/ros-cdk-core.IResolvable Attribute FlowId: The unique ID of the flow.
attrFlowName @alicloud/ros-cdk-core.IResolvable Attribute FlowName: The name of the flow.
attrLastModifiedTime @alicloud/ros-cdk-core.IResolvable Attribute LastModifiedTime: The time when the flow was last modified.
attrRoleArn @alicloud/ros-cdk-core.IResolvable Attribute RoleArn: The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies.
attrType @alicloud/ros-cdk-core.IResolvable Attribute Type: The type of the flow.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCreateTimeRequired

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the flow was created.


attrDefinitionRequired

public readonly attrDefinition: IResolvable;
  • Type: @alicloud/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.


attrDescriptionRequired

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the flow.


attrFlowIdRequired

public readonly attrFlowId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute FlowId: The unique ID of the flow.


attrFlowNameRequired

public readonly attrFlowName: IResolvable;
  • Type: @alicloud/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.


attrLastModifiedTimeRequired

public readonly attrLastModifiedTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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


attrRoleArnRequired

public readonly attrRoleArn: IResolvable;
  • Type: @alicloud/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.


attrTypeRequired

public readonly attrType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Type: The type of the flow.

Valid values are FDL or DEFAULT.