Flow

• Implements: IFlow

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();

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.

This parameter is required when you update a flow or create a new flow version.

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 for the template.

You can specify up to 200 parameters.

This parameter is optional. If you use this parameter, you must specify both ParameterKey and ParameterValue for each entry.

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.

Specify this parameter when you create a flow from a template in the Template Center.

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.appflow.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

attrFlowId^Required

public java.lang.Object getAttrFlowId();

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

Attribute FlowId: The ID of the flow.

attrWebhookAddress^Required

public java.lang.Object getAttrWebhookAddress();

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

Attribute WebhookAddress: The webhook address of the flow.

props^Required

public FlowProps getProps();

• Type: FlowProps