Skip to content

ScheduleProps

Properties for defining a Schedule.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-fnf-schedule

Initializer 

import { ScheduleProps } from '@alicloud/ros-cdk-fnf'
const scheduleProps: ScheduleProps = { ... }

Properties

Name Type Description
cronExpression string | @alicloud/ros-cdk-core.IResolvable Property cronExpression: Cron expression.
flowName string | @alicloud/ros-cdk-core.IResolvable Property flowName: Flow name.
scheduleName string | @alicloud/ros-cdk-core.IResolvable Property scheduleName: The name of the timed schedule.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of the schedule.
enable boolean | @alicloud/ros-cdk-core.IResolvable Property enable: Whether enable schedule.
payload string | @alicloud/ros-cdk-core.IResolvable Property payload: The trigger message of the timed schedule.

cronExpressionRequired 

public readonly cronExpression: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property cronExpression: Cron expression.

flowNameRequired 

public readonly flowName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property flowName: Flow name.

scheduleNameRequired 

public readonly scheduleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property scheduleName: The name of the timed schedule.

The name must meet the following requirements: - It can contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). - It is case-sensitive. - It must be 1 to 128 characters in length.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Description of the schedule.

enableOptional 

public readonly enable: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enable: Whether enable schedule.

payloadOptional 

public readonly payload: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payload: The trigger message of the timed schedule.

The message must be in the JSON format.