Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

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

Properties

Name Type Description
instanceClass string | @alicloud/ros-cdk-core.IResolvable Property instanceClass: The instance class.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The billing method.
type string | @alicloud/ros-cdk-core.IResolvable Property type: The type of the DTS instance.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Specifies whether to automatically renew the DTS instance when it expires.
autoStart boolean | @alicloud/ros-cdk-core.IResolvable Property autoStart: Specifies whether to automatically start the task after the DTS instance is purchased.
computeUnit number | @alicloud/ros-cdk-core.IResolvable Property computeUnit: The specifications of the extract, transform, and load (ETL) instance.
databaseCount number | @alicloud/ros-cdk-core.IResolvable Property databaseCount: The number of private custom ApsaraDB RDS instances in a PolarDB-X instance.
destinationEndpointEngineName string | @alicloud/ros-cdk-core.IResolvable Property destinationEndpointEngineName: The database engine of the destination instance.
destinationRegion string | @alicloud/ros-cdk-core.IResolvable Property destinationRegion: The ID of the region in which the destination instance resides.
du number | @alicloud/ros-cdk-core.IResolvable Property du: The number of DTS units (DUs) that are assigned to a DTS task that is run on a DTS dedicated cluster.
feeType string | @alicloud/ros-cdk-core.IResolvable Property feeType: The billing type for a change tracking instance.
jobId string | @alicloud/ros-cdk-core.IResolvable Property jobId: The ID of the task.
period string | @alicloud/ros-cdk-core.IResolvable Property period: The unit of the subscription duration.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
sourceEndpointEngineName string | @alicloud/ros-cdk-core.IResolvable Property sourceEndpointEngineName: The database engine of the source instance.
sourceRegion string | @alicloud/ros-cdk-core.IResolvable Property sourceRegion: The ID of the region in which the source instance resides.
syncArchitecture string | @alicloud/ros-cdk-core.IResolvable Property syncArchitecture: The synchronization topology.
usedTime number | @alicloud/ros-cdk-core.IResolvable Property usedTime: The subscription duration.

instanceClassRequired 

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

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.

payTypeRequired 

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

Property payType: The billing method.

Valid values: - PrePaid: subscription - PostPaid: pay-as-you-go

typeRequired 

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

Property type: The type of the DTS instance.

Valid values: - MIGRATION*: data migration instance - SYNC: data synchronization instance - SUBSCRIBE**: change tracking instance

autoPayOptional 

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

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.

autoStartOptional 

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

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

Valid values: - false: does not automatically start the task after the DTS instance is purchased. This is the default value. - true: automatically starts the task after the DTS instance is purchased.

computeUnitOptional 

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

Property computeUnit: The specifications 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.

databaseCountOptional 

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

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.

destinationEndpointEngineNameOptional 

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

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.

destinationRegionOptional 

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

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.

duOptional 

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

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.

feeTypeOptional 

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

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.

jobIdOptional 

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

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.

periodOptional 

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

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.

resourceGroupIdOptional 

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

Property resourceGroupId: The ID of the resource group.

sourceEndpointEngineNameOptional 

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

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.

sourceRegionOptional 

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

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.

syncArchitectureOptional 

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

Property syncArchitecture: The synchronization topology.

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

usedTimeOptional 

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

Property usedTime: The subscription duration.

Valid values if the Period parameter is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9. - Valid values if the Period parameter is set to Year: 1, 2, 3, and 5. Note: You must specify this parameter only if the PayType parameter is set to PrePaid. You can set the Period parameter to specify the unit of the subscription duration.