Alibaba Cloud v3.37.0, May 15 23
Alibaba Cloud v3.37.0, May 15 23
alicloud.dts.SubscriptionJob
Explore with Pulumi AI
Provides a DTS Subscription Job resource.
For information about DTS Subscription Job and how to use it, see What is Subscription Job.
NOTE: Available in v1.138.0+.
Example Usage
Basic Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "dtsSubscriptionJob";
var creation = config.Get("creation") ?? "Rds";
var defaultZones = AliCloud.GetZones.Invoke(new()
{
AvailableResourceCreation = creation,
});
var defaultNetwork = new AliCloud.Vpc.Network("defaultNetwork", new()
{
VpcName = name,
CidrBlock = "172.16.0.0/16",
});
var defaultSwitch = new AliCloud.Vpc.Switch("defaultSwitch", new()
{
VpcId = defaultNetwork.Id,
CidrBlock = "172.16.0.0/24",
ZoneId = defaultZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
VswitchName = name,
});
var instance = new AliCloud.Rds.Instance("instance", new()
{
Engine = "MySQL",
EngineVersion = "5.6",
InstanceType = "rds.mysql.s1.small",
InstanceStorage = 10,
VswitchId = defaultSwitch.Id,
InstanceName = name,
});
var db = new List<AliCloud.Rds.Database>();
for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
{
var range = new { Value = rangeIndex };
db.Add(new AliCloud.Rds.Database($"db-{range.Value}", new()
{
InstanceId = instance.Id,
Description = "from terraform",
}));
}
var account = new AliCloud.Rds.Account("account", new()
{
InstanceId = instance.Id,
Password = "Test12345",
Description = "from terraform",
});
var privilege = new AliCloud.Rds.AccountPrivilege("privilege", new()
{
InstanceId = instance.Id,
AccountName = account.Name,
Privilege = "ReadWrite",
DbNames = db.Select(__item => __item.Name).ToList(),
});
var default1Networks = AliCloud.Vpc.GetNetworks.Invoke(new()
{
NameRegex = "default-NODELETING",
});
var default1Switches = AliCloud.Vpc.GetSwitches.Invoke(new()
{
VpcId = data.Alicloud_vpcs.Default.Ids[0],
});
var defaultSubscriptionJob = new AliCloud.Dts.SubscriptionJob("defaultSubscriptionJob", new()
{
DtsJobName = name,
PaymentType = "PayAsYouGo",
SourceEndpointEngineName = "MySQL",
SourceEndpointRegion = "cn-hangzhou",
SourceEndpointInstanceType = "RDS",
SourceEndpointInstanceId = instance.Id,
SourceEndpointDatabaseName = "tfaccountpri_0",
SourceEndpointUserName = "tftestprivilege",
SourceEndpointPassword = "Test12345",
DbList = @" {""dtstestdata"": {""name"": ""tfaccountpri_0"", ""all"": true}}
",
SubscriptionInstanceNetworkType = "vpc",
SubscriptionInstanceVpcId = default1Networks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
SubscriptionInstanceVswitchId = default1Switches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
Status = "Normal",
});
});
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.Database;
import com.pulumi.alicloud.rds.DatabaseArgs;
import com.pulumi.alicloud.rds.Account;
import com.pulumi.alicloud.rds.AccountArgs;
import com.pulumi.alicloud.rds.AccountPrivilege;
import com.pulumi.alicloud.rds.AccountPrivilegeArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.dts.SubscriptionJob;
import com.pulumi.alicloud.dts.SubscriptionJobArgs;
import com.pulumi.codegen.internal.KeyedValue;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("dtsSubscriptionJob");
final var creation = config.get("creation").orElse("Rds");
final var defaultZones = AlicloudFunctions.getZones(GetZonesArgs.builder()
.availableResourceCreation(creation)
.build());
var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
.vpcName(name)
.cidrBlock("172.16.0.0/16")
.build());
var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
.vpcId(defaultNetwork.id())
.cidrBlock("172.16.0.0/24")
.zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
.vswitchName(name)
.build());
var instance = new Instance("instance", InstanceArgs.builder()
.engine("MySQL")
.engineVersion("5.6")
.instanceType("rds.mysql.s1.small")
.instanceStorage("10")
.vswitchId(defaultSwitch.id())
.instanceName(name)
.build());
for (var i = 0; i < 2; i++) {
new Database("db-" + i, DatabaseArgs.builder()
.instanceId(instance.id())
.description("from terraform")
.build());
}
var account = new Account("account", AccountArgs.builder()
.instanceId(instance.id())
.password("Test12345")
.description("from terraform")
.build());
var privilege = new AccountPrivilege("privilege", AccountPrivilegeArgs.builder()
.instanceId(instance.id())
.accountName(account.name())
.privilege("ReadWrite")
.dbNames(db.stream().map(element -> element.name()).collect(toList()))
.build());
final var default1Networks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
.nameRegex("default-NODELETING")
.build());
final var default1Switches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
.vpcId(data.alicloud_vpcs().default().ids()[0])
.build());
var defaultSubscriptionJob = new SubscriptionJob("defaultSubscriptionJob", SubscriptionJobArgs.builder()
.dtsJobName(name)
.paymentType("PayAsYouGo")
.sourceEndpointEngineName("MySQL")
.sourceEndpointRegion("cn-hangzhou")
.sourceEndpointInstanceType("RDS")
.sourceEndpointInstanceId(instance.id())
.sourceEndpointDatabaseName("tfaccountpri_0")
.sourceEndpointUserName("tftestprivilege")
.sourceEndpointPassword("Test12345")
.dbList("""
{"dtstestdata": {"name": "tfaccountpri_0", "all": true}}
""")
.subscriptionInstanceNetworkType("vpc")
.subscriptionInstanceVpcId(default1Networks.applyValue(getNetworksResult -> getNetworksResult.ids()[0]))
.subscriptionInstanceVswitchId(default1Switches.applyValue(getSwitchesResult -> getSwitchesResult.ids()[0]))
.status("Normal")
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "dtsSubscriptionJob"
creation = config.get("creation")
if creation is None:
creation = "Rds"
default_zones = alicloud.get_zones(available_resource_creation=creation)
default_network = alicloud.vpc.Network("defaultNetwork",
vpc_name=name,
cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
vpc_id=default_network.id,
cidr_block="172.16.0.0/24",
zone_id=default_zones.zones[0].id,
vswitch_name=name)
instance = alicloud.rds.Instance("instance",
engine="MySQL",
engine_version="5.6",
instance_type="rds.mysql.s1.small",
instance_storage=10,
vswitch_id=default_switch.id,
instance_name=name)
db = []
for range in [{"value": i} for i in range(0, 2)]:
db.append(alicloud.rds.Database(f"db-{range['value']}",
instance_id=instance.id,
description="from terraform"))
account = alicloud.rds.Account("account",
instance_id=instance.id,
password="Test12345",
description="from terraform")
privilege = alicloud.rds.AccountPrivilege("privilege",
instance_id=instance.id,
account_name=account.name,
privilege="ReadWrite",
db_names=[__item.name for __item in db])
default1_networks = alicloud.vpc.get_networks(name_regex="default-NODELETING")
default1_switches = alicloud.vpc.get_switches(vpc_id=data["alicloud_vpcs"]["default"]["ids"])
default_subscription_job = alicloud.dts.SubscriptionJob("defaultSubscriptionJob",
dts_job_name=name,
payment_type="PayAsYouGo",
source_endpoint_engine_name="MySQL",
source_endpoint_region="cn-hangzhou",
source_endpoint_instance_type="RDS",
source_endpoint_instance_id=instance.id,
source_endpoint_database_name="tfaccountpri_0",
source_endpoint_user_name="tftestprivilege",
source_endpoint_password="Test12345",
db_list=" {\"dtstestdata\": {\"name\": \"tfaccountpri_0\", \"all\": true}}\n",
subscription_instance_network_type="vpc",
subscription_instance_vpc_id=default1_networks.ids[0],
subscription_instance_vswitch_id=default1_switches.ids[0],
status="Normal")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "dtsSubscriptionJob";
const creation = config.get("creation") || "Rds";
const defaultZones = alicloud.getZones({
availableResourceCreation: creation,
});
const defaultNetwork = new alicloud.vpc.Network("defaultNetwork", {
vpcName: name,
cidrBlock: "172.16.0.0/16",
});
const defaultSwitch = new alicloud.vpc.Switch("defaultSwitch", {
vpcId: defaultNetwork.id,
cidrBlock: "172.16.0.0/24",
zoneId: defaultZones.then(defaultZones => defaultZones.zones?.[0]?.id),
vswitchName: name,
});
const instance = new alicloud.rds.Instance("instance", {
engine: "MySQL",
engineVersion: "5.6",
instanceType: "rds.mysql.s1.small",
instanceStorage: 10,
vswitchId: defaultSwitch.id,
instanceName: name,
});
const db: alicloud.rds.Database[] = [];
for (const range = {value: 0}; range.value < 2; range.value++) {
db.push(new alicloud.rds.Database(`db-${range.value}`, {
instanceId: instance.id,
description: "from terraform",
}));
}
const account = new alicloud.rds.Account("account", {
instanceId: instance.id,
password: "Test12345",
description: "from terraform",
});
const privilege = new alicloud.rds.AccountPrivilege("privilege", {
instanceId: instance.id,
accountName: account.name,
privilege: "ReadWrite",
dbNames: db.map(__item => __item.name),
});
const default1Networks = alicloud.vpc.getNetworks({
nameRegex: "default-NODELETING",
});
const default1Switches = alicloud.vpc.getSwitches({
vpcId: data.alicloud_vpcs["default"].ids[0],
});
const defaultSubscriptionJob = new alicloud.dts.SubscriptionJob("defaultSubscriptionJob", {
dtsJobName: name,
paymentType: "PayAsYouGo",
sourceEndpointEngineName: "MySQL",
sourceEndpointRegion: "cn-hangzhou",
sourceEndpointInstanceType: "RDS",
sourceEndpointInstanceId: instance.id,
sourceEndpointDatabaseName: "tfaccountpri_0",
sourceEndpointUserName: "tftestprivilege",
sourceEndpointPassword: "Test12345",
dbList: " {\"dtstestdata\": {\"name\": \"tfaccountpri_0\", \"all\": true}}\n",
subscriptionInstanceNetworkType: "vpc",
subscriptionInstanceVpcId: default1Networks.then(default1Networks => default1Networks.ids?.[0]),
subscriptionInstanceVswitchId: default1Switches.then(default1Switches => default1Switches.ids?.[0]),
status: "Normal",
});
Coming soon!
Create SubscriptionJob Resource
new SubscriptionJob(name: string, args: SubscriptionJobArgs, opts?: CustomResourceOptions);
@overload
def SubscriptionJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
checkpoint: Optional[str] = None,
compute_unit: Optional[int] = None,
database_count: Optional[int] = None,
db_list: Optional[str] = None,
delay_notice: Optional[bool] = None,
delay_phone: Optional[str] = None,
delay_rule_time: Optional[str] = None,
destination_endpoint_engine_name: Optional[str] = None,
destination_region: Optional[str] = None,
dts_instance_id: Optional[str] = None,
dts_job_name: Optional[str] = None,
error_notice: Optional[bool] = None,
error_phone: Optional[str] = None,
instance_class: Optional[str] = None,
payment_duration: Optional[int] = None,
payment_duration_unit: Optional[str] = None,
payment_type: Optional[str] = None,
reserve: Optional[str] = None,
source_endpoint_database_name: Optional[str] = None,
source_endpoint_engine_name: Optional[str] = None,
source_endpoint_instance_id: Optional[str] = None,
source_endpoint_instance_type: Optional[str] = None,
source_endpoint_ip: Optional[str] = None,
source_endpoint_oracle_sid: Optional[str] = None,
source_endpoint_owner_id: Optional[str] = None,
source_endpoint_password: Optional[str] = None,
source_endpoint_port: Optional[str] = None,
source_endpoint_region: Optional[str] = None,
source_endpoint_role: Optional[str] = None,
source_endpoint_user_name: Optional[str] = None,
status: Optional[str] = None,
subscription_data_type_ddl: Optional[bool] = None,
subscription_data_type_dml: Optional[bool] = None,
subscription_instance_network_type: Optional[str] = None,
subscription_instance_vpc_id: Optional[str] = None,
subscription_instance_vswitch_id: Optional[str] = None,
sync_architecture: Optional[str] = None,
synchronization_direction: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None)
@overload
def SubscriptionJob(resource_name: str,
args: SubscriptionJobArgs,
opts: Optional[ResourceOptions] = None)
func NewSubscriptionJob(ctx *Context, name string, args SubscriptionJobArgs, opts ...ResourceOption) (*SubscriptionJob, error)
public SubscriptionJob(string name, SubscriptionJobArgs args, CustomResourceOptions? opts = null)
public SubscriptionJob(String name, SubscriptionJobArgs args)
public SubscriptionJob(String name, SubscriptionJobArgs args, CustomResourceOptions options)
type: alicloud:dts:SubscriptionJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SubscriptionJobArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SubscriptionJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscriptionJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscriptionJobArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
SubscriptionJob Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SubscriptionJob resource accepts the following input properties:
- Payment
Type string The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- Source
Endpoint stringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- Source
Endpoint stringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- Source
Endpoint stringRegion The region of source database.
- Checkpoint string
Subscription start time in Unix timestamp format.
- Compute
Unit int ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- Database
Count int The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- Db
List string Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- Delay
Notice bool This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- Delay
Phone string The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Delay
Rule stringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- Destination
Endpoint stringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- Destination
Region string The destination region. List of supported regions.
- Dts
Instance stringId The ID of subscription instance.
- Dts
Job stringName The name of subscription task.
- Error
Notice bool This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- Error
Phone string The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Instance
Class string The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- Payment
Duration int The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- Payment
Duration stringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- Reserve string
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint stringDatabase Name To subscribe to the name of the database.
- Source
Endpoint stringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- Source
Endpoint stringIp The IP of source endpoint.
- Source
Endpoint stringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint stringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- Source
Endpoint stringPassword The password of source database instance account.
- Source
Endpoint stringPort The port of source database.
- Source
Endpoint stringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- Source
Endpoint stringUser Name The username of source database instance account.
- Status string
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- Subscription
Data boolType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- Subscription
Data boolType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- Subscription
Instance stringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- Subscription
Instance stringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Subscription
Instance stringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Sync
Architecture string The sync architecture. Valid values:
bidirectional
,oneway
.- Synchronization
Direction string The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Payment
Type string The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- Source
Endpoint stringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- Source
Endpoint stringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- Source
Endpoint stringRegion The region of source database.
- Checkpoint string
Subscription start time in Unix timestamp format.
- Compute
Unit int ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- Database
Count int The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- Db
List string Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- Delay
Notice bool This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- Delay
Phone string The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Delay
Rule stringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- Destination
Endpoint stringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- Destination
Region string The destination region. List of supported regions.
- Dts
Instance stringId The ID of subscription instance.
- Dts
Job stringName The name of subscription task.
- Error
Notice bool This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- Error
Phone string The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Instance
Class string The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- Payment
Duration int The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- Payment
Duration stringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- Reserve string
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint stringDatabase Name To subscribe to the name of the database.
- Source
Endpoint stringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- Source
Endpoint stringIp The IP of source endpoint.
- Source
Endpoint stringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint stringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- Source
Endpoint stringPassword The password of source database instance account.
- Source
Endpoint stringPort The port of source database.
- Source
Endpoint stringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- Source
Endpoint stringUser Name The username of source database instance account.
- Status string
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- Subscription
Data boolType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- Subscription
Data boolType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- Subscription
Instance stringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- Subscription
Instance stringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Subscription
Instance stringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Sync
Architecture string The sync architecture. Valid values:
bidirectional
,oneway
.- Synchronization
Direction string The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- map[string]interface{}
A mapping of tags to assign to the resource.
- payment
Type String The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- source
Endpoint StringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source
Endpoint StringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source
Endpoint StringRegion The region of source database.
- checkpoint String
Subscription start time in Unix timestamp format.
- compute
Unit Integer ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database
Count Integer The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db
List String Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay
Notice Boolean This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay
Phone String The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay
Rule StringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination
Endpoint StringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination
Region String The destination region. List of supported regions.
- dts
Instance StringId The ID of subscription instance.
- dts
Job StringName The name of subscription task.
- error
Notice Boolean This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error
Phone String The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance
Class String The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment
Duration Integer The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Duration StringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- reserve String
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint StringDatabase Name To subscribe to the name of the database.
- source
Endpoint StringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source
Endpoint StringIp The IP of source endpoint.
- source
Endpoint StringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint StringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source
Endpoint StringPassword The password of source database instance account.
- source
Endpoint StringPort The port of source database.
- source
Endpoint StringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source
Endpoint StringUser Name The username of source database instance account.
- status String
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription
Data BooleanType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription
Data BooleanType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription
Instance StringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription
Instance StringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription
Instance StringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync
Architecture String The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization
Direction String The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Map<String,Object>
A mapping of tags to assign to the resource.
- payment
Type string The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- source
Endpoint stringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source
Endpoint stringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source
Endpoint stringRegion The region of source database.
- checkpoint string
Subscription start time in Unix timestamp format.
- compute
Unit number ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database
Count number The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db
List string Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay
Notice boolean This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay
Phone string The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay
Rule stringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination
Endpoint stringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination
Region string The destination region. List of supported regions.
- dts
Instance stringId The ID of subscription instance.
- dts
Job stringName The name of subscription task.
- error
Notice boolean This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error
Phone string The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance
Class string The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment
Duration number The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Duration stringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- reserve string
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint stringDatabase Name To subscribe to the name of the database.
- source
Endpoint stringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source
Endpoint stringIp The IP of source endpoint.
- source
Endpoint stringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint stringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source
Endpoint stringPassword The password of source database instance account.
- source
Endpoint stringPort The port of source database.
- source
Endpoint stringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source
Endpoint stringUser Name The username of source database instance account.
- status string
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription
Data booleanType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription
Data booleanType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription
Instance stringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription
Instance stringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription
Instance stringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync
Architecture string The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization
Direction string The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- {[key: string]: any}
A mapping of tags to assign to the resource.
- payment_
type str The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- source_
endpoint_ strengine_ name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source_
endpoint_ strinstance_ type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source_
endpoint_ strregion The region of source database.
- checkpoint str
Subscription start time in Unix timestamp format.
- compute_
unit int ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database_
count int The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db_
list str Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay_
notice bool This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay_
phone str The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay_
rule_ strtime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination_
endpoint_ strengine_ name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination_
region str The destination region. List of supported regions.
- dts_
instance_ strid The ID of subscription instance.
- dts_
job_ strname The name of subscription task.
- error_
notice bool This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error_
phone str The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance_
class str The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment_
duration int The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment_
duration_ strunit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- reserve str
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source_
endpoint_ strdatabase_ name To subscribe to the name of the database.
- source_
endpoint_ strinstance_ id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source_
endpoint_ strip The IP of source endpoint.
- source_
endpoint_ stroracle_ sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source_
endpoint_ strowner_ id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source_
endpoint_ strpassword The password of source database instance account.
- source_
endpoint_ strport The port of source database.
- source_
endpoint_ strrole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source_
endpoint_ struser_ name The username of source database instance account.
- status str
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription_
data_ booltype_ ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription_
data_ booltype_ dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription_
instance_ strnetwork_ type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription_
instance_ strvpc_ id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription_
instance_ strvswitch_ id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync_
architecture str The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization_
direction str The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Mapping[str, Any]
A mapping of tags to assign to the resource.
- payment
Type String The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- source
Endpoint StringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source
Endpoint StringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source
Endpoint StringRegion The region of source database.
- checkpoint String
Subscription start time in Unix timestamp format.
- compute
Unit Number ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database
Count Number The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db
List String Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay
Notice Boolean This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay
Phone String The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay
Rule StringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination
Endpoint StringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination
Region String The destination region. List of supported regions.
- dts
Instance StringId The ID of subscription instance.
- dts
Job StringName The name of subscription task.
- error
Notice Boolean This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error
Phone String The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance
Class String The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment
Duration Number The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Duration StringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- reserve String
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint StringDatabase Name To subscribe to the name of the database.
- source
Endpoint StringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source
Endpoint StringIp The IP of source endpoint.
- source
Endpoint StringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint StringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source
Endpoint StringPassword The password of source database instance account.
- source
Endpoint StringPort The port of source database.
- source
Endpoint StringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source
Endpoint StringUser Name The username of source database instance account.
- status String
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription
Data BooleanType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription
Data BooleanType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription
Instance StringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription
Instance StringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription
Instance StringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync
Architecture String The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization
Direction String The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Map<Any>
A mapping of tags to assign to the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the SubscriptionJob resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing SubscriptionJob Resource
Get an existing SubscriptionJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SubscriptionJobState, opts?: CustomResourceOptions): SubscriptionJob
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
checkpoint: Optional[str] = None,
compute_unit: Optional[int] = None,
database_count: Optional[int] = None,
db_list: Optional[str] = None,
delay_notice: Optional[bool] = None,
delay_phone: Optional[str] = None,
delay_rule_time: Optional[str] = None,
destination_endpoint_engine_name: Optional[str] = None,
destination_region: Optional[str] = None,
dts_instance_id: Optional[str] = None,
dts_job_name: Optional[str] = None,
error_notice: Optional[bool] = None,
error_phone: Optional[str] = None,
instance_class: Optional[str] = None,
payment_duration: Optional[int] = None,
payment_duration_unit: Optional[str] = None,
payment_type: Optional[str] = None,
reserve: Optional[str] = None,
source_endpoint_database_name: Optional[str] = None,
source_endpoint_engine_name: Optional[str] = None,
source_endpoint_instance_id: Optional[str] = None,
source_endpoint_instance_type: Optional[str] = None,
source_endpoint_ip: Optional[str] = None,
source_endpoint_oracle_sid: Optional[str] = None,
source_endpoint_owner_id: Optional[str] = None,
source_endpoint_password: Optional[str] = None,
source_endpoint_port: Optional[str] = None,
source_endpoint_region: Optional[str] = None,
source_endpoint_role: Optional[str] = None,
source_endpoint_user_name: Optional[str] = None,
status: Optional[str] = None,
subscription_data_type_ddl: Optional[bool] = None,
subscription_data_type_dml: Optional[bool] = None,
subscription_instance_network_type: Optional[str] = None,
subscription_instance_vpc_id: Optional[str] = None,
subscription_instance_vswitch_id: Optional[str] = None,
sync_architecture: Optional[str] = None,
synchronization_direction: Optional[str] = None,
tags: Optional[Mapping[str, Any]] = None) -> SubscriptionJob
func GetSubscriptionJob(ctx *Context, name string, id IDInput, state *SubscriptionJobState, opts ...ResourceOption) (*SubscriptionJob, error)
public static SubscriptionJob Get(string name, Input<string> id, SubscriptionJobState? state, CustomResourceOptions? opts = null)
public static SubscriptionJob get(String name, Output<String> id, SubscriptionJobState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Checkpoint string
Subscription start time in Unix timestamp format.
- Compute
Unit int ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- Database
Count int The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- Db
List string Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- Delay
Notice bool This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- Delay
Phone string The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Delay
Rule stringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- Destination
Endpoint stringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- Destination
Region string The destination region. List of supported regions.
- Dts
Instance stringId The ID of subscription instance.
- Dts
Job stringName The name of subscription task.
- Error
Notice bool This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- Error
Phone string The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Instance
Class string The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- Payment
Duration int The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- Payment
Duration stringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- Payment
Type string The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- Reserve string
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint stringDatabase Name To subscribe to the name of the database.
- Source
Endpoint stringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- Source
Endpoint stringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- Source
Endpoint stringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- Source
Endpoint stringIp The IP of source endpoint.
- Source
Endpoint stringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint stringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- Source
Endpoint stringPassword The password of source database instance account.
- Source
Endpoint stringPort The port of source database.
- Source
Endpoint stringRegion The region of source database.
- Source
Endpoint stringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- Source
Endpoint stringUser Name The username of source database instance account.
- Status string
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- Subscription
Data boolType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- Subscription
Data boolType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- Subscription
Instance stringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- Subscription
Instance stringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Subscription
Instance stringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Sync
Architecture string The sync architecture. Valid values:
bidirectional
,oneway
.- Synchronization
Direction string The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Dictionary<string, object>
A mapping of tags to assign to the resource.
- Checkpoint string
Subscription start time in Unix timestamp format.
- Compute
Unit int ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- Database
Count int The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- Db
List string Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- Delay
Notice bool This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- Delay
Phone string The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Delay
Rule stringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- Destination
Endpoint stringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- Destination
Region string The destination region. List of supported regions.
- Dts
Instance stringId The ID of subscription instance.
- Dts
Job stringName The name of subscription task.
- Error
Notice bool This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- Error
Phone string The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- Instance
Class string The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- Payment
Duration int The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- Payment
Duration stringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- Payment
Type string The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- Reserve string
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- Source
Endpoint stringDatabase Name To subscribe to the name of the database.
- Source
Endpoint stringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- Source
Endpoint stringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- Source
Endpoint stringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- Source
Endpoint stringIp The IP of source endpoint.
- Source
Endpoint stringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- Source
Endpoint stringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- Source
Endpoint stringPassword The password of source database instance account.
- Source
Endpoint stringPort The port of source database.
- Source
Endpoint stringRegion The region of source database.
- Source
Endpoint stringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- Source
Endpoint stringUser Name The username of source database instance account.
- Status string
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- Subscription
Data boolType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- Subscription
Data boolType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- Subscription
Instance stringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- Subscription
Instance stringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Subscription
Instance stringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- Sync
Architecture string The sync architecture. Valid values:
bidirectional
,oneway
.- Synchronization
Direction string The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- map[string]interface{}
A mapping of tags to assign to the resource.
- checkpoint String
Subscription start time in Unix timestamp format.
- compute
Unit Integer ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database
Count Integer The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db
List String Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay
Notice Boolean This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay
Phone String The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay
Rule StringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination
Endpoint StringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination
Region String The destination region. List of supported regions.
- dts
Instance StringId The ID of subscription instance.
- dts
Job StringName The name of subscription task.
- error
Notice Boolean This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error
Phone String The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance
Class String The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment
Duration Integer The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Duration StringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Type String The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- reserve String
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint StringDatabase Name To subscribe to the name of the database.
- source
Endpoint StringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source
Endpoint StringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source
Endpoint StringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source
Endpoint StringIp The IP of source endpoint.
- source
Endpoint StringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint StringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source
Endpoint StringPassword The password of source database instance account.
- source
Endpoint StringPort The port of source database.
- source
Endpoint StringRegion The region of source database.
- source
Endpoint StringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source
Endpoint StringUser Name The username of source database instance account.
- status String
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription
Data BooleanType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription
Data BooleanType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription
Instance StringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription
Instance StringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription
Instance StringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync
Architecture String The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization
Direction String The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Map<String,Object>
A mapping of tags to assign to the resource.
- checkpoint string
Subscription start time in Unix timestamp format.
- compute
Unit number ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database
Count number The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db
List string Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay
Notice boolean This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay
Phone string The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay
Rule stringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination
Endpoint stringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination
Region string The destination region. List of supported regions.
- dts
Instance stringId The ID of subscription instance.
- dts
Job stringName The name of subscription task.
- error
Notice boolean This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error
Phone string The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance
Class string The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment
Duration number The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Duration stringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Type string The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- reserve string
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint stringDatabase Name To subscribe to the name of the database.
- source
Endpoint stringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source
Endpoint stringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source
Endpoint stringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source
Endpoint stringIp The IP of source endpoint.
- source
Endpoint stringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint stringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source
Endpoint stringPassword The password of source database instance account.
- source
Endpoint stringPort The port of source database.
- source
Endpoint stringRegion The region of source database.
- source
Endpoint stringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source
Endpoint stringUser Name The username of source database instance account.
- status string
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription
Data booleanType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription
Data booleanType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription
Instance stringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription
Instance stringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription
Instance stringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync
Architecture string The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization
Direction string The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- {[key: string]: any}
A mapping of tags to assign to the resource.
- checkpoint str
Subscription start time in Unix timestamp format.
- compute_
unit int ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database_
count int The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db_
list str Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay_
notice bool This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay_
phone str The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay_
rule_ strtime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination_
endpoint_ strengine_ name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination_
region str The destination region. List of supported regions.
- dts_
instance_ strid The ID of subscription instance.
- dts_
job_ strname The name of subscription task.
- error_
notice bool This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error_
phone str The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance_
class str The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment_
duration int The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment_
duration_ strunit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- payment_
type str The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- reserve str
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source_
endpoint_ strdatabase_ name To subscribe to the name of the database.
- source_
endpoint_ strengine_ name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source_
endpoint_ strinstance_ id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source_
endpoint_ strinstance_ type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source_
endpoint_ strip The IP of source endpoint.
- source_
endpoint_ stroracle_ sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source_
endpoint_ strowner_ id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source_
endpoint_ strpassword The password of source database instance account.
- source_
endpoint_ strport The port of source database.
- source_
endpoint_ strregion The region of source database.
- source_
endpoint_ strrole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source_
endpoint_ struser_ name The username of source database instance account.
- status str
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription_
data_ booltype_ ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription_
data_ booltype_ dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription_
instance_ strnetwork_ type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription_
instance_ strvpc_ id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription_
instance_ strvswitch_ id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync_
architecture str The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization_
direction str The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Mapping[str, Any]
A mapping of tags to assign to the resource.
- checkpoint String
Subscription start time in Unix timestamp format.
- compute
Unit Number ETL specifications. The unit is the computing unit ComputeUnit (CU), 1CU=1vCPU+4 GB memory. The value range is an integer greater than or equal to 2.
- database
Count Number The number of private customized RDS instances under PolarDB-X. The default value is 1. This parameter needs to be passed only when
source_endpoint_engine_name
equalsdrds
.- db
List String Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
- delay
Notice Boolean This parameter decides whether to monitor the delay status. Valid values:
true
,false
.- delay
Phone String The mobile phone number of the contact who delayed the alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- delay
Rule StringTime When
delay_notice
is set totrue
, this parameter must be passed in. The threshold for triggering the delay alarm. The unit is second and needs to be an integer. The threshold can be set according to business needs. It is recommended to set it above 10 seconds to avoid delay fluctuations caused by network and database load.- destination
Endpoint StringEngine Name The destination endpoint engine name. Valid values:
ADS
,DB2
,DRDS
,DataHub
,Greenplum
,MSSQL
,MySQL
,PolarDB
,PostgreSQL
,Redis
,Tablestore
,as400
,clickhouse
,kafka
,mongodb
,odps
,oracle
,polardb_o
,polardb_pg
,tidb
.- destination
Region String The destination region. List of supported regions.
- dts
Instance StringId The ID of subscription instance.
- dts
Job StringName The name of subscription task.
- error
Notice Boolean This parameter decides whether to monitor abnormal status. Valid values:
true
,false
.- error
Phone String The mobile phone number of the contact for abnormal alarm. Multiple mobile phone numbers separated by English commas
,
. This parameter currently only supports China stations, and only supports mainland mobile phone numbers, and up to 10 mobile phone numbers can be passed in.- instance
Class String The instance class. Valid values:
large
,medium
,micro
,small
,xlarge
,xxlarge
.- payment
Duration Number The duration of prepaid instance purchase. When
payment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Duration StringUnit The payment duration unit. Valid values:
Month
,Year
. Whenpayment_type
isSubscription
, this parameter is valid and must be passed in.- payment
Type String The payment type of the resource. Valid values:
Subscription
,PayAsYouGo
.- reserve String
DTS reserves parameters, the format is a JSON string, you can pass in this parameter to complete the source and target database information (such as the data storage format of the target Kafka database, the instance ID of the cloud enterprise network CEN). For more information, please refer to the parameter description of the Reserve parameter.
- source
Endpoint StringDatabase Name To subscribe to the name of the database.
- source
Endpoint StringEngine Name The source database type value is MySQL or Oracle. Valid values:
MySQL
,Oracle
.- source
Endpoint StringInstance Id The ID of source instance. Only when the type of source database instance was RDS MySQL, PolarDB-X 1.0, PolarDB MySQL, this parameter can be available and must be set.
- source
Endpoint StringInstance Type The type of source instance. Valid values:
RDS
,PolarDB
,DRDS
,LocalInstance
,ECS
,Express
,CEN
,dg
.- source
Endpoint StringIp The IP of source endpoint.
- source
Endpoint StringOracle Sid The SID of Oracle Database. When the source database is self-built Oracle and the Oracle database is a non-RAC instance, this parameter is available and must be passed in.
- source
Endpoint StringOwner Id The Alibaba Cloud account ID to which the source instance belongs. This parameter is only available when configuring data subscriptions across Alibaba Cloud accounts and must be passed in.
- source
Endpoint StringPassword The password of source database instance account.
- source
Endpoint StringPort The port of source database.
- source
Endpoint StringRegion The region of source database.
- source
Endpoint StringRole Both the authorization roles. When the source instance and configure subscriptions task of the Alibaba Cloud account is not the same as the need to pass the parameter, to specify the source of the authorization roles, to allow configuration subscription task of the Alibaba Cloud account to access the source of the source instance information.
- source
Endpoint StringUser Name The username of source database instance account.
- status String
The status of the task. Valid values:
Normal
,Abnormal
. When a task created, it is in this state ofNotStarted
. You can specify this state toNormal
to start the job, and specify this state ofAbnormal
to stop the job. Note: We treat the stateStarting
as the state ofNormal
, and consider the two states to be consistent on the user side.- subscription
Data BooleanType Ddl Whether to subscribe the DDL type of data. Valid values:
true
,false
.- subscription
Data BooleanType Dml Whether to subscribe the DML type of data. Valid values:
true
,false
.- subscription
Instance StringNetwork Type Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values:
classic
,vpc
.- subscription
Instance StringVpc Id The ID of subscription vpc instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- subscription
Instance StringVswitch Id The ID of subscription VSwitch instance. When the value of
subscription_instance_network_type
is vpc, this parameter is available and must be passed in.- sync
Architecture String The sync architecture. Valid values:
bidirectional
,oneway
.- synchronization
Direction String The synchronization direction. Valid values:
Forward
,Reverse
. When the topology type of the data synchronization instance is bidirectional, it can be passed in to reverse to start the reverse synchronization link.- Map<Any>
A mapping of tags to assign to the resource.
Import
DTS Subscription Job can be imported using the id, e.g.
$ pulumi import alicloud:dts/subscriptionJob:SubscriptionJob example <id>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.