Skip to content

Flow

This class encapsulates and extends the ROS resource type ALIYUN::FNF::Flow, which is used to create a flow.

Initializers

import com.aliyun.ros.cdk.fnf.Flow;
Flow.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .definition(java.lang.String)
    .definition(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .executionMode(java.lang.String)
//  .executionMode(IResolvable)
//  .externalStorageLocation(java.lang.String)
//  .externalStorageLocation(IResolvable)
//  .requestId(java.lang.String)
//  .requestId(IResolvable)
//  .roleArn(java.lang.String)
//  .roleArn(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.
definition java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property definition: The definition of the created flow following the FDL syntax standard.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the flow created.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Create a description of the flow.
executionMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property executionMode: The execution mode of the flow.
externalStorageLocation java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property externalStorageLocation: The external storage location for the flow.
requestId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property requestId: The specified Request ID for this request.
roleArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property roleArn: Optional parameter, the resource descriptor information required for the execution of the flow, used to perform the assume role during FnF execution.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

definitionRequired

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

Property definition: The definition of the created flow following the FDL syntax standard.


nameRequired

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

Property name: The name of the flow created.

This name is unique under the account.


descriptionOptional

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

Property description: Create a description of the flow.


executionModeOptional

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

Property executionMode: The execution mode of the flow.


externalStorageLocationOptional

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

Property externalStorageLocation: The external storage location for the flow.


requestIdOptional

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

Property requestId: The specified Request ID for this request.

If not specified, our system will help you generate a random one.


roleArnOptional

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

Property roleArn: Optional parameter, the resource descriptor information required for the execution of the flow, used to perform the assume role during FnF execution.


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.fnf.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.
attrCreatedTime com.aliyun.ros.cdk.core.IResolvable Attribute CreatedTime: Flow creation time.
attrId com.aliyun.ros.cdk.core.IResolvable Attribute Id: The unique ID of the flow.
attrLastModifiedTime com.aliyun.ros.cdk.core.IResolvable Attribute LastModifiedTime: The most recently modified time of the flow.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: The name of the flow created.

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

attrCreatedTimeRequired

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

Attribute CreatedTime: Flow creation time.


attrIdRequired

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

Attribute Id: The unique ID of the flow.


attrLastModifiedTimeRequired

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

Attribute LastModifiedTime: The most recently modified time of the flow.


attrNameRequired

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

Attribute Name: The name of the flow created.