WorkFlow

• Implements: IWorkFlow

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

Initializers

import ros_cdk_schedulerx
ros_cdk_schedulerx.WorkFlow(
  scope: Construct,
  id: str,
  group_id: typing.Union[str, IResolvable],
  namespace: typing.Union[str, IResolvable],
  time_type: typing.Union[typing.Union[int, float], IResolvable],
  workflow_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  max_concurrency: typing.Union[typing.Union[int, float], IResolvable] = None,
  namespace_source: typing.Union[str, IResolvable] = None,
  time_expression: typing.Union[str, IResolvable] = None,
  timezone: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

group_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

namespace^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

time_type^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property timeType: Time type.

Currently, the following time types are supported:

• cron: 1
• api: 100.

workflow_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workflowName: Workflow Name.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: Workflow description.

max_concurrency^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

namespace_source^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property namespaceSource: Special third parties are required.

time_expression^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property timeExpression: Time expression, which is set based on the selected time type.

• cron: Fill in standard cron expressions to support online verification.
• api: No time expression.

timezone^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property timezone: Time Zone.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_schedulerx
ros_cdk_schedulerx.WorkFlow.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_description^Required

attr_description: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Description: Workflow description.

attr_group_id^Required

attr_group_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_max_concurrency^Required

attr_max_concurrency: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_namespace^Required

attr_namespace: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_time_expression^Required

attr_time_expression: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

attr_time_type^Required

attr_time_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TimeType: Time type.

attr_work_flow_id^Required

attr_work_flow_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WorkFlowId: workflow id.

attr_workflow_name^Required

attr_workflow_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute WorkflowName: Workflow Name.

props^Required

props: WorkFlowProps

• Type: WorkFlowProps

Structs