Skip to content

JobMonitorRule

This class encapsulates and extends the ROS resource type DATASOURCE::DTS::JobMonitorRule.

Initializers 

from ros_cdk_dts import datasource
datasource.JobMonitorRule(
  scope: Construct,
  id: str,
  dts_job_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
dts_job_id typing.Union[str, ros_cdk_core.IResolvable] Property dtsJobId: The ID of the data migration, data synchronization, or change tracking task.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

dts_job_idRequired

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

Property dtsJobId: The ID of the data migration, data synchronization, or change tracking task.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

from ros_cdk_dts import datasource
datasource.JobMonitorRule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_delay_rule_time ros_cdk_core.IResolvable Attribute DelayRuleTime: The threshold that triggers the alert.
attr_dts_job_id ros_cdk_core.IResolvable Attribute DtsJobId: The ID of the data migration, data synchronization, or change tracking task.
attr_period ros_cdk_core.IResolvable Attribute Period: The statistical period for incremental validation tasks, in minutes.
attr_phone ros_cdk_core.IResolvable Attribute Phone: The mobile phone numbers that receive alert notifications.
attr_state ros_cdk_core.IResolvable Attribute State: Indicates whether the monitoring rule is enabled.
attr_times ros_cdk_core.IResolvable Attribute Times: The number of cycles for the incremental validation task.
attr_type ros_cdk_core.IResolvable Attribute Type: The type of the monitoring rule.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_delay_rule_timeRequired 

attr_delay_rule_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DelayRuleTime: The threshold that triggers the alert.

attr_dts_job_idRequired 

attr_dts_job_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DtsJobId: The ID of the data migration, data synchronization, or change tracking task.

attr_periodRequired 

attr_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Period: The statistical period for incremental validation tasks, in minutes.

attr_phoneRequired 

attr_phone: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Phone: The mobile phone numbers that receive alert notifications.

Multiple mobile numbers are separated by commas (,).

attr_stateRequired 

attr_state: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute State: Indicates whether the monitoring rule is enabled.

attr_timesRequired 

attr_times: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Times: The number of cycles for the incremental validation task.

attr_typeRequired 

attr_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Type: The type of the monitoring rule.