Skip to content

SubscriptionJob2Props

Properties for defining a SubscriptionJob2.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dts-subscriptionjob2

Initializer 

import { SubscriptionJob2Props } from '@alicloud/ros-cdk-dts'
const subscriptionJob2Props: SubscriptionJob2Props = { ... }

Properties

Name Type Description
dbList @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property dbList: The objects for which you want to track data changes.
dtsJobName string | @alicloud/ros-cdk-core.IResolvable Property dtsJobName: The name of the DTS instance.
sourceEndpoint @alicloud/ros-cdk-core.IResolvable | SourceEndpointProperty Property sourceEndpoint: Source instance configuration.
subscriptionInstance @alicloud/ros-cdk-core.IResolvable | SubscriptionInstanceProperty Property subscriptionInstance: Subscription instance configuration.
checkpoint string | @alicloud/ros-cdk-core.IResolvable Property checkpoint: The start offset of incremental data migration or synchronization.
dedicatedClusterId string | @alicloud/ros-cdk-core.IResolvable Property dedicatedClusterId: The ID of the DTS dedicated cluster on which the task runs.
delayNotice boolean | @alicloud/ros-cdk-core.IResolvable Property delayNotice: Specifies whether to monitor the task latency.
delayPhone string | @alicloud/ros-cdk-core.IResolvable Property delayPhone: The mobile numbers that receive latency-related alerts.
delayRuleTime number | @alicloud/ros-cdk-core.IResolvable Property delayRuleTime: The threshold for latency alerts.
dtsBisLabel string | @alicloud/ros-cdk-core.IResolvable Property dtsBisLabel: The environment tag of the DTS instance.
dtsInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dtsInstanceId: The ID of the DTS instance.
dtsJobId string | @alicloud/ros-cdk-core.IResolvable Property dtsJobId: The ID of the DTS task.
errorNotice boolean | @alicloud/ros-cdk-core.IResolvable Property errorNotice: Specifies whether to monitor the task status.
errorPhone string | @alicloud/ros-cdk-core.IResolvable Property errorPhone: The mobile numbers that receive status-related alerts.
reserve @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property reserve: The reserved parameter of DTS.
status string | @alicloud/ros-cdk-core.IResolvable Property status: The status of the resource.
subscriptionDataType @alicloud/ros-cdk-core.IResolvable | SubscriptionDataTypeProperty Property subscriptionDataType: Subscription data type.

dbListRequired 

public readonly dbList: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

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

dtsJobNameRequired 

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

Property dtsJobName: The name of the DTS instance.

sourceEndpointRequired 

public readonly sourceEndpoint: IResolvable | SourceEndpointProperty;

Property sourceEndpoint: Source instance configuration.

subscriptionInstanceRequired 

public readonly subscriptionInstance: IResolvable | SubscriptionInstanceProperty;

Property subscriptionInstance: Subscription instance configuration.

checkpointOptional 

public readonly checkpoint: string | IResolvable;
  • Type: string | @alicloud/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.

dedicatedClusterIdOptional 

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

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

delayNoticeOptional 

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

Property delayNotice: Specifies whether to monitor the task latency.

Valid values: true and false

delayPhoneOptional 

public readonly delayPhone: string | IResolvable;
  • Type: string | @alicloud/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.

delayRuleTimeOptional 

public readonly delayRuleTime: number | IResolvable;
  • Type: number | @alicloud/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.

dtsBisLabelOptional 

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

Property dtsBisLabel: The environment tag of the DTS instance.

Valid values: normal and online.

dtsInstanceIdOptional 

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

Property dtsInstanceId: The ID of the DTS instance.

dtsJobIdOptional 

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

Property dtsJobId: The ID of the DTS task.

errorNoticeOptional 

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

Property errorNotice: Specifies whether to monitor the task status.

Valid values: true and false.

errorPhoneOptional 

public readonly errorPhone: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly reserve: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: 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 

public readonly status: string | IResolvable;
  • Type: string | @alicloud/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.

subscriptionDataTypeOptional 

public readonly subscriptionDataType: IResolvable | SubscriptionDataTypeProperty;

Property subscriptionDataType: Subscription data type.