Flow
- Implements: com.aliyun.ros.cdk.fnf.datasource.IFlow
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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
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)
- 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. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the flow was created. |
attrDefinition | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Definition: The flow definition, which follows the flow definition language (FDL) syntax standard. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the flow. |
attrFlowId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FlowId: The unique ID of the flow. |
attrFlowName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute FlowName: The name of the flow. |
attrLastModifiedTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LastModifiedTime: The time when the flow was last modified. |
attrRoleArn | java.lang.String OR 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Type: The type of the flow. |
props | FlowProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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 java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the flow was created.
attrDefinitionRequired
public java.lang.Object getAttrDefinition();
- Type: java.lang.String OR 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 java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the flow.
attrFlowIdRequired
public java.lang.Object getAttrFlowId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute FlowId: The unique ID of the flow.
attrFlowNameRequired
public java.lang.Object getAttrFlowName();
- Type: java.lang.String OR 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 java.lang.Object getAttrLastModifiedTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LastModifiedTime: The time when the flow was last modified.
attrRoleArnRequired
public java.lang.Object getAttrRoleArn();
- Type: java.lang.String OR 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 java.lang.Object getAttrType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Type: The type of the flow.
Valid values are FDL or DEFAULT.
propsRequired
public FlowProps getProps();
- Type: FlowProps