Flow
This class encapsulates and extends the ROS resource type ALIYUN::AppFlow::Flow
.
Initializers
import com.aliyun.ros.cdk.appflow.Flow;
Flow.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.flowName(java.lang.String)
.flowName(IResolvable)
// .flowDesc(java.lang.String)
// .flowDesc(IResolvable)
// .flowId(java.lang.String)
// .flowId(IResolvable)
// .flowStatus(java.lang.String)
// .flowStatus(IResolvable)
// .launchFlow(java.lang.Boolean)
// .launchFlow(IResolvable)
// .parameters(IResolvable)
// .parameters(java.util.Map<java.lang.String, java.lang.Object>)
// .template(IResolvable)
// .template(java.util.Map<java.lang.String, java.lang.Object>)
// .templateId(java.lang.String)
// .templateId(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. |
flowDesc |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property flowDesc: The description of the flow. |
flowId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property flowId: The ID of the flow. |
flowStatus |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property flowStatus: The status of the flow. |
launchFlow |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property launchFlow: Whether to launch the flow. |
parameters |
com.aliyun.ros.cdk.core.IResolvable OR java.util.Map |
Property parameters: The parameters of the flow. |
template |
com.aliyun.ros.cdk.core.IResolvable OR java.util.Map |
Property template: The template of the flow. |
templateId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property templateId: The ID of the template. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
flowName
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property flowName: The name of the flow.
flowDesc
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property flowDesc: The description of the flow.
flowId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property flowId: The ID of the flow.
flowStatus
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property flowStatus: The status of the flow.
Allowed values: Enable: enable flow Disable: disable flow
launchFlow
Optional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property launchFlow: Whether to launch the flow.
parameters
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property parameters: The parameters of the flow.
template
Optional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property template: The template of the flow.
templateId
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property templateId: The ID of the template.
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.appflow.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. |
attrFlowId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute FlowId: The ID of the flow. |
attrWebhookAddress |
com.aliyun.ros.cdk.core.IResolvable |
Attribute WebhookAddress: The webhook address of the flow. |
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
attrFlowId
Required
public IResolvable getAttrFlowId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute FlowId: The ID of the flow.
attrWebhookAddress
Required
public IResolvable getAttrWebhookAddress();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute WebhookAddress: The webhook address of the flow.