Flow

• Implements: IFlow

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

Initializers

import com.aliyun.ros.cdk.fnf.Flow;
Flow.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .definition(java.lang.String)
    .definition(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .executionMode(java.lang.String)
//  .executionMode(IResolvable)
//  .externalStorageLocation(java.lang.String)
//  .externalStorageLocation(IResolvable)
//  .requestId(java.lang.String)
//  .requestId(IResolvable)
//  .roleArn(java.lang.String)
//  .roleArn(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

definition^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

name^Required

• Type: java.lang.String OR com.aliyun.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.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Create a description of the flow.

executionMode^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property executionMode: The execution mode of the flow.

externalStorageLocation^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property externalStorageLocation: The external storage location for the flow.

requestId^Optional

• Type: java.lang.String OR com.aliyun.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.

roleArn^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.fnf.Flow;
Flow.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrCreatedTime^Required

public java.lang.Object getAttrCreatedTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreatedTime: Flow creation time.

attrId^Required

public java.lang.Object getAttrId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Id: The unique ID of the flow.

attrLastModifiedTime^Required

public java.lang.Object getAttrLastModifiedTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrName^Required

public java.lang.Object getAttrName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the flow created.

props^Required

public FlowProps getProps();

• Type: FlowProps