1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. dts
  5. SynchronizationInstance
Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi

alicloud.dts.SynchronizationInstance

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi

    Provides a DTS Synchronization Instance resource.

    For information about DTS Synchronization Instance and how to use it, see What is Synchronization Instance.

    NOTE: Available since v1.138.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const defaultRegions = alicloud.getRegions({
        current: true,
    });
    const defaultSynchronizationInstance = new alicloud.dts.SynchronizationInstance("defaultSynchronizationInstance", {
        paymentType: "PayAsYouGo",
        sourceEndpointEngineName: "MySQL",
        sourceEndpointRegion: defaultRegions.then(defaultRegions => defaultRegions.regions?.[0]?.id),
        destinationEndpointEngineName: "MySQL",
        destinationEndpointRegion: defaultRegions.then(defaultRegions => defaultRegions.regions?.[0]?.id),
        instanceClass: "small",
        syncArchitecture: "oneway",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default_regions = alicloud.get_regions(current=True)
    default_synchronization_instance = alicloud.dts.SynchronizationInstance("defaultSynchronizationInstance",
        payment_type="PayAsYouGo",
        source_endpoint_engine_name="MySQL",
        source_endpoint_region=default_regions.regions[0].id,
        destination_endpoint_engine_name="MySQL",
        destination_endpoint_region=default_regions.regions[0].id,
        instance_class="small",
        sync_architecture="oneway")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dts"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		defaultRegions, err := alicloud.GetRegions(ctx, &alicloud.GetRegionsArgs{
    			Current: pulumi.BoolRef(true),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = dts.NewSynchronizationInstance(ctx, "defaultSynchronizationInstance", &dts.SynchronizationInstanceArgs{
    			PaymentType:                   pulumi.String("PayAsYouGo"),
    			SourceEndpointEngineName:      pulumi.String("MySQL"),
    			SourceEndpointRegion:          pulumi.String(defaultRegions.Regions[0].Id),
    			DestinationEndpointEngineName: pulumi.String("MySQL"),
    			DestinationEndpointRegion:     pulumi.String(defaultRegions.Regions[0].Id),
    			InstanceClass:                 pulumi.String("small"),
    			SyncArchitecture:              pulumi.String("oneway"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var defaultRegions = AliCloud.GetRegions.Invoke(new()
        {
            Current = true,
        });
    
        var defaultSynchronizationInstance = new AliCloud.Dts.SynchronizationInstance("defaultSynchronizationInstance", new()
        {
            PaymentType = "PayAsYouGo",
            SourceEndpointEngineName = "MySQL",
            SourceEndpointRegion = defaultRegions.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id),
            DestinationEndpointEngineName = "MySQL",
            DestinationEndpointRegion = defaultRegions.Apply(getRegionsResult => getRegionsResult.Regions[0]?.Id),
            InstanceClass = "small",
            SyncArchitecture = "oneway",
        });
    
    });
    
    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.dts.SynchronizationInstance;
    import com.pulumi.alicloud.dts.SynchronizationInstanceArgs;
    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 defaultRegions = AlicloudFunctions.getRegions(GetRegionsArgs.builder()
                .current(true)
                .build());
    
            var defaultSynchronizationInstance = new SynchronizationInstance("defaultSynchronizationInstance", SynchronizationInstanceArgs.builder()        
                .paymentType("PayAsYouGo")
                .sourceEndpointEngineName("MySQL")
                .sourceEndpointRegion(defaultRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].id()))
                .destinationEndpointEngineName("MySQL")
                .destinationEndpointRegion(defaultRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].id()))
                .instanceClass("small")
                .syncArchitecture("oneway")
                .build());
    
        }
    }
    
    resources:
      defaultSynchronizationInstance:
        type: alicloud:dts:SynchronizationInstance
        properties:
          paymentType: PayAsYouGo
          sourceEndpointEngineName: MySQL
          sourceEndpointRegion: ${defaultRegions.regions[0].id}
          destinationEndpointEngineName: MySQL
          destinationEndpointRegion: ${defaultRegions.regions[0].id}
          instanceClass: small
          syncArchitecture: oneway
    variables:
      defaultRegions:
        fn::invoke:
          Function: alicloud:getRegions
          Arguments:
            current: true
    

    Create SynchronizationInstance Resource

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

    Constructor syntax

    new SynchronizationInstance(name: string, args: SynchronizationInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def SynchronizationInstance(resource_name: str,
                                args: SynchronizationInstanceArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def SynchronizationInstance(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                destination_endpoint_region: Optional[str] = None,
                                source_endpoint_region: Optional[str] = None,
                                source_endpoint_engine_name: Optional[str] = None,
                                payment_type: Optional[str] = None,
                                destination_endpoint_engine_name: Optional[str] = None,
                                database_count: Optional[int] = None,
                                instance_class: Optional[str] = None,
                                payment_duration: Optional[int] = None,
                                payment_duration_unit: Optional[str] = None,
                                auto_pay: Optional[str] = None,
                                quantity: Optional[int] = None,
                                compute_unit: Optional[int] = None,
                                auto_start: Optional[str] = None,
                                sync_architecture: Optional[str] = None)
    func NewSynchronizationInstance(ctx *Context, name string, args SynchronizationInstanceArgs, opts ...ResourceOption) (*SynchronizationInstance, error)
    public SynchronizationInstance(string name, SynchronizationInstanceArgs args, CustomResourceOptions? opts = null)
    public SynchronizationInstance(String name, SynchronizationInstanceArgs args)
    public SynchronizationInstance(String name, SynchronizationInstanceArgs args, CustomResourceOptions options)
    
    type: alicloud:dts:SynchronizationInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SynchronizationInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SynchronizationInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SynchronizationInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SynchronizationInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SynchronizationInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var synchronizationInstanceResource = new AliCloud.Dts.SynchronizationInstance("synchronizationInstanceResource", new()
    {
        DestinationEndpointRegion = "string",
        SourceEndpointRegion = "string",
        SourceEndpointEngineName = "string",
        PaymentType = "string",
        DestinationEndpointEngineName = "string",
        DatabaseCount = 0,
        InstanceClass = "string",
        PaymentDuration = 0,
        PaymentDurationUnit = "string",
        AutoPay = "string",
        Quantity = 0,
        ComputeUnit = 0,
        AutoStart = "string",
        SyncArchitecture = "string",
    });
    
    example, err := dts.NewSynchronizationInstance(ctx, "synchronizationInstanceResource", &dts.SynchronizationInstanceArgs{
    	DestinationEndpointRegion:     pulumi.String("string"),
    	SourceEndpointRegion:          pulumi.String("string"),
    	SourceEndpointEngineName:      pulumi.String("string"),
    	PaymentType:                   pulumi.String("string"),
    	DestinationEndpointEngineName: pulumi.String("string"),
    	DatabaseCount:                 pulumi.Int(0),
    	InstanceClass:                 pulumi.String("string"),
    	PaymentDuration:               pulumi.Int(0),
    	PaymentDurationUnit:           pulumi.String("string"),
    	AutoPay:                       pulumi.String("string"),
    	Quantity:                      pulumi.Int(0),
    	ComputeUnit:                   pulumi.Int(0),
    	AutoStart:                     pulumi.String("string"),
    	SyncArchitecture:              pulumi.String("string"),
    })
    
    var synchronizationInstanceResource = new SynchronizationInstance("synchronizationInstanceResource", SynchronizationInstanceArgs.builder()        
        .destinationEndpointRegion("string")
        .sourceEndpointRegion("string")
        .sourceEndpointEngineName("string")
        .paymentType("string")
        .destinationEndpointEngineName("string")
        .databaseCount(0)
        .instanceClass("string")
        .paymentDuration(0)
        .paymentDurationUnit("string")
        .autoPay("string")
        .quantity(0)
        .computeUnit(0)
        .autoStart("string")
        .syncArchitecture("string")
        .build());
    
    synchronization_instance_resource = alicloud.dts.SynchronizationInstance("synchronizationInstanceResource",
        destination_endpoint_region="string",
        source_endpoint_region="string",
        source_endpoint_engine_name="string",
        payment_type="string",
        destination_endpoint_engine_name="string",
        database_count=0,
        instance_class="string",
        payment_duration=0,
        payment_duration_unit="string",
        auto_pay="string",
        quantity=0,
        compute_unit=0,
        auto_start="string",
        sync_architecture="string")
    
    const synchronizationInstanceResource = new alicloud.dts.SynchronizationInstance("synchronizationInstanceResource", {
        destinationEndpointRegion: "string",
        sourceEndpointRegion: "string",
        sourceEndpointEngineName: "string",
        paymentType: "string",
        destinationEndpointEngineName: "string",
        databaseCount: 0,
        instanceClass: "string",
        paymentDuration: 0,
        paymentDurationUnit: "string",
        autoPay: "string",
        quantity: 0,
        computeUnit: 0,
        autoStart: "string",
        syncArchitecture: "string",
    });
    
    type: alicloud:dts:SynchronizationInstance
    properties:
        autoPay: string
        autoStart: string
        computeUnit: 0
        databaseCount: 0
        destinationEndpointEngineName: string
        destinationEndpointRegion: string
        instanceClass: string
        paymentDuration: 0
        paymentDurationUnit: string
        paymentType: string
        quantity: 0
        sourceEndpointEngineName: string
        sourceEndpointRegion: string
        syncArchitecture: string
    

    SynchronizationInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SynchronizationInstance resource accepts the following input properties:

    DestinationEndpointEngineName string
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    DestinationEndpointRegion string
    The region of destination instance. List of supported regions.
    PaymentType string
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    SourceEndpointEngineName string
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    SourceEndpointRegion string
    The region of source instance.
    AutoPay string
    Whether to automatically renew when it expires. Valid values: true, false.
    AutoStart string
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    InstanceClass string
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    PaymentDuration int
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    PaymentDurationUnit string
    The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
    Quantity int
    The number of instances purchased.
    SyncArchitecture string
    The sync architecture. Valid values: oneway, bidirectional.
    DestinationEndpointEngineName string
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    DestinationEndpointRegion string
    The region of destination instance. List of supported regions.
    PaymentType string
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    SourceEndpointEngineName string
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    SourceEndpointRegion string
    The region of source instance.
    AutoPay string
    Whether to automatically renew when it expires. Valid values: true, false.
    AutoStart string
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    InstanceClass string
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    PaymentDuration int
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    PaymentDurationUnit string
    The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
    Quantity int
    The number of instances purchased.
    SyncArchitecture string
    The sync architecture. Valid values: oneway, bidirectional.
    destinationEndpointEngineName String
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destinationEndpointRegion String
    The region of destination instance. List of supported regions.
    paymentType String
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    sourceEndpointEngineName String
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    sourceEndpointRegion String
    The region of source instance.
    autoPay String
    Whether to automatically renew when it expires. Valid values: true, false.
    autoStart String
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    instanceClass String
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    paymentDuration Integer
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    paymentDurationUnit String
    The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
    quantity Integer
    The number of instances purchased.
    syncArchitecture String
    The sync architecture. Valid values: oneway, bidirectional.
    destinationEndpointEngineName string
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destinationEndpointRegion string
    The region of destination instance. List of supported regions.
    paymentType string
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    sourceEndpointEngineName string
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    sourceEndpointRegion string
    The region of source instance.
    autoPay string
    Whether to automatically renew when it expires. Valid values: true, false.
    autoStart string
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    instanceClass string
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    paymentDuration number
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    paymentDurationUnit string
    The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
    quantity number
    The number of instances purchased.
    syncArchitecture string
    The sync architecture. Valid values: oneway, bidirectional.
    destination_endpoint_engine_name str
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destination_endpoint_region str
    The region of destination instance. List of supported regions.
    payment_type str
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    source_endpoint_engine_name str
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    source_endpoint_region str
    The region of source instance.
    auto_pay str
    Whether to automatically renew when it expires. Valid values: true, false.
    auto_start str
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    instance_class str
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    payment_duration int
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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.
    quantity int
    The number of instances purchased.
    sync_architecture str
    The sync architecture. Valid values: oneway, bidirectional.
    destinationEndpointEngineName String
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destinationEndpointRegion String
    The region of destination instance. List of supported regions.
    paymentType String
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    sourceEndpointEngineName String
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    sourceEndpointRegion String
    The region of source instance.
    autoPay String
    Whether to automatically renew when it expires. Valid values: true, false.
    autoStart String
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    instanceClass String
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    paymentDuration Number
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    paymentDurationUnit String
    The payment duration unit. Valid values: Month, Year. When payment_type is Subscription, this parameter is valid and must be passed in.
    quantity Number
    The number of instances purchased.
    syncArchitecture String
    The sync architecture. Valid values: oneway, bidirectional.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SynchronizationInstance resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status.

    Look up Existing SynchronizationInstance Resource

    Get an existing SynchronizationInstance 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?: SynchronizationInstanceState, opts?: CustomResourceOptions): SynchronizationInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_pay: Optional[str] = None,
            auto_start: Optional[str] = None,
            compute_unit: Optional[int] = None,
            database_count: Optional[int] = None,
            destination_endpoint_engine_name: Optional[str] = None,
            destination_endpoint_region: Optional[str] = None,
            instance_class: Optional[str] = None,
            payment_duration: Optional[int] = None,
            payment_duration_unit: Optional[str] = None,
            payment_type: Optional[str] = None,
            quantity: Optional[int] = None,
            source_endpoint_engine_name: Optional[str] = None,
            source_endpoint_region: Optional[str] = None,
            status: Optional[str] = None,
            sync_architecture: Optional[str] = None) -> SynchronizationInstance
    func GetSynchronizationInstance(ctx *Context, name string, id IDInput, state *SynchronizationInstanceState, opts ...ResourceOption) (*SynchronizationInstance, error)
    public static SynchronizationInstance Get(string name, Input<string> id, SynchronizationInstanceState? state, CustomResourceOptions? opts = null)
    public static SynchronizationInstance get(String name, Output<String> id, SynchronizationInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoPay string
    Whether to automatically renew when it expires. Valid values: true, false.
    AutoStart string
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    DestinationEndpointEngineName string
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    DestinationEndpointRegion string
    The region of destination instance. List of supported regions.
    InstanceClass string
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    PaymentDuration int
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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 string
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    Quantity int
    The number of instances purchased.
    SourceEndpointEngineName string
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    SourceEndpointRegion string
    The region of source instance.
    Status string
    The status.
    SyncArchitecture string
    The sync architecture. Valid values: oneway, bidirectional.
    AutoPay string
    Whether to automatically renew when it expires. Valid values: true, false.
    AutoStart string
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    DestinationEndpointEngineName string
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    DestinationEndpointRegion string
    The region of destination instance. List of supported regions.
    InstanceClass string
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    PaymentDuration int
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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 string
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    Quantity int
    The number of instances purchased.
    SourceEndpointEngineName string
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    SourceEndpointRegion string
    The region of source instance.
    Status string
    The status.
    SyncArchitecture string
    The sync architecture. Valid values: oneway, bidirectional.
    autoPay String
    Whether to automatically renew when it expires. Valid values: true, false.
    autoStart String
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    destinationEndpointEngineName String
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destinationEndpointRegion String
    The region of destination instance. List of supported regions.
    instanceClass String
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    paymentDuration Integer
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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 String
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    quantity Integer
    The number of instances purchased.
    sourceEndpointEngineName String
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    sourceEndpointRegion String
    The region of source instance.
    status String
    The status.
    syncArchitecture String
    The sync architecture. Valid values: oneway, bidirectional.
    autoPay string
    Whether to automatically renew when it expires. Valid values: true, false.
    autoStart string
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    destinationEndpointEngineName string
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destinationEndpointRegion string
    The region of destination instance. List of supported regions.
    instanceClass string
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    paymentDuration number
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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 string
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    quantity number
    The number of instances purchased.
    sourceEndpointEngineName string
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    sourceEndpointRegion string
    The region of source instance.
    status string
    The status.
    syncArchitecture string
    The sync architecture. Valid values: oneway, bidirectional.
    auto_pay str
    Whether to automatically renew when it expires. Valid values: true, false.
    auto_start str
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    destination_endpoint_engine_name str
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destination_endpoint_region str
    The region of destination instance. List of supported regions.
    instance_class str
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    payment_duration int
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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 str
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    quantity int
    The number of instances purchased.
    source_endpoint_engine_name str
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    source_endpoint_region str
    The region of source instance.
    status str
    The status.
    sync_architecture str
    The sync architecture. Valid values: oneway, bidirectional.
    autoPay String
    Whether to automatically renew when it expires. Valid values: true, false.
    autoStart String
    Whether to automatically start the task after the purchase completed. Valid values: true, false.
    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.
    destinationEndpointEngineName String
    The type of destination engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    destinationEndpointRegion String
    The region of destination instance. List of supported regions.
    instanceClass String
    The instance class. Valid values: large, medium, micro, small, xlarge, xxlarge. You can only upgrade the configuration, not downgrade the configuration. If you downgrade the instance, you need to submit a ticket.
    paymentDuration Number
    The duration of prepaid instance purchase. this parameter is required When payment_type equals Subscription.
    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 String
    The payment type of the resource. Valid values: Subscription, PayAsYouGo.
    quantity Number
    The number of instances purchased.
    sourceEndpointEngineName String
    The type of source endpoint engine. Valid values: ADS, DB2, DRDS, DataHub, Greenplum, MSSQL, MySQL, PolarDB, PostgreSQL, Redis, Tablestore, as400, clickhouse, kafka, mongodb, odps, oracle, polardb_o, polardb_pg, tidb. For the correspondence between the supported source and target libraries, see Supported Databases, Synchronization Initialization Types and Synchronization Topologies, Supported Databases and Migration Types.
    sourceEndpointRegion String
    The region of source instance.
    status String
    The status.
    syncArchitecture String
    The sync architecture. Valid values: oneway, bidirectional.

    Import

    DTS Synchronization Instance can be imported using the id, e.g.

    $ pulumi import alicloud:dts/synchronizationInstance:SynchronizationInstance example <id>
    

    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.
    alicloud logo
    Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi