Skip to content

SubscriptionJob2

This class encapsulates and extends the ROS resource type ALIYUN::DTS::SubscriptionJob2, which is used to configure a change tracking task.

Initializers 

import ros_cdk_dts
ros_cdk_dts.SubscriptionJob2(
  scope: Construct,
  id: str,
  db_list: typing.Union[IResolvable, typing.Mapping[typing.Any]],
  dts_job_name: typing.Union[str, IResolvable],
  source_endpoint: typing.Union[IResolvable, SourceEndpointProperty],
  subscription_instance: typing.Union[IResolvable, SubscriptionInstanceProperty],
  checkpoint: typing.Union[str, IResolvable] = None,
  dedicated_cluster_id: typing.Union[str, IResolvable] = None,
  delay_notice: typing.Union[bool, IResolvable] = None,
  delay_phone: typing.Union[str, IResolvable] = None,
  delay_rule_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  dts_bis_label: typing.Union[str, IResolvable] = None,
  dts_instance_id: typing.Union[str, IResolvable] = None,
  dts_job_id: typing.Union[str, IResolvable] = None,
  error_notice: typing.Union[bool, IResolvable] = None,
  error_phone: typing.Union[str, IResolvable] = None,
  reserve: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  status: typing.Union[str, IResolvable] = None,
  subscription_data_type: typing.Union[IResolvable, SubscriptionDataTypeProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
db_list typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property dbList: The objects for which you want to track data changes.
dts_job_name typing.Union[str, ros_cdk_core.IResolvable] Property dtsJobName: The name of the DTS instance.
source_endpoint typing.Union[ros_cdk_core.IResolvable, SourceEndpointProperty] Property sourceEndpoint: Source instance configuration.
subscription_instance typing.Union[ros_cdk_core.IResolvable, SubscriptionInstanceProperty] Property subscriptionInstance: Subscription instance configuration.
checkpoint typing.Union[str, ros_cdk_core.IResolvable] Property checkpoint: The start offset of incremental data migration or synchronization.
dedicated_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.
delay_notice typing.Union[bool, ros_cdk_core.IResolvable] Property delayNotice: Specifies whether to monitor the task latency.
delay_phone typing.Union[str, ros_cdk_core.IResolvable] Property delayPhone: The mobile numbers that receive latency-related alerts.
delay_rule_time typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property delayRuleTime: The threshold for latency alerts.
dts_bis_label typing.Union[str, ros_cdk_core.IResolvable] Property dtsBisLabel: The environment tag of the DTS instance.
dts_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dtsInstanceId: The ID of the DTS instance.
dts_job_id typing.Union[str, ros_cdk_core.IResolvable] Property dtsJobId: The ID of the DTS task.
error_notice typing.Union[bool, ros_cdk_core.IResolvable] Property errorNotice: Specifies whether to monitor the task status.
error_phone typing.Union[str, ros_cdk_core.IResolvable] Property errorPhone: The mobile numbers that receive status-related alerts.
reserve typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property reserve: The reserved parameter of DTS.
status typing.Union[str, ros_cdk_core.IResolvable] Property status: The status of the resource.
subscription_data_type typing.Union[ros_cdk_core.IResolvable, SubscriptionDataTypeProperty] Property subscriptionDataType: Subscription data type.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

db_listRequired

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

Property dbList: The objects for which you want to track data changes.

dts_job_nameRequired

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

Property dtsJobName: The name of the DTS instance.

source_endpointRequired

Property sourceEndpoint: Source instance configuration.

subscription_instanceRequired

Property subscriptionInstance: Subscription instance configuration.

checkpointOptional

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

Property checkpoint: The start offset of incremental data migration or synchronization.

This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.

dedicated_cluster_idOptional

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

Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.

delay_noticeOptional

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

Property delayNotice: Specifies whether to monitor the task latency.

Valid values: true and false

delay_phoneOptional

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

Property delayPhone: The mobile numbers that receive latency-related alerts.

Separate multiple mobile numbers with commas (,). Note: This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console.

delay_rule_timeOptional

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

Property delayRuleTime: The threshold for latency alerts.

Unit: seconds. You can set the threshold based on your business requirements. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.

dts_bis_labelOptional

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

Property dtsBisLabel: The environment tag of the DTS instance.

Valid values: normal and online.

dts_instance_idOptional

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

Property dtsInstanceId: The ID of the DTS instance.

dts_job_idOptional

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

Property dtsJobId: The ID of the DTS task.

error_noticeOptional

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

Property errorNotice: Specifies whether to monitor the task status.

Valid values: true and false.

error_phoneOptional

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

Property errorPhone: The mobile numbers that receive status-related alerts.

Separate multiple mobile numbers with commas (,). Note: This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers. Users of the international site (alibabacloud.com) cannot receive alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console.

reserveOptional

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

Property reserve: The reserved parameter of DTS.

You can specify this parameter to add more configurations of the source or destination instance to the DTS task. For example, you can specify the data storage format of the destination Kafka database and the ID of the CEN instance.

statusOptional

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

Property status: The status of the resource.

Valid values:

  • Subscribing: Start the task.
  • Suspending: Suspend the task.
  • Stopping: Stop the task.

subscription_data_typeOptional

Property subscriptionDataType: Subscription data type.

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 

import ros_cdk_dts
ros_cdk_dts.SubscriptionJob2.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_dts_instance_id ros_cdk_core.IResolvable Attribute DtsInstanceId: The ID of the DTS instance.
attr_dts_job_id ros_cdk_core.IResolvable Attribute DtsJobId: The ID of the task.
attr_dts_job_name ros_cdk_core.IResolvable Attribute DtsJobName: The name of the DTS job.

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_dts_instance_idRequired 

attr_dts_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DtsInstanceId: The ID of the DTS instance.

attr_dts_job_idRequired 

attr_dts_job_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DtsJobId: The ID of the task.

attr_dts_job_nameRequired 

attr_dts_job_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DtsJobName: The name of the DTS job.