RosJob

This class is a base encapsulation around the ROS resource type ALIYUN::SchedulerX::Job.

Initializers

import ros_cdk_schedulerx
ros_cdk_schedulerx.RosJob(
  scope: Construct,
  id: str,
  execute_mode: typing.Union[str, IResolvable],
  group_id: typing.Union[str, IResolvable],
  job_type: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  namespace: typing.Union[str, IResolvable],
  time_type: typing.Union[typing.Union[int, float], IResolvable],
  attempt_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  calendar: typing.Union[str, IResolvable] = None,
  class_name: typing.Union[str, IResolvable] = None,
  consumer_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  contact_info: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ContactInfoProperty]]] = None,
  content: typing.Union[str, IResolvable] = None,
  data_offset: typing.Union[typing.Union[int, float], IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  dispatcher_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  fail_enable: typing.Union[bool, IResolvable] = None,
  fail_times: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_attempt: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_concurrency: typing.Union[typing.Union[int, float], IResolvable] = None,
  miss_worker_enable: typing.Union[bool, IResolvable] = None,
  namespace_source: typing.Union[str, IResolvable] = None,
  page_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  parameters: typing.Union[str, IResolvable] = None,
  priority: typing.Union[typing.Union[int, float], IResolvable] = None,
  queue_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  send_channel: typing.Union[str, IResolvable] = None,
  success_notice_enable: typing.Union[bool, IResolvable] = None,
  task_attempt_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  task_max_attempt: typing.Union[typing.Union[int, float], IResolvable] = None,
  time_expression: typing.Union[str, IResolvable] = None,
  timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  timeout_enable: typing.Union[bool, IResolvable] = None,
  timeout_kill_enable: typing.Union[bool, IResolvable] = None,
  timezone: typing.Union[str, IResolvable] = None,
  x_attrs: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  enable_resource_property_constraint: bool
)

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

id^Required

• Type: str

scoped id of the resource.

execute_mode^Required

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

group_id^Required

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

job_type^Required

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

name^Required

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

namespace^Required

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

time_type^Required

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

attempt_interval^Optional

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

calendar^Optional

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

class_name^Optional

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

consumer_size^Optional

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

contact_info^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ContactInfoProperty]]]

content^Optional

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

data_offset^Optional

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

description^Optional

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

dispatcher_size^Optional

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

fail_enable^Optional

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

fail_times^Optional

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

max_attempt^Optional

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

max_concurrency^Optional

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

miss_worker_enable^Optional

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

namespace_source^Optional

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

page_size^Optional

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

parameters^Optional

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

priority^Optional

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

queue_size^Optional

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

send_channel^Optional

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

success_notice_enable^Optional

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

task_attempt_interval^Optional

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

task_max_attempt^Optional

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

time_expression^Optional

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

timeout^Optional

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

timeout_enable^Optional

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

timeout_kill_enable^Optional

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

timezone^Optional

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

x_attrs^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

enable_resource_property_constraint^Required

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

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

add_condition

def add_condition(
  con: RosCondition
) -> None

con^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_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

• Type: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

add_meta_data

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

key^Required

• Type: str

value^Required

• Type: typing.Any

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: typing.Any

The value.

Could be primitive or complex.

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_path^Required

• Type: str

The path to the property.

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_path^Required

• Type: str

The path of the property.

value^Required

• Type: typing.Any

The value.

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policy^Optional

• Type: bool

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_desc

def fetch_desc() -> str

fetch_ros_dependency

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

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_name^Required

• Type: str

The name of the attribute.

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

is_ros_element

import ros_cdk_schedulerx
ros_cdk_schedulerx.RosJob.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

is_ros_resource

import ros_cdk_schedulerx
ros_cdk_schedulerx.RosJob.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

ref: str

• Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

attr_job_id^Required

attr_job_id: IResolvable

• Type: ros_cdk_core.IResolvable

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

execute_mode^Required

execute_mode: typing.Union[str, IResolvable]

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

group_id^Required

group_id: typing.Union[str, IResolvable]

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

job_type^Required

job_type: typing.Union[str, IResolvable]

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

name^Required

name: typing.Union[str, IResolvable]

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

namespace^Required

namespace: typing.Union[str, IResolvable]

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

time_type^Required

time_type: typing.Union[typing.Union[int, float], IResolvable]

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

attempt_interval^Optional

attempt_interval: typing.Union[typing.Union[int, float], IResolvable]

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

calendar^Optional

calendar: typing.Union[str, IResolvable]

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

class_name^Optional

class_name: typing.Union[str, IResolvable]

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

consumer_size^Optional

consumer_size: typing.Union[typing.Union[int, float], IResolvable]

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

contact_info^Optional

contact_info: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ContactInfoProperty]]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ContactInfoProperty]]]

content^Optional

content: typing.Union[str, IResolvable]

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

data_offset^Optional

data_offset: typing.Union[typing.Union[int, float], IResolvable]

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

description^Optional

description: typing.Union[str, IResolvable]

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

dispatcher_size^Optional

dispatcher_size: typing.Union[typing.Union[int, float], IResolvable]

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

fail_enable^Optional

fail_enable: typing.Union[bool, IResolvable]

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

fail_times^Optional

fail_times: typing.Union[typing.Union[int, float], IResolvable]

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

max_attempt^Optional

max_attempt: typing.Union[typing.Union[int, float], IResolvable]

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

max_concurrency^Optional

max_concurrency: typing.Union[typing.Union[int, float], IResolvable]

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

miss_worker_enable^Optional

miss_worker_enable: typing.Union[bool, IResolvable]

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

namespace_source^Optional

namespace_source: typing.Union[str, IResolvable]

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

page_size^Optional

page_size: typing.Union[typing.Union[int, float], IResolvable]

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

parameters^Optional

parameters: typing.Union[str, IResolvable]

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

priority^Optional

priority: typing.Union[typing.Union[int, float], IResolvable]

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

queue_size^Optional

queue_size: typing.Union[typing.Union[int, float], IResolvable]

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

send_channel^Optional

send_channel: typing.Union[str, IResolvable]

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

success_notice_enable^Optional

success_notice_enable: typing.Union[bool, IResolvable]

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

task_attempt_interval^Optional

task_attempt_interval: typing.Union[typing.Union[int, float], IResolvable]

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

task_max_attempt^Optional

task_max_attempt: typing.Union[typing.Union[int, float], IResolvable]

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

time_expression^Optional

time_expression: typing.Union[str, IResolvable]

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

timeout^Optional

timeout: typing.Union[typing.Union[int, float], IResolvable]

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

timeout_enable^Optional

timeout_enable: typing.Union[bool, IResolvable]

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

timeout_kill_enable^Optional

timeout_kill_enable: typing.Union[bool, IResolvable]

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

timezone^Optional

timezone: typing.Union[str, IResolvable]

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

x_attrs^Optional

x_attrs: typing.Union[IResolvable, typing.Mapping[typing.Any]]

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Constants

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.