Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. dts
  5. SubscriptionJob
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.dts.SubscriptionJob

Explore with Pulumi AI

Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a DTS Subscription Job resource.

For information about DTS Subscription Job and how to use it, see What is Subscription Job.

NOTE: Available since v1.138.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const example = alicloud.getRegions({
    current: true,
});
const exampleGetZones = alicloud.rds.getZones({
    engine: "MySQL",
    engineVersion: "8.0",
    instanceChargeType: "PostPaid",
    category: "Basic",
    dbInstanceStorageType: "cloud_essd",
});
const exampleGetInstanceClasses = exampleGetZones.then(exampleGetZones => alicloud.rds.getInstanceClasses({
    zoneId: exampleGetZones.zones?.[0]?.id,
    engine: "MySQL",
    engineVersion: "8.0",
    instanceChargeType: "PostPaid",
    category: "Basic",
    dbInstanceStorageType: "cloud_essd",
}));
const exampleNetwork = new alicloud.vpc.Network("example", {
    vpcName: name,
    cidrBlock: "172.16.0.0/16",
});
const exampleSwitch = new alicloud.vpc.Switch("example", {
    vpcId: exampleNetwork.id,
    cidrBlock: "172.16.0.0/24",
    zoneId: exampleGetZones.then(exampleGetZones => exampleGetZones.zones?.[0]?.id),
    vswitchName: name,
});
const exampleSecurityGroup = new alicloud.ecs.SecurityGroup("example", {
    name: name,
    vpcId: exampleNetwork.id,
});
const exampleInstance = new alicloud.rds.Instance("example", {
    engine: "MySQL",
    engineVersion: "8.0",
    instanceType: exampleGetInstanceClasses.then(exampleGetInstanceClasses => exampleGetInstanceClasses.instanceClasses?.[0]?.instanceClass),
    instanceStorage: exampleGetInstanceClasses.then(exampleGetInstanceClasses => exampleGetInstanceClasses.instanceClasses?.[0]?.storageRange?.min),
    instanceChargeType: "Postpaid",
    instanceName: name,
    vswitchId: exampleSwitch.id,
    monitoringPeriod: 60,
    dbInstanceStorageType: "cloud_essd",
    securityGroupIds: [exampleSecurityGroup.id],
});
const exampleRdsAccount = new alicloud.rds.RdsAccount("example", {
    dbInstanceId: exampleInstance.id,
    accountName: "test_mysql",
    accountPassword: "N1cetest",
});
const exampleDatabase = new alicloud.rds.Database("example", {
    instanceId: exampleInstance.id,
    name: name,
});
const exampleAccountPrivilege = new alicloud.rds.AccountPrivilege("example", {
    instanceId: exampleInstance.id,
    accountName: exampleRdsAccount.accountName,
    privilege: "ReadWrite",
    dbNames: [exampleDatabase.name],
});
const exampleSubscriptionJob = new alicloud.dts.SubscriptionJob("example", {
    dtsJobName: name,
    paymentType: "PayAsYouGo",
    sourceEndpointEngineName: "MySQL",
    sourceEndpointRegion: example.then(example => example.regions?.[0]?.id),
    sourceEndpointInstanceType: "RDS",
    sourceEndpointInstanceId: exampleInstance.id,
    sourceEndpointDatabaseName: exampleDatabase.name,
    sourceEndpointUserName: exampleRdsAccount.accountName,
    sourceEndpointPassword: exampleRdsAccount.accountPassword,
    dbList: pulumi.jsonStringify(pulumi.all([exampleDatabase.name, exampleDatabase.name]).apply(([exampleDatabaseName, exampleDatabaseName1]) => {
        [exampleDatabaseName]: {
            name: exampleDatabaseName1,
            all: true,
        },
    })),
    subscriptionInstanceNetworkType: "vpc",
    subscriptionInstanceVpcId: exampleNetwork.id,
    subscriptionInstanceVswitchId: exampleSwitch.id,
    status: "Normal",
});
Copy
import pulumi
import json
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
example = alicloud.get_regions(current=True)
example_get_zones = alicloud.rds.get_zones(engine="MySQL",
    engine_version="8.0",
    instance_charge_type="PostPaid",
    category="Basic",
    db_instance_storage_type="cloud_essd")
example_get_instance_classes = alicloud.rds.get_instance_classes(zone_id=example_get_zones.zones[0].id,
    engine="MySQL",
    engine_version="8.0",
    instance_charge_type="PostPaid",
    category="Basic",
    db_instance_storage_type="cloud_essd")
example_network = alicloud.vpc.Network("example",
    vpc_name=name,
    cidr_block="172.16.0.0/16")
example_switch = alicloud.vpc.Switch("example",
    vpc_id=example_network.id,
    cidr_block="172.16.0.0/24",
    zone_id=example_get_zones.zones[0].id,
    vswitch_name=name)
example_security_group = alicloud.ecs.SecurityGroup("example",
    name=name,
    vpc_id=example_network.id)
example_instance = alicloud.rds.Instance("example",
    engine="MySQL",
    engine_version="8.0",
    instance_type=example_get_instance_classes.instance_classes[0].instance_class,
    instance_storage=example_get_instance_classes.instance_classes[0].storage_range.min,
    instance_charge_type="Postpaid",
    instance_name=name,
    vswitch_id=example_switch.id,
    monitoring_period=60,
    db_instance_storage_type="cloud_essd",
    security_group_ids=[example_security_group.id])
example_rds_account = alicloud.rds.RdsAccount("example",
    db_instance_id=example_instance.id,
    account_name="test_mysql",
    account_password="N1cetest")
example_database = alicloud.rds.Database("example",
    instance_id=example_instance.id,
    name=name)
example_account_privilege = alicloud.rds.AccountPrivilege("example",
    instance_id=example_instance.id,
    account_name=example_rds_account.account_name,
    privilege="ReadWrite",
    db_names=[example_database.name])
