InstanceProps

Properties for defining a Instance.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Dts;
new InstanceProps {
    object InstanceClass,
    object PayType,
    object Type,
    object AutoPay = null,
    object AutoStart = null,
    object ComputeUnit = null,
    object DatabaseCount = null,
    object DestinationEndpointEngineName = null,
    object DestinationRegion = null,
    object Du = null,
    object FeeType = null,
    object InsightModule = null,
    object JobId = null,
    object MaxDu = null,
    object MinDu = null,
    object Period = null,
    object ResourceGroupId = null,
    object SourceEndpointEngineName = null,
    object SourceRegion = null,
    object SyncArchitecture = null,
    object UsedTime = null
};

Properties

InstanceClass^Required

public object InstanceClass { get; set; }

• Type: object

Property instanceClass: The instance class.

• DTS supports the following instance classes for a data migration instance: xxlarge, xlarge, large, medium, and small.
• DTS supports the following instance classes for a data synchronization instance: large, medium, small, and micro. Note: Although the instance specification supports modification after creation, the downgrade instance feature is currently in canary release and available only for specific users.

PayType^Required

public object PayType { get; set; }

• Type: object

Property payType: The billing method.

Valid values:

• PrePaid: subscription
• PostPaid: pay-as-you-go

This parameter must be specified.

Type^Required

public object Type { get; set; }

• Type: object

Property type: The type of the DTS instance.

Valid values:

• MIGRATION: data migration instance
• SYNC: data synchronization instance
• SUBSCRIBE: change tracking instance

You must specify one of this parameter and the JobId parameter.

AutoPay^Optional

public object AutoPay { get; set; }

• Type: object

Property autoPay: Specifies whether to automatically renew the DTS instance when it expires.

Valid values:

• false: does not automatically renew the DTS instance when it expires. This is the default value.
• true: automatically renews the DTS instance when it expires.

AutoStart^Optional

public object AutoStart { get; set; }

• Type: object

Property autoStart: Specifies whether to automatically start the task after the DTS instance is purchased.

Valid values:

• false (default)
• true

This parameter can be set to true and take effect only if you specify a valid value for JobId.

ComputeUnit^Optional

public object ComputeUnit { get; set; }

• Type: object

Property computeUnit: The specification of the extract, transform, and load (ETL) instance.

The unit is compute unit (CU). One CU is equal to 1 vCPU and 4 GB of memory. The value of this parameter must be an integer greater than or equal to 2.

DatabaseCount^Optional

public object DatabaseCount { get; set; }

• Type: object

Property databaseCount: The number of private custom ApsaraDB RDS instances in a PolarDB-X instance.

Default value: 1. Note: You must specify this parameter only if the SourceEndpointEngineName parameter is set to drds.

DestinationEndpointEngineName^Optional

public object DestinationEndpointEngineName { get; set; }

• Type: object

Property destinationEndpointEngineName: The database engine of the destination instance.

Valid values:

• MySQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database
• PolarDB: PolarDB for MySQL cluster
• polardb_o: PolarDB for Oracle cluster
• polardb_pg: PolarDB for PostgreSQL cluster
• Redis: ApsaraDB for Redis instance or self-managed Redis database
• DRDS: PolarDB-X 1.0 or PolarDB-X 2.0 instance
• PostgreSQL: self-managed PostgreSQL database
• odps: MaxCompute project
• oracle: self-managed Oracle database
• mongodb: ApsaraDB for MongoDB instance or self-managed MongoDB database
• tidb: TiDB database
• ADS: AnalyticDB for MySQL V2.0 cluster
• ADB30: AnalyticDB for MySQL V3.0 cluster
• Greenplum: AnalyticDB for PostgreSQL instance
• MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database
• kafka: Message Queue for Apache Kafka instance or self-managed Kafka cluster
• DataHub: DataHub project
• DB2: self-managed Db2 for LUW database
• as400: AS/400
• Tablestore: Tablestore instance Note: The default value is MySQL. You must specify one of this parameter and the JobId parameter.

DestinationRegion^Optional

public object DestinationRegion { get; set; }

• Type: object

Property destinationRegion: The ID of the region in which the destination instance resides.

Note: You must specify one of this parameter and the JobId parameter.

Du^Optional

public object Du { get; set; }

• Type: object

Property du: The number of DTS units (DUs) that are assigned to a DTS task that is run on a DTS dedicated cluster.

Valid values: 1 to 100. Note: The value of this parameter must be within the range of the number of DUs available for the DTS dedicated cluster.

FeeType^Optional

public object FeeType { get; set; }

• Type: object

Property feeType: The billing type for a change tracking instance.

Valid values: ONLY_CONFIGURATION_FEE and CONFIGURATION_FEE_AND_DATA_FEE.

• ONLY_CONFIGURATION_FEE: charges only configuration fees.
• CONFIGURATION_FEE_AND_DATA_FEE: charges configuration fees and data traffic fees.

InsightModule^Optional

public object InsightModule { get; set; }

• Type: object

Property insightModule: Whether to enable the insight module.

JobId^Optional

public object JobId { get; set; }

• Type: object

Property jobId: The ID of the task.

Note: If this parameter is specified, you do not need to specify the SourceRegion, DestinationRegion, SourceEndpointEngineName, or DestinationEndpointEngineName parameter. Even if these parameters are specified, the value of the JobId parameter takes precedence.

MaxDu^Optional

public object MaxDu { get; set; }

• Type: object

Property maxDu: Upper limit of DU.

Only supported by Serverless instances.

MinDu^Optional

public object MinDu { get; set; }

• Type: object

Property minDu: Lower limit of DU.

Only supported by Serverless instances.

Period^Optional

public object Period { get; set; }

• Type: object

Property period: The unit of the subscription duration.

Valid values: Year and Month. Note: You must specify this parameter only if the PayType parameter is set to PrePaid.

ResourceGroupId^Optional

public object ResourceGroupId { get; set; }

• Type: object

Property resourceGroupId: The ID of the resource group.

SourceEndpointEngineName^Optional

public object SourceEndpointEngineName { get; set; }

• Type: object

Property sourceEndpointEngineName: The database engine of the source instance.

Valid values:

• MySQL: ApsaraDB RDS for MySQL instance or self-managed MySQL database
• PolarDB: PolarDB for MySQL cluster
• polardb_o: PolarDB for Oracle cluster
• polardb_pg: PolarDB for PostgreSQL cluster
• Redis: ApsaraDB for Redis instance or self-managed Redis database
• DRDS: PolarDB-X 1.0 or PolarDB-X 2.0 instance
• PostgreSQL: self-managed PostgreSQL database
• odps: MaxCompute project
• oracle: self-managed Oracle database
• mongodb: ApsaraDB for MongoDB instance or self-managed MongoDB database
• tidb: TiDB database
• ADS: AnalyticDB for MySQL V2.0 cluster
• ADB30: AnalyticDB for MySQL V3.0 cluster
• Greenplum: AnalyticDB for PostgreSQL instance
• MSSQL: ApsaraDB RDS for SQL Server instance or self-managed SQL Server database
• kafka: Message Queue for Apache Kafka instance or self-managed Kafka cluster
• DataHub: DataHub project
• DB2: self-managed Db2 for LUW database
• as400: AS/400
• Tablestore: Tablestore instance Note: The default value is MySQL. You must specify one of this parameter and the JobId parameter.

SourceRegion^Optional

public object SourceRegion { get; set; }

• Type: object

Property sourceRegion: The ID of the region in which the source instance resides.

Note: You must specify one of this parameter and the JobId parameter.

SyncArchitecture^Optional

public object SyncArchitecture { get; set; }

• Type: object

Property syncArchitecture: The synchronization topology.

Valid values:

• oneway: one-way synchronization. This is the default value.
• bidirectional: two-way synchronization.

UsedTime^Optional

public object UsedTime { get; set; }

• Type: object

Property usedTime: The subscription duration.

• Valid values if Period is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.
• Valid values if Period is set to Year: 1, 2, 3, and 5.

• This parameter is valid and required only if PayType is set to PrePaid.
• You can configure Period to specify the unit of the subscription duration.