Skip to content

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.

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.


flowDescOptional

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

Property flowDesc: The description of the flow.


flowIdOptional

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

Property flowId: The ID of the flow.


flowStatusOptional

  • 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


launchFlowOptional

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

Property launchFlow: Whether to launch the flow.


parametersOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property parameters: The parameters of the flow.


templateOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property template: The template of the flow.


templateIdOptional

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

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

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

xRequired

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

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

attrFlowIdRequired

public IResolvable getAttrFlowId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute FlowId: The ID of the flow.


attrWebhookAddressRequired

public IResolvable getAttrWebhookAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute WebhookAddress: The webhook address of the flow.