Flow
This class encapsulates and extends the ROS resource type DATASOURCE::FNF::Flow.
Initializers
import com.aliyun.ros.cdk.fnf.datasource.Flow;
Flow.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.flowName(java.lang.String)
.flowName(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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. |
flowName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property flowName: The name of the flow. |
refreshOptions |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
flowNameRequired
- Type: java.lang.String OR com.aliyun.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.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.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.
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.datasource.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. |
attrCreateTime |
com.aliyun.ros.cdk.core.IResolvable |
Attribute CreateTime: The time when the flow was created. |
attrDefinition |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Definition: The flow definition, which follows the flow definition language (FDL) syntax standard. |
attrDescription |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Description: The description of the flow. |
attrFlowId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute FlowId: The unique ID of the flow. |
attrFlowName |
com.aliyun.ros.cdk.core.IResolvable |
Attribute FlowName: The name of the flow. |
attrLastModifiedTime |
com.aliyun.ros.cdk.core.IResolvable |
Attribute LastModifiedTime: The time when the flow was last modified. |
attrRoleArn |
com.aliyun.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 |
com.aliyun.ros.cdk.core.IResolvable |
Attribute Type: The type of the flow. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrCreateTimeRequired
public IResolvable getAttrCreateTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the flow was created.
attrDefinitionRequired
public IResolvable getAttrDefinition();
- Type: com.aliyun.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 IResolvable getAttrDescription();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the flow.
attrFlowIdRequired
public IResolvable getAttrFlowId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute FlowId: The unique ID of the flow.
attrFlowNameRequired
public IResolvable getAttrFlowName();
- Type: com.aliyun.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 IResolvable getAttrLastModifiedTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute LastModifiedTime: The time when the flow was last modified.
attrRoleArnRequired
public IResolvable getAttrRoleArn();
- Type: com.aliyun.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 IResolvable getAttrType();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Type: The type of the flow.
Valid values are FDL or DEFAULT.