ScheduledTask

• Implements: IScheduledTask

This class encapsulates and extends the ROS resource type ALIYUN::ESS::ScheduledTask, which creates a scheduled task based on specified properties.

Initializers

import ros_cdk_ess
ros_cdk_ess.ScheduledTask(
  scope: Construct,
  id: str,
  launch_time: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  desired_capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  launch_expiration_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_value: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_value: typing.Union[typing.Union[int, float], IResolvable] = None,
  recurrence_end_time: typing.Union[str, IResolvable] = None,
  recurrence_type: typing.Union[str, IResolvable] = None,
  recurrence_value: typing.Union[str, IResolvable] = None,
  scaling_group_id: typing.Union[str, IResolvable] = None,
  scheduled_action: typing.Union[str, IResolvable] = None,
  scheduled_task_name: typing.Union[str, IResolvable] = None,
  task_enabled: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

launch_time^Required

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

Property launchTime: Time point at which the scheduled task is triggered.

The date format follows the ISO8601 standard and uses UTC time. It is in the format of YYYY-MM-DDThh:mmZ. If RecurrenceType is specified, the time point specified by this attribute is the default time point at which the circle is executed. If RecurrenceType is not specified, the task is executed once on the designated date and time. A time point 90 days after creation or modification cannot be entered.

description^Optional

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

Property description: Description of the scheduled task, which is 2-200 characters (English or Chinese) long.

desired_capacity^Optional

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

Property desiredCapacity: The expected number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.

You must specify the DesiredCapacity parameter when you create a scaling group.

launch_expiration_time^Optional

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

Property launchExpirationTime: Time period within which the failed scheduled task is retried.

The default value is 600s. Value range: [0, 21600]

max_value^Optional

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

Property maxValue: The maximum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.

min_value^Optional

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

Property minValue: The minimum number of instances in the scaling group if the scaling method of the scaling group is to specify the number of instances.

recurrence_end_time^Optional

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

Property recurrenceEndTime: The end time of the scheduled task.

Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mmZ format. The time must be in UTC. You cannot enter a point in time that is later than 365 days from the point in time at which the scheduled task is created.

recurrence_type^Optional

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

Property recurrenceType: The interval at which the scheduled task is repeatedly executed.

Valid values:

• Daily: The scheduled task is executed once every specified number of days.
• Weekly: The scheduled task is executed on each specified day of a week.
• Monthly: The scheduled task is executed on each specified day of a month.
• Cron: The scheduled task is executed based on the specified cron expression. You must specify the RecurrenceType and RecurrenceValue parameters at the same time.

recurrence_value^Optional

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

Property recurrenceValue: Value of the scheduled task to be repeated.

• Daily: Only one value in the range [1,31] can be filled.
• Weekly: Multiple values can be filled. The values of Sunday to Saturday are 0 to 6 in sequence. Multiple values shall be separated by a comma ",".
• Monthly: In the format of A-B. The value range of A and B is 1 to 31, and the B value must be greater than the A value.
• Cron: A cron expression is written in UTC time and consists of the following fields: minute, hour, day, month, and week. The expression can contain the letters L and W and the following wildcard characters: commas (,), question marks (?), hyphens (-), asterisks (*), number signs (#), and forward slashes (/). RecurrenceType, RecurrenceValue and RecurrenceEndTime must be specified.

scaling_group_id^Optional

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

Property scalingGroupId: The ID of the scaling group whose number of instances is changed when the scheduled task is triggered.

If you specify the ScalingGroupId parameter for a scheduled task, the scaling method of the scheduled task is to specify the number of instances in the scaling group. In this case, you must specify at least one of the MinValue, MaxValue, and DesiredCapacity parameters.

You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.

scheduled_action^Optional

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

Property scheduledAction: The scaling rule that you want to execute when the scheduled task is triggered.

Specify the unique identifier of the scaling rule. If you specify the ScheduledAction parameter, you must select an existing scaling rule for the scheduled task.

You cannot specify the ScheduledAction and ScalingGroupId parameters at the same time.

scheduled_task_name^Optional

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

Property scheduledTaskName: The name of the scheduled task.

The name must be 2 to 64 characters in length and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit. The name of the scheduled task must be unique in the region and within the account. By default, the value of the ScheduledTaskId parameter is used.

task_enabled^Optional

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

Property taskEnabled: Whether to enable the scheduled task.

• When the parameter is set to true, the task is enabled.
• When the parameter is set to false, the task is disabled. The default value is true.

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_ess
ros_cdk_ess.ScheduledTask.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_scheduled_task_id^Required

attr_scheduled_task_id: typing.Union[str, IResolvable]

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

Attribute ScheduledTaskId: ID of the scheduled task, which is generated by the system and globally unique.

props^Required

props: ScheduledTaskProps

• Type: ScheduledTaskProps