Flow
This class encapsulates and extends the ROS resource type ALIYUN::FNF::Flow
, which is used to create a 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();
Name | Type | Description |
---|---|---|
scope |
com.aliyun.ros.cdk.core.Construct |
No description. |
id |
java.lang.String |
No description. |
enableResourcePropertyConstraint |
java.lang.Boolean |
No description. |
definition |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property definition: The definition of the created flow following the FDL syntax standard. |
name |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property name: The name of the flow created. |
description |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property description: Create a description of the flow. |
executionMode |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property executionMode: The execution mode of the flow. |
externalStorageLocation |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property externalStorageLocation: The external storage location for the flow. |
requestId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property requestId: The specified Request ID for this request. |
roleArn |
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. |
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 created.
This name is unique under the account.
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
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 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.fnf.Flow;
Flow.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
Name | Type | Description |
---|---|---|
node |
com.aliyun.ros.cdk.core.ConstructNode |
The construct tree node associated with this construct. |
ref |
java.lang.String |
No description. |
stack |
com.aliyun.ros.cdk.core.Stack |
The stack in which this resource is defined. |
resource |
com.aliyun.ros.cdk.core.RosResource |
No description. |
attrCreatedTime |
com.aliyun.ros.cdk.core.IResolvable |
Attribute CreatedTime: Flow creation time. |
attrId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Id: The unique ID of the flow. |
attrLastModifiedTime |
com.aliyun.ros.cdk.core.IResolvable |
Attribute LastModifiedTime: The most recently modified time of the flow. |
attrName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Name: The name of the flow created. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
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 IResolvable getAttrCreatedTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute CreatedTime: Flow creation time.
attrId
Required
public IResolvable getAttrId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Id: The unique ID of the flow.
attrLastModifiedTime
Required
public IResolvable getAttrLastModifiedTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute LastModifiedTime: The most recently modified time of the flow.
attrName
Required
public IResolvable getAttrName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Name: The name of the flow created.