WorkFlow

• Implements: IWorkFlow

This class encapsulates and extends the ROS resource type ALIYUN::SchedulerX::WorkFlow.

Initializers

import { WorkFlow } from '@alicloud/ros-cdk-schedulerx'
new WorkFlow(scope: Construct, id: string, props: WorkFlowProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: WorkFlowProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { WorkFlow } from '@alicloud/ros-cdk-schedulerx'
WorkFlow.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrDescription^Required

public readonly attrDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: Workflow description.

attrGroupId^Required

public readonly attrGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GroupId: The application Group ID, which is obtained from the application management page of the console.

attrMaxConcurrency^Required

public readonly attrMaxConcurrency: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MaxConcurrency: The maximum number of workflow instances running at the same time.

The default value is 1, that is, the last trigger is not completed, and the next trigger will not be performed even when the running time is reached.

attrNamespace^Required

public readonly attrNamespace: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Namespace: The namespace ID, which is obtained from the namespace page in the console.

attrTimeExpression^Required

public readonly attrTimeExpression: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TimeExpression: Time expression, which is set based on the selected time type.

attrTimeType^Required

public readonly attrTimeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TimeType: Time type.

attrWorkFlowId^Required

public readonly attrWorkFlowId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute WorkFlowId: workflow id.

attrWorkflowName^Required

public readonly attrWorkflowName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute WorkflowName: Workflow Name.

props^Required

public readonly props: WorkFlowProps;

• Type: WorkFlowProps

Structs