example_subscription_job = alicloud.dts.SubscriptionJob("example",
    dts_job_name=name,
    payment_type="PayAsYouGo",
    source_endpoint_engine_name="MySQL",
    source_endpoint_region=example.regions[0].id,
    source_endpoint_instance_type="RDS",
    source_endpoint_instance_id=example_instance.id,
    source_endpoint_database_name=example_database.name,
    source_endpoint_user_name=example_rds_account.account_name,
    source_endpoint_password=example_rds_account.account_password,
    db_list=pulumi.Output.json_dumps(pulumi.Output.all(
        exampleDatabaseName=example_database.name,
        exampleDatabaseName1=example_database.name
).apply(lambda resolved_outputs: {
        resolved_outputs['exampleDatabaseName']: {
            "name": resolved_outputs['exampleDatabaseName1'],
            "all": True,
        },
    })
),
    subscription_instance_network_type="vpc",
    subscription_instance_vpc_id=example_network.id,
    subscription_instance_vswitch_id=example_switch.id,
    status="Normal")
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		example, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
			Current: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetZones, err := rds.GetZones(ctx, &rds.GetZonesArgs{
			Engine:                pulumi.StringRef("MySQL"),
			EngineVersion:         pulumi.StringRef("8.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("Basic"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetInstanceClasses, err := rds.GetInstanceClasses(ctx, &rds.GetInstanceClassesArgs{
			ZoneId:                pulumi.StringRef(exampleGetZones.Zones[0].Id),
			Engine:                pulumi.StringRef("MySQL"),
			EngineVersion:         pulumi.StringRef("8.0"),
			InstanceChargeType:    pulumi.StringRef("PostPaid"),
			Category:              pulumi.StringRef("Basic"),
			DbInstanceStorageType: pulumi.StringRef("cloud_essd"),
		}, nil)
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
			VpcId:       exampleNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/24"),
			ZoneId:      pulumi.String(exampleGetZones.Zones[0].Id),
			VswitchName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "example", &ecs.SecurityGroupArgs{
			Name:  pulumi.String(name),
			VpcId: exampleNetwork.ID(),
		})
		if err != nil {
			return err
		}
		exampleInstance, err := rds.NewInstance(ctx, "example", &rds.InstanceArgs{
			Engine:                pulumi.String("MySQL"),
			EngineVersion:         pulumi.String("8.0"),
			InstanceType:          pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].InstanceClass),
			InstanceStorage:       pulumi.String(exampleGetInstanceClasses.InstanceClasses[0].StorageRange.Min),
			InstanceChargeType:    pulumi.String("Postpaid"),
			InstanceName:          pulumi.String(name),
			VswitchId:             exampleSwitch.ID(),
			MonitoringPeriod:      pulumi.Int(60),
			DbInstanceStorageType: pulumi.String("cloud_essd"),
			SecurityGroupIds: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
		})
		if err != nil {
			return err
		}
		exampleRdsAccount, err := rds.NewRdsAccount(ctx, "example", &rds.RdsAccountArgs{
			DbInstanceId:    exampleInstance.ID(),
			AccountName:     pulumi.String("test_mysql"),
			AccountPassword: pulumi.String("N1cetest"),
		})
		if err != nil {
			return err
		}
		exampleDatabase, err := rds.NewDatabase(ctx, "example", &rds.DatabaseArgs{
			InstanceId: exampleInstance.ID(),
			Name:       pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = rds.NewAccountPrivilege(ctx, "example", &rds.AccountPrivilegeArgs{
			InstanceId:  exampleInstance.ID(),
			AccountName: exampleRdsAccount.AccountName,
			Privilege:   pulumi.String("ReadWrite"),
			DbNames: pulumi.StringArray{
				exampleDatabase.Name,
			},
		})
		if err != nil {
			return err
		}
		_, err = dts.NewSubscriptionJob(ctx, "example", &dts.SubscriptionJobArgs{
			DtsJobName:                 pulumi.String(name),
			PaymentType:                pulumi.String("PayAsYouGo"),
			SourceEndpointEngineName:   pulumi.String("MySQL"),
			SourceEndpointRegion:       pulumi.String(example.Regions[0].Id),
			SourceEndpointInstanceType: pulumi.String("RDS"),
			SourceEndpointInstanceId:   exampleInstance.ID(),
			SourceEndpointDatabaseName: exampleDatabase.Name,
			SourceEndpointUserName:     exampleRdsAccount.AccountName,
			SourceEndpointPassword:     exampleRdsAccount.AccountPassword,
			DbList: pulumi.All(exampleDatabase.Name, exampleDatabase.Name).ApplyT(func(_args []interface{}) (string, error) {
				exampleDatabaseName := _args[0].(string)
				exampleDatabaseName1 := _args[1].(string)
				var _zero string
				tmpJSON0, err := json.Marshal(map[string]map[string]interface{}{
					exampleDatabaseName: map[string]interface{}{
						"name": exampleDatabaseName1,
						"all":  true,
					},
				})
				if err != nil {
					return _zero, err
				}
				json0 := string(tmpJSON0)
				return json0, nil
			}).(pulumi.StringOutput),
			SubscriptionInstanceNetworkType: pulumi.String("vpc"),
			SubscriptionInstanceVpcId:       exampleNetwork.ID(),
			SubscriptionInstanceVswitchId:   exampleSwitch.ID(),
			Status:                          pulumi.String("Normal"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var example = AliCloud.GetRegions.Invoke(new()
    {
        Current = true,
    });

    var exampleGetZones = AliCloud.Rds.GetZones.Invoke(new()
    {
        Engine = "MySQL",
        EngineVersion = "8.0",
        InstanceChargeType = "PostPaid",
        Category = "Basic",
        DbInstanceStorageType = "cloud_essd",
    });

    var exampleGetInstanceClasses = AliCloud.Rds.GetInstanceClasses.Invoke(new()
    {
        ZoneId = exampleGetZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        Engine = "MySQL",
        EngineVersion = "8.0",
        InstanceChargeType = "PostPaid",
        Category = "Basic",
        DbInstanceStorageType = "cloud_essd",
    });

    var exampleNetwork = new AliCloud.Vpc.Network("example", new()
    {
        VpcName = name,
        CidrBlock = "172.16.0.0/16",
    });

    var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
    {
        VpcId = exampleNetwork.Id,
        CidrBlock = "172.16.0.0/24",
        ZoneId = exampleGetZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VswitchName = name,
    });

    var exampleSecurityGroup = new AliCloud.Ecs.SecurityGroup("example", new()
    {
        Name = name,
        VpcId = exampleNetwork.Id,
    });

    var exampleInstance = new AliCloud.Rds.Instance("example", new()
    {
        Engine = "MySQL",
        EngineVersion = "8.0",
        InstanceType = exampleGetInstanceClasses.Apply(getInstanceClassesResult => getInstanceClassesResult.InstanceClasses[0]?.InstanceClass),
        InstanceStorage = exampleGetInstanceClasses.Apply(getInstanceClassesResult => getInstanceClassesResult.InstanceClasses[0]?.StorageRange?.Min),
        InstanceChargeType = "Postpaid",
        InstanceName = name,
        VswitchId = exampleSwitch.Id,
        MonitoringPeriod = 60,
        DbInstanceStorageType = "cloud_essd",
        SecurityGroupIds = new[]
        {
            exampleSecurityGroup.Id,
        },
    });

    var exampleRdsAccount = new AliCloud.Rds.RdsAccount("example", new()
    {
        DbInstanceId = exampleInstance.Id,
        AccountName = "test_mysql",
        AccountPassword = "N1cetest",
    });

    var exampleDatabase = new AliCloud.Rds.Database("example", new()
    {
        InstanceId = exampleInstance.Id,
        Name = name,
    });

    var exampleAccountPrivilege = new AliCloud.Rds.AccountPrivilege("example", new()
    {
        InstanceId = exampleInstance.Id,
        AccountName = exampleRdsAccount.AccountName,
        Privilege = "ReadWrite",
        DbNames = new[]
        {
            exampleDatabase.Name,
        },
    });

    var exampleSubscriptionJob = new AliCloud.Dts.SubscriptionJob("example", new()
    {
        DtsJobName = name,
        PaymentType = "PayAsYouGo",
        SourceEndpointEngineName = "MySQL",
        SourceEndpointRegion = example.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id),
        SourceEndpointInstanceType = "RDS",
        SourceEndpointInstanceId = exampleInstance.Id,
        SourceEndpointDatabaseName = exampleDatabase.Name,
        SourceEndpointUserName = exampleRdsAccount.AccountName,
        SourceEndpointPassword = exampleRdsAccount.AccountPassword,
        DbList = Output.JsonSerialize(Output.Create(Output.Tuple(exampleDatabase.Name, exampleDatabase.Name).Apply(values =>
        {
            var exampleDatabaseName = values.Item1;
            var exampleDatabaseName1 = values.Item2;
            return 
            {
                { exampleDatabaseName, 
                {
                    { "name", exampleDatabaseName1 },
                    { "all", true },
                } },
            };
        }))),
        SubscriptionInstanceNetworkType = "vpc",
        SubscriptionInstanceVpcId = exampleNetwork.Id,
        SubscriptionInstanceVswitchId = exampleSwitch.Id,
        Status = "Normal",
    });

});
Copy
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.GetRegionsArgs;
import com.pulumi.alicloud.rds.RdsFunctions;
import com.pulumi.alicloud.rds.inputs.GetZonesArgs;
import com.pulumi.alicloud.rds.inputs.GetInstanceClassesArgs;
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.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.RdsAccount;
import com.pulumi.alicloud.rds.RdsAccountArgs;
import com.pulumi.alicloud.rds.Database;
import com.pulumi.alicloud.rds.DatabaseArgs;
import com.pulumi.alicloud.rds.AccountPrivilege;
import com.pulumi.alicloud.rds.AccountPrivilegeArgs;
import com.pulumi.alicloud.dts.SubscriptionJob;
import com.pulumi.alicloud.dts.SubscriptionJobArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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("terraform-example");
        final var example = AlicloudFunctions.getRegions(GetRegionsArgs.builder()
            .current(true)
            .build());

        final var exampleGetZones = RdsFunctions.getZones(GetZonesArgs.builder()
            .engine("MySQL")
            .engineVersion("8.0")
            .instanceChargeType("PostPaid")
            .category("Basic")
            .dbInstanceStorageType("cloud_essd")
            .build());

        final var exampleGetInstanceClasses = RdsFunctions.getInstanceClasses(GetInstanceClassesArgs.builder()
            .zoneId(exampleGetZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .engine("MySQL")
            .engineVersion("8.0")
            .instanceChargeType("PostPaid")
            .category("Basic")
            .dbInstanceStorageType("cloud_essd")
            .build());

        var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("172.16.0.0/16")
            .build());

        var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
            .vpcId(exampleNetwork.id())
            .cidrBlock("172.16.0.0/24")
            .zoneId(exampleGetZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vswitchName(name)
            .build());

        var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
            .name(name)
            .vpcId(exampleNetwork.id())
            .build());

        var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
            .engine("MySQL")
            .engineVersion("8.0")
            .instanceType(exampleGetInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].instanceClass()))
            .instanceStorage(exampleGetInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].storageRange().min()))
            .instanceChargeType("Postpaid")
            .instanceName(name)
            .vswitchId(exampleSwitch.id())
            .monitoringPeriod("60")
            .dbInstanceStorageType("cloud_essd")
            .securityGroupIds(exampleSecurityGroup.id())
            .build());

        var exampleRdsAccount = new RdsAccount("exampleRdsAccount", RdsAccountArgs.builder()
            .dbInstanceId(exampleInstance.id())
            .accountName("test_mysql")
            .accountPassword("N1cetest")
            .build());

        var exampleDatabase = new Database("exampleDatabase", DatabaseArgs.builder()
            .instanceId(exampleInstance.id())
            .name(name)
            .build());

        var exampleAccountPrivilege = new AccountPrivilege("exampleAccountPrivilege", AccountPrivilegeArgs.builder()
            .instanceId(exampleInstance.id())
            .accountName(exampleRdsAccount.accountName())
            .privilege("ReadWrite")
            .dbNames(exampleDatabase.name())
            .build());

        var exampleSubscriptionJob = new SubscriptionJob("exampleSubscriptionJob", SubscriptionJobArgs.builder()
            .dtsJobName(name)
            .paymentType("PayAsYouGo")
            .sourceEndpointEngineName("MySQL")
            .sourceEndpointRegion(example.applyValue(getRegionsResult -> getRegionsResult.regions()[0].id()))
            .sourceEndpointInstanceType("RDS")
            .sourceEndpointInstanceId(exampleInstance.id())
            .sourceEndpointDatabaseName(exampleDatabase.name())
            .sourceEndpointUserName(exampleRdsAccount.accountName())
            .sourceEndpointPassword(exampleRdsAccount.accountPassword())
            .dbList(Output.tuple(exampleDatabase.name(), exampleDatabase.name()).applyValue(values -> {
                var exampleDatabaseName = values.t1;
                var exampleDatabaseName1 = values.t2;
                return serializeJson(
                    jsonObject(
                        jsonProperty(exampleDatabaseName, jsonObject(
                            jsonProperty("name", exampleDatabaseName1),
                            jsonProperty("all", true)
                        ))
                    ));
            }))
            .subscriptionInstanceNetworkType("vpc")
            .subscriptionInstanceVpcId(exampleNetwork.id())
            .subscriptionInstanceVswitchId(exampleSwitch.id())
            .status("Normal")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform-example
resources:
  exampleNetwork:
    type: alicloud:vpc:Network
    name: example
    properties:
      vpcName: ${name}
      cidrBlock: 172.16.0.0/16
  exampleSwitch:
    type: alicloud:vpc:Switch
    name: example
    properties:
      vpcId: ${exampleNetwork.id}
      cidrBlock: 172.16.0.0/24
      zoneId: ${exampleGetZones.zones[0].id}
      vswitchName: ${name}
  exampleSecurityGroup:
    type: alicloud:ecs:SecurityGroup
    name: example
    properties:
      name: ${name}
      vpcId: ${exampleNetwork.id}
  exampleInstance:
    type: alicloud:rds:Instance
    name: example
    properties:
      engine: MySQL
      engineVersion: '8.0'
      instanceType: ${exampleGetInstanceClasses.instanceClasses[0].instanceClass}
      instanceStorage: ${exampleGetInstanceClasses.instanceClasses[0].storageRange.min}
      instanceChargeType: Postpaid
      instanceName: ${name}
      vswitchId: ${exampleSwitch.id}
      monitoringPeriod: '60'
      dbInstanceStorageType: cloud_essd
      securityGroupIds:
        - ${exampleSecurityGroup.id}
  exampleRdsAccount:
    type: alicloud:rds:RdsAccount
    name: example
    properties:
      dbInstanceId: ${exampleInstance.id}
      accountName: test_mysql
      accountPassword: N1cetest
  exampleDatabase:
    type: alicloud:rds:Database
    name: example
    properties:
      instanceId: ${exampleInstance.id}
      name: ${name}
  exampleAccountPrivilege:
    type: alicloud:rds:AccountPrivilege
    name: example
    properties:
      instanceId: ${exampleInstance.id}
      accountName: ${exampleRdsAccount.accountName}
      privilege: ReadWrite
      dbNames:
        - ${exampleDatabase.name}
  exampleSubscriptionJob:
    type: alicloud:dts:SubscriptionJob
    name: example
    properties:
      dtsJobName: ${name}
      paymentType: PayAsYouGo
      sourceEndpointEngineName: MySQL
      sourceEndpointRegion: ${example.regions[0].id}
      sourceEndpointInstanceType: RDS
      sourceEndpointInstanceId: ${exampleInstance.id}
      sourceEndpointDatabaseName: ${exampleDatabase.name}
      sourceEndpointUserName: ${exampleRdsAccount.accountName}
      sourceEndpointPassword: ${exampleRdsAccount.accountPassword}
      dbList:
        fn::toJSON:
          ${exampleDatabase.name}:
            name: ${exampleDatabase.name}
            all: true
      subscriptionInstanceNetworkType: vpc
      subscriptionInstanceVpcId: ${exampleNetwork.id}
      subscriptionInstanceVswitchId: ${exampleSwitch.id}
      status: Normal
variables:
  example:
    fn::invoke:
      function: alicloud:getRegions
      arguments:
        current: true
  exampleGetZones:
    fn::invoke:
      function: alicloud:rds:getZones
      arguments:
        engine: MySQL
        engineVersion: '8.0'
        instanceChargeType: PostPaid
        category: Basic
        dbInstanceStorageType: cloud_essd
  exampleGetInstanceClasses:
    fn::invoke:
      function: alicloud:rds:getInstanceClasses
      arguments:
        zoneId: ${exampleGetZones.zones[0].id}
        engine: MySQL
        engineVersion: '8.0'
        instanceChargeType: PostPaid
        category: Basic
        dbInstanceStorageType: cloud_essd
Copy

Create SubscriptionJob Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SubscriptionJob(name: string, args: SubscriptionJobArgs, opts?: CustomResourceOptions);
@overload
def SubscriptionJob(resource_name: str,
                    args: SubscriptionJobArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SubscriptionJob(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    payment_type: Optional[str] = None,
                    source_endpoint_region: Optional[str] = None,
                    source_endpoint_instance_type: Optional[str] = None,
                    source_endpoint_engine_name: Optional[str] = None,
                    dts_instance_id: Optional[str] = None,
                    database_count: Optional[int] = None,
                    delay_rule_time: Optional[str] = None,
                    destination_endpoint_engine_name: Optional[str] = None,
                    destination_region: Optional[str] = None,
                    checkpoint: 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,
                    delay_notice: Optional[bool] = None,
                    reserve: Optional[str] = None,
                    source_endpoint_database_name: Optional[str] = None,
                    db_list: Optional[str] = None,
                    source_endpoint_instance_id: Optional[str] = None,
                    delay_phone: 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,
                    compute_unit: Optional[int] = 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, str]] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. SubscriptionJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SubscriptionJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SubscriptionJobArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var subscriptionJobResource = new AliCloud.Dts.SubscriptionJob("subscriptionJobResource", new()
{
    PaymentType = "string",
    SourceEndpointRegion = "string",
    SourceEndpointInstanceType = "string",
    SourceEndpointEngineName = "string",
    DtsInstanceId = "string",
    DatabaseCount = 0,
    DelayRuleTime = "string",
    DestinationEndpointEngineName = "string",
    DestinationRegion = "string",
    Checkpoint = "string",
    DtsJobName = "string",
    ErrorNotice = false,
    ErrorPhone = "string",
    InstanceClass = "string",
    PaymentDuration = 0,
    PaymentDurationUnit = "string",
    DelayNotice = false,
    Reserve = "string",
    SourceEndpointDatabaseName = "string",
    DbList = "string",
    SourceEndpointInstanceId = "string",
    DelayPhone = "string",
    SourceEndpointIp = "string",
    SourceEndpointOracleSid = "string",
    SourceEndpointOwnerId = "string",
    SourceEndpointPassword = "string",
    SourceEndpointPort = "string",
    ComputeUnit = 0,
    SourceEndpointRole = "string",
    SourceEndpointUserName = "string",
    Status = "string",
    SubscriptionDataTypeDdl = false,
    SubscriptionDataTypeDml = false,
    SubscriptionInstanceNetworkType = "string",
    SubscriptionInstanceVpcId = "string",
    SubscriptionInstanceVswitchId = "string",
    SyncArchitecture = "string",
    SynchronizationDirection = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := dts.NewSubscriptionJob(ctx, "subscriptionJobResource", &dts.SubscriptionJobArgs{
	PaymentType:                     pulumi.String("string"),
	SourceEndpointRegion:            pulumi.String("string"),
	SourceEndpointInstanceType:      pulumi.String("string"),
	SourceEndpointEngineName:        pulumi.String("string"),
	DtsInstanceId:                   pulumi.String("string"),
	DatabaseCount:                   pulumi.Int(0),
	DelayRuleTime:                   pulumi.String("string"),
	DestinationEndpointEngineName:   pulumi.String("string"),
	DestinationRegion:               pulumi.String("string"),
	Checkpoint:                      pulumi.String("string"),
	DtsJobName:                      pulumi.String("string"),
	ErrorNotice:                     pulumi.Bool(false),
	ErrorPhone:                      pulumi.String("string"),
	InstanceClass:                   pulumi.String("string"),
	PaymentDuration:                 pulumi.Int(0),
	PaymentDurationUnit:             pulumi.String("string"),
	DelayNotice:                     pulumi.Bool(false),
	Reserve:                         pulumi.String("string"),
	SourceEndpointDatabaseName:      pulumi.String("string"),
	DbList:                          pulumi.String("string"),
	SourceEndpointInstanceId:        pulumi.String("string"),
	DelayPhone:                      pulumi.String("string"),
	SourceEndpointIp:                pulumi.String("string"),
	SourceEndpointOracleSid:         pulumi.String("string"),
	SourceEndpointOwnerId:           pulumi.String("string"),
	SourceEndpointPassword:          pulumi.String("string"),
	SourceEndpointPort:              pulumi.String("string"),
	ComputeUnit:                     pulumi.Int(0),
	SourceEndpointRole:              pulumi.String("string"),
	SourceEndpointUserName:          pulumi.String("string"),
	Status:                          pulumi.String("string"),
	SubscriptionDataTypeDdl:         pulumi.Bool(false),
	SubscriptionDataTypeDml:         pulumi.Bool(false),
	SubscriptionInstanceNetworkType: pulumi.String("string"),
	SubscriptionInstanceVpcId:       pulumi.String("string"),
	SubscriptionInstanceVswitchId:   pulumi.String("string"),
	SyncArchitecture:                pulumi.String("string"),
	SynchronizationDirection:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var subscriptionJobResource = new SubscriptionJob("subscriptionJobResource", SubscriptionJobArgs.builder()
    .paymentType("string")
    .sourceEndpointRegion("string")
    .sourceEndpointInstanceType("string")
    .sourceEndpointEngineName("string")
    .dtsInstanceId("string")
    .databaseCount(0)
    .delayRuleTime("string")
    .destinationEndpointEngineName("string")
    .destinationRegion("string")
    .checkpoint("string")
    .dtsJobName("string")
    .errorNotice(false)
    .errorPhone("string")
    .instanceClass("string")
    .paymentDuration(0)
    .paymentDurationUnit("string")
    .delayNotice(false)
    .reserve("string")
    .sourceEndpointDatabaseName("string")
    .dbList("string")
    .sourceEndpointInstanceId("string")
    .delayPhone("string")
    .sourceEndpointIp("string")
    .sourceEndpointOracleSid("string")
    .sourceEndpointOwnerId("string")
    .sourceEndpointPassword("string")
    .sourceEndpointPort("string")
    .computeUnit(0)
    .sourceEndpointRole("string")
    .sourceEndpointUserName("string")
    .status("string")
    .subscriptionDataTypeDdl(false)
    .subscriptionDataTypeDml(false)
    .subscriptionInstanceNetworkType("string")
    .subscriptionInstanceVpcId("string")
    .subscriptionInstanceVswitchId("string")
    .syncArchitecture("string")
    .synchronizationDirection("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
subscription_job_resource = alicloud.dts.SubscriptionJob("subscriptionJobResource",
    payment_type="string",
    source_endpoint_region="string",
    source_endpoint_instance_type="string",
    source_endpoint_engine_name="string",
    dts_instance_id="string",
    database_count=0,
    delay_rule_time="string",
    destination_endpoint_engine_name="string",
    destination_region="string",
    checkpoint="string",
    dts_job_name="string",
    error_notice=False,
    error_phone="string",
    instance_class="string",
    payment_duration=0,
    payment_duration_unit="string",
    delay_notice=False,
    reserve="string",
    source_endpoint_database_name="string",
    db_list="string",
    source_endpoint_instance_id="string",
    delay_phone="string",
    source_endpoint_ip="string",
    source_endpoint_oracle_sid="string",
    source_endpoint_owner_id="string",
    source_endpoint_password="string",
    source_endpoint_port="string",
    compute_unit=0,
    source_endpoint_role="string",
    source_endpoint_user_name="string",
    status="string",
    subscription_data_type_ddl=False,
    subscription_data_type_dml=False,
    subscription_instance_network_type="string",
    subscription_instance_vpc_id="string",
    subscription_instance_vswitch_id="string",
    sync_architecture="string",
    synchronization_direction="string",
    tags={
        "string": "string",
    })
Copy
const subscriptionJobResource = new alicloud.dts.SubscriptionJob("subscriptionJobResource", {
    paymentType: "string",
    sourceEndpointRegion: "string",
    sourceEndpointInstanceType: "string",
    sourceEndpointEngineName: "string",
    dtsInstanceId: "string",
    databaseCount: 0,
    delayRuleTime: "string",
    destinationEndpointEngineName: "string",
    destinationRegion: "string",
    checkpoint: "string",
    dtsJobName: "string",
    errorNotice: false,
    errorPhone: "string",
    instanceClass: "string",
    paymentDuration: 0,
    paymentDurationUnit: "string",
    delayNotice: false,
    reserve: "string",
    sourceEndpointDatabaseName: "string",
    dbList: "string",
    sourceEndpointInstanceId: "string",
    delayPhone: "string",
    sourceEndpointIp: "string",
    sourceEndpointOracleSid: "string",
    sourceEndpointOwnerId: "string",
    sourceEndpointPassword: "string",
    sourceEndpointPort: "string",
    computeUnit: 0,
    sourceEndpointRole: "string",
    sourceEndpointUserName: "string",
    status: "string",
    subscriptionDataTypeDdl: false,
    subscriptionDataTypeDml: false,
    subscriptionInstanceNetworkType: "string",
    subscriptionInstanceVpcId: "string",
    subscriptionInstanceVswitchId: "string",
    syncArchitecture: "string",
    synchronizationDirection: "string",
    tags: {
        string: "string",
    },
});
Copy
type: alicloud:dts:SubscriptionJob
properties:
    checkpoint: string
    computeUnit: 0
    databaseCount: 0
    dbList: string
    delayNotice: false
    delayPhone: string
    delayRuleTime: string
    destinationEndpointEngineName: string
    destinationRegion: string
    dtsInstanceId: string
    dtsJobName: string
    errorNotice: false
    errorPhone: string
    instanceClass: string
    paymentDuration: 0
    paymentDurationUnit: string
    paymentType: string
    reserve: string
    sourceEndpointDatabaseName: string
    sourceEndpointEngineName: string
    sourceEndpointInstanceId: string
    sourceEndpointInstanceType: string
    sourceEndpointIp: string
    sourceEndpointOracleSid: string
    sourceEndpointOwnerId: string
    sourceEndpointPassword: string
    sourceEndpointPort: string
    sourceEndpointRegion: string
    sourceEndpointRole: string
    sourceEndpointUserName: string
    status: string
    subscriptionDataTypeDdl: false
    subscriptionDataTypeDml: false
    subscriptionInstanceNetworkType: string
    subscriptionInstanceVpcId: string
    subscriptionInstanceVswitchId: string
    syncArchitecture: string
    synchronizationDirection: string
    tags:
        string: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SubscriptionJob resource accepts the following input properties:

PaymentType
This property is required.
Changes to this property will trigger replacement.
string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
SourceEndpointEngineName This property is required. string
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
SourceEndpointInstanceType This property is required. string
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
SourceEndpointRegion This property is required. string
The region of source database.
Checkpoint string
Subscription start time in Unix timestamp format.
ComputeUnit 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.
DatabaseCount 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 equals drds.
DbList string
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
DelayNotice bool
This parameter decides whether to monitor the delay status. Valid values: true, false.
DelayPhone 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.
DelayRuleTime string
When delay_notice is set to true, 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.
DestinationEndpointEngineName string
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.
DestinationRegion string
The destination region. List of supported regions.
DtsInstanceId Changes to this property will trigger replacement. string
The ID of subscription instance.
DtsJobName string
The name of subscription task.
ErrorNotice bool
This parameter decides whether to monitor abnormal status. Valid values: true, false.
ErrorPhone 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.
InstanceClass string
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
PaymentDuration int
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
PaymentDurationUnit string
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, 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.
SourceEndpointDatabaseName string
To subscribe to the name of the database.
SourceEndpointInstanceId string
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.
SourceEndpointIp string
The IP of source endpoint.
SourceEndpointOracleSid string
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.
SourceEndpointOwnerId string
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.
SourceEndpointPassword string
The password of source database instance account.
SourceEndpointPort string
The port of source database.
SourceEndpointRole string
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.
SourceEndpointUserName string
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
SubscriptionDataTypeDdl bool
Whether to subscribe the DDL type of data. Valid values: true, false.
SubscriptionDataTypeDml bool
Whether to subscribe the DML type of data. Valid values: true, false.
SubscriptionInstanceNetworkType Changes to this property will trigger replacement. string
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
SubscriptionInstanceVpcId string
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.
SubscriptionInstanceVswitchId string
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.
SyncArchitecture string
The sync architecture. Valid values: bidirectional, oneway.
SynchronizationDirection 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.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
PaymentType
This property is required.
Changes to this property will trigger replacement.
string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
SourceEndpointEngineName This property is required. string
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
SourceEndpointInstanceType This property is required. string
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
SourceEndpointRegion This property is required. string
The region of source database.
Checkpoint string
Subscription start time in Unix timestamp format.
ComputeUnit 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.
DatabaseCount 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 equals drds.
DbList string
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
DelayNotice bool
This parameter decides whether to monitor the delay status. Valid values: true, false.
DelayPhone 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.
DelayRuleTime string
When delay_notice is set to true, 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.
DestinationEndpointEngineName string
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.
DestinationRegion string
The destination region. List of supported regions.
DtsInstanceId Changes to this property will trigger replacement. string
The ID of subscription instance.
DtsJobName string
The name of subscription task.
ErrorNotice bool
This parameter decides whether to monitor abnormal status. Valid values: true, false.
ErrorPhone 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.
InstanceClass string
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
PaymentDuration int
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
PaymentDurationUnit string
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, 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.
SourceEndpointDatabaseName string
To subscribe to the name of the database.
SourceEndpointInstanceId string
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.
SourceEndpointIp string
The IP of source endpoint.
SourceEndpointOracleSid string
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.
SourceEndpointOwnerId string
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.
SourceEndpointPassword string
The password of source database instance account.
SourceEndpointPort string
The port of source database.
SourceEndpointRole string
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.
SourceEndpointUserName string
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
SubscriptionDataTypeDdl bool
Whether to subscribe the DDL type of data. Valid values: true, false.
SubscriptionDataTypeDml bool
Whether to subscribe the DML type of data. Valid values: true, false.
SubscriptionInstanceNetworkType Changes to this property will trigger replacement. string
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
SubscriptionInstanceVpcId string
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.
SubscriptionInstanceVswitchId string
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.
SyncArchitecture string
The sync architecture. Valid values: bidirectional, oneway.
SynchronizationDirection 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.
Tags map[string]string
A mapping of tags to assign to the resource.
paymentType
This property is required.
Changes to this property will trigger replacement.
String
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
sourceEndpointEngineName This property is required. String
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
sourceEndpointInstanceType This property is required. String
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
sourceEndpointRegion This property is required. String
The region of source database.
checkpoint String
Subscription start time in Unix timestamp format.
computeUnit 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.
databaseCount 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 equals drds.
dbList String
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
delayNotice Boolean
This parameter decides whether to monitor the delay status. Valid values: true, false.
delayPhone 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.
delayRuleTime String
When delay_notice is set to true, 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.
destinationEndpointEngineName String
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.
destinationRegion String
The destination region. List of supported regions.
dtsInstanceId Changes to this property will trigger replacement. String
The ID of subscription instance.
dtsJobName String
The name of subscription task.
errorNotice Boolean
This parameter decides whether to monitor abnormal status. Valid values: true, false.
errorPhone 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.
instanceClass String
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
paymentDuration Integer
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentDurationUnit String
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, 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.
sourceEndpointDatabaseName String
To subscribe to the name of the database.
sourceEndpointInstanceId String
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.
sourceEndpointIp String
The IP of source endpoint.
sourceEndpointOracleSid String
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.
sourceEndpointOwnerId String
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.
sourceEndpointPassword String
The password of source database instance account.
sourceEndpointPort String
The port of source database.
sourceEndpointRole String
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.
sourceEndpointUserName String
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscriptionDataTypeDdl Boolean
Whether to subscribe the DDL type of data. Valid values: true, false.
subscriptionDataTypeDml Boolean
Whether to subscribe the DML type of data. Valid values: true, false.
subscriptionInstanceNetworkType Changes to this property will trigger replacement. String
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscriptionInstanceVpcId String
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.
subscriptionInstanceVswitchId String
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.
syncArchitecture String
The sync architecture. Valid values: bidirectional, oneway.
synchronizationDirection 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.
tags Map<String,String>
A mapping of tags to assign to the resource.
paymentType
This property is required.
Changes to this property will trigger replacement.
string
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
sourceEndpointEngineName This property is required. string
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
sourceEndpointInstanceType This property is required. string
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
sourceEndpointRegion This property is required. string
The region of source database.
checkpoint string
Subscription start time in Unix timestamp format.
computeUnit 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.
databaseCount 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 equals drds.
dbList string
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
delayNotice boolean
This parameter decides whether to monitor the delay status. Valid values: true, false.
delayPhone 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.
delayRuleTime string
When delay_notice is set to true, 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.
destinationEndpointEngineName string
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.
destinationRegion string
The destination region. List of supported regions.
dtsInstanceId Changes to this property will trigger replacement. string
The ID of subscription instance.
dtsJobName string
The name of subscription task.
errorNotice boolean
This parameter decides whether to monitor abnormal status. Valid values: true, false.
errorPhone 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.
instanceClass string
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
paymentDuration number
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentDurationUnit string
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, 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.
sourceEndpointDatabaseName string
To subscribe to the name of the database.
sourceEndpointInstanceId string
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.
sourceEndpointIp string
The IP of source endpoint.
sourceEndpointOracleSid string
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.
sourceEndpointOwnerId string
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.
sourceEndpointPassword string
The password of source database instance account.
sourceEndpointPort string
The port of source database.
sourceEndpointRole string
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.
sourceEndpointUserName string
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscriptionDataTypeDdl boolean
Whether to subscribe the DDL type of data. Valid values: true, false.
subscriptionDataTypeDml boolean
Whether to subscribe the DML type of data. Valid values: true, false.
subscriptionInstanceNetworkType Changes to this property will trigger replacement. string
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscriptionInstanceVpcId string
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.
subscriptionInstanceVswitchId string
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.
syncArchitecture string
The sync architecture. Valid values: bidirectional, oneway.
synchronizationDirection 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.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
payment_type
This property is required.
Changes to this property will trigger replacement.
str
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
source_endpoint_engine_name This property is required. str
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
source_endpoint_instance_type This property is required. str
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
source_endpoint_region This property is required. str
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 equals drds.
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_time str
When delay_notice is set to true, 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_engine_name str
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_id Changes to this property will trigger replacement. str
The ID of subscription instance.
dts_job_name str
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 is Subscription, this parameter is valid and must be passed in.
payment_duration_unit str
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, 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_database_name str
To subscribe to the name of the database.
source_endpoint_instance_id str
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_ip str
The IP of source endpoint.
source_endpoint_oracle_sid str
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_owner_id str
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_password str
The password of source database instance account.
source_endpoint_port str
The port of source database.
source_endpoint_role str
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_user_name str
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscription_data_type_ddl bool
Whether to subscribe the DDL type of data. Valid values: true, false.
subscription_data_type_dml bool
Whether to subscribe the DML type of data. Valid values: true, false.
subscription_instance_network_type Changes to this property will trigger replacement. str
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscription_instance_vpc_id str
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_vswitch_id str
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.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
paymentType
This property is required.
Changes to this property will trigger replacement.
String
The payment type of the resource. Valid values: Subscription, PayAsYouGo.
sourceEndpointEngineName This property is required. String
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
sourceEndpointInstanceType This property is required. String
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
sourceEndpointRegion This property is required. String
The region of source database.
checkpoint String
Subscription start time in Unix timestamp format.
computeUnit 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.
databaseCount 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 equals drds.
dbList String
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
delayNotice Boolean
This parameter decides whether to monitor the delay status. Valid values: true, false.
delayPhone 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.
delayRuleTime String
When delay_notice is set to true, 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.
destinationEndpointEngineName String
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.
destinationRegion String
The destination region. List of supported regions.
dtsInstanceId Changes to this property will trigger replacement. String
The ID of subscription instance.
dtsJobName String
The name of subscription task.
errorNotice Boolean
This parameter decides whether to monitor abnormal status. Valid values: true, false.
errorPhone 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.
instanceClass String
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
paymentDuration Number
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentDurationUnit String
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, 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.
sourceEndpointDatabaseName String
To subscribe to the name of the database.
sourceEndpointInstanceId String
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.
sourceEndpointIp String
The IP of source endpoint.
sourceEndpointOracleSid String
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.
sourceEndpointOwnerId String
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.
sourceEndpointPassword String
The password of source database instance account.
sourceEndpointPort String
The port of source database.
sourceEndpointRole String
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.
sourceEndpointUserName String
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscriptionDataTypeDdl Boolean
Whether to subscribe the DDL type of data. Valid values: true, false.
subscriptionDataTypeDml Boolean
Whether to subscribe the DML type of data. Valid values: true, false.
subscriptionInstanceNetworkType Changes to this property will trigger replacement. String
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscriptionInstanceVpcId String
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.
subscriptionInstanceVswitchId String
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.
syncArchitecture String
The sync architecture. Valid values: bidirectional, oneway.
synchronizationDirection 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.
tags Map<String>
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, str]] = 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)
resources:  _:    type: alicloud:dts:SubscriptionJob    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Checkpoint string
Subscription start time in Unix timestamp format.
ComputeUnit 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.
DatabaseCount 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 equals drds.
DbList string
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
DelayNotice bool
This parameter decides whether to monitor the delay status. Valid values: true, false.
DelayPhone 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.
DelayRuleTime string
When delay_notice is set to true, 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.
DestinationEndpointEngineName string
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.
DestinationRegion string
The destination region. List of supported regions.
DtsInstanceId Changes to this property will trigger replacement. string
The ID of subscription instance.
DtsJobName string
The name of subscription task.
ErrorNotice bool
This parameter decides whether to monitor abnormal status. Valid values: true, false.
ErrorPhone 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.
InstanceClass string
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
PaymentDuration int
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
PaymentDurationUnit string
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
PaymentType Changes to this property will trigger replacement. 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.
SourceEndpointDatabaseName string
To subscribe to the name of the database.
SourceEndpointEngineName string
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
SourceEndpointInstanceId string
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.
SourceEndpointInstanceType string
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
SourceEndpointIp string
The IP of source endpoint.
SourceEndpointOracleSid string
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.
SourceEndpointOwnerId string
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.
SourceEndpointPassword string
The password of source database instance account.
SourceEndpointPort string
The port of source database.
SourceEndpointRegion string
The region of source database.
SourceEndpointRole string
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.
SourceEndpointUserName string
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
SubscriptionDataTypeDdl bool
Whether to subscribe the DDL type of data. Valid values: true, false.
SubscriptionDataTypeDml bool
Whether to subscribe the DML type of data. Valid values: true, false.
SubscriptionInstanceNetworkType Changes to this property will trigger replacement. string
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
SubscriptionInstanceVpcId string
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.
SubscriptionInstanceVswitchId string
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.
SyncArchitecture string
The sync architecture. Valid values: bidirectional, oneway.
SynchronizationDirection 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.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Checkpoint string
Subscription start time in Unix timestamp format.
ComputeUnit 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.
DatabaseCount 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 equals drds.
DbList string
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
DelayNotice bool
This parameter decides whether to monitor the delay status. Valid values: true, false.
DelayPhone 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.
DelayRuleTime string
When delay_notice is set to true, 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.
DestinationEndpointEngineName string
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.
DestinationRegion string
The destination region. List of supported regions.
DtsInstanceId Changes to this property will trigger replacement. string
The ID of subscription instance.
DtsJobName string
The name of subscription task.
ErrorNotice bool
This parameter decides whether to monitor abnormal status. Valid values: true, false.
ErrorPhone 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.
InstanceClass string
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
PaymentDuration int
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
PaymentDurationUnit string
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
PaymentType Changes to this property will trigger replacement. 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.
SourceEndpointDatabaseName string
To subscribe to the name of the database.
SourceEndpointEngineName string
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
SourceEndpointInstanceId string
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.
SourceEndpointInstanceType string
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
SourceEndpointIp string
The IP of source endpoint.
SourceEndpointOracleSid string
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.
SourceEndpointOwnerId string
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.
SourceEndpointPassword string
The password of source database instance account.
SourceEndpointPort string
The port of source database.
SourceEndpointRegion string
The region of source database.
SourceEndpointRole string
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.
SourceEndpointUserName string
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
SubscriptionDataTypeDdl bool
Whether to subscribe the DDL type of data. Valid values: true, false.
SubscriptionDataTypeDml bool
Whether to subscribe the DML type of data. Valid values: true, false.
SubscriptionInstanceNetworkType Changes to this property will trigger replacement. string
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
SubscriptionInstanceVpcId string
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.
SubscriptionInstanceVswitchId string
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.
SyncArchitecture string
The sync architecture. Valid values: bidirectional, oneway.
SynchronizationDirection 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.
Tags map[string]string
A mapping of tags to assign to the resource.
checkpoint String
Subscription start time in Unix timestamp format.
computeUnit 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.
databaseCount 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 equals drds.
dbList String
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
delayNotice Boolean
This parameter decides whether to monitor the delay status. Valid values: true, false.
delayPhone 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.
delayRuleTime String
When delay_notice is set to true, 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.
destinationEndpointEngineName String
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.
destinationRegion String
The destination region. List of supported regions.
dtsInstanceId Changes to this property will trigger replacement. String
The ID of subscription instance.
dtsJobName String
The name of subscription task.
errorNotice Boolean
This parameter decides whether to monitor abnormal status. Valid values: true, false.
errorPhone 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.
instanceClass String
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
paymentDuration Integer
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentDurationUnit String
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentType Changes to this property will trigger replacement. 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.
sourceEndpointDatabaseName String
To subscribe to the name of the database.
sourceEndpointEngineName String
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
sourceEndpointInstanceId String
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.
sourceEndpointInstanceType String
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
sourceEndpointIp String
The IP of source endpoint.
sourceEndpointOracleSid String
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.
sourceEndpointOwnerId String
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.
sourceEndpointPassword String
The password of source database instance account.
sourceEndpointPort String
The port of source database.
sourceEndpointRegion String
The region of source database.
sourceEndpointRole String
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.
sourceEndpointUserName String
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscriptionDataTypeDdl Boolean
Whether to subscribe the DDL type of data. Valid values: true, false.
subscriptionDataTypeDml Boolean
Whether to subscribe the DML type of data. Valid values: true, false.
subscriptionInstanceNetworkType Changes to this property will trigger replacement. String
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscriptionInstanceVpcId String
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.
subscriptionInstanceVswitchId String
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.
syncArchitecture String
The sync architecture. Valid values: bidirectional, oneway.
synchronizationDirection 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.
tags Map<String,String>
A mapping of tags to assign to the resource.
checkpoint string
Subscription start time in Unix timestamp format.
computeUnit 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.
databaseCount 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 equals drds.
dbList string
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
delayNotice boolean
This parameter decides whether to monitor the delay status. Valid values: true, false.
delayPhone 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.
delayRuleTime string
When delay_notice is set to true, 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.
destinationEndpointEngineName string
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.
destinationRegion string
The destination region. List of supported regions.
dtsInstanceId Changes to this property will trigger replacement. string
The ID of subscription instance.
dtsJobName string
The name of subscription task.
errorNotice boolean
This parameter decides whether to monitor abnormal status. Valid values: true, false.
errorPhone 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.
instanceClass string
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
paymentDuration number
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentDurationUnit string
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentType Changes to this property will trigger replacement. 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.
sourceEndpointDatabaseName string
To subscribe to the name of the database.
sourceEndpointEngineName string
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
sourceEndpointInstanceId string
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.
sourceEndpointInstanceType string
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
sourceEndpointIp string
The IP of source endpoint.
sourceEndpointOracleSid string
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.
sourceEndpointOwnerId string
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.
sourceEndpointPassword string
The password of source database instance account.
sourceEndpointPort string
The port of source database.
sourceEndpointRegion string
The region of source database.
sourceEndpointRole string
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.
sourceEndpointUserName string
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscriptionDataTypeDdl boolean
Whether to subscribe the DDL type of data. Valid values: true, false.
subscriptionDataTypeDml boolean
Whether to subscribe the DML type of data. Valid values: true, false.
subscriptionInstanceNetworkType Changes to this property will trigger replacement. string
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscriptionInstanceVpcId string
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.
subscriptionInstanceVswitchId string
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.
syncArchitecture string
The sync architecture. Valid values: bidirectional, oneway.
synchronizationDirection 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.
tags {[key: string]: string}
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 equals drds.
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_time str
When delay_notice is set to true, 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_engine_name str
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_id Changes to this property will trigger replacement. str
The ID of subscription instance.
dts_job_name str
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 is Subscription, this parameter is valid and must be passed in.
payment_duration_unit str
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
payment_type Changes to this property will trigger replacement. 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_database_name str
To subscribe to the name of the database.
source_endpoint_engine_name str
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
source_endpoint_instance_id str
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_instance_type str
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
source_endpoint_ip str
The IP of source endpoint.
source_endpoint_oracle_sid str
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_owner_id str
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_password str
The password of source database instance account.
source_endpoint_port str
The port of source database.
source_endpoint_region str
The region of source database.
source_endpoint_role str
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_user_name str
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscription_data_type_ddl bool
Whether to subscribe the DDL type of data. Valid values: true, false.
subscription_data_type_dml bool
Whether to subscribe the DML type of data. Valid values: true, false.
subscription_instance_network_type Changes to this property will trigger replacement. str
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscription_instance_vpc_id str
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_vswitch_id str
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.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
checkpoint String
Subscription start time in Unix timestamp format.
computeUnit 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.
databaseCount 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 equals drds.
dbList String
Subscription object, in the format of JSON strings. For detailed definitions, please refer to the description of migration, synchronization or subscription objects document.
delayNotice Boolean
This parameter decides whether to monitor the delay status. Valid values: true, false.
delayPhone 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.
delayRuleTime String
When delay_notice is set to true, 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.
destinationEndpointEngineName String
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.
destinationRegion String
The destination region. List of supported regions.
dtsInstanceId Changes to this property will trigger replacement. String
The ID of subscription instance.
dtsJobName String
The name of subscription task.
errorNotice Boolean
This parameter decides whether to monitor abnormal status. Valid values: true, false.
errorPhone 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.
instanceClass String
The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge.
paymentDuration Number
The duration of prepaid instance purchase. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentDurationUnit String
The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
paymentType Changes to this property will trigger replacement. 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.
sourceEndpointDatabaseName String
To subscribe to the name of the database.
sourceEndpointEngineName String
The source database type value is MySQL or Oracle. Valid values: MySQL, Oracle.
sourceEndpointInstanceId String
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.
sourceEndpointInstanceType String
The type of source instance. Valid values: RDS, PolarDB, DRDS, LocalInstance, ECS, Express, CEN, dg.
sourceEndpointIp String
The IP of source endpoint.
sourceEndpointOracleSid String
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.
sourceEndpointOwnerId String
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.
sourceEndpointPassword String
The password of source database instance account.
sourceEndpointPort String
The port of source database.
sourceEndpointRegion String
The region of source database.
sourceEndpointRole String
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.
sourceEndpointUserName String
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 of NotStarted. You can specify this state to Normal to start the job, and specify this state of Abnormal to stop the job. Note: We treat the state Starting as the state of Normal, and consider the two states to be consistent on the user side.
subscriptionDataTypeDdl Boolean
Whether to subscribe the DDL type of data. Valid values: true, false.
subscriptionDataTypeDml Boolean
Whether to subscribe the DML type of data. Valid values: true, false.
subscriptionInstanceNetworkType Changes to this property will trigger replacement. String
Subscription task type of network value: classic: classic Network. Virtual Private Cloud (vpc): a vpc. Valid values: classic, vpc.
subscriptionInstanceVpcId String
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.
subscriptionInstanceVswitchId String
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.
syncArchitecture String
The sync architecture. Valid values: bidirectional, oneway.
synchronizationDirection 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.
tags Map<String>
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>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud