InstanceProps
Properties for defining a Instance.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dts-instance
Initializer
import com.aliyun.ros.cdk.dts.InstanceProps;
InstanceProps.builder()
.instanceClass(java.lang.String)
.instanceClass(IResolvable)
.payType(java.lang.String)
.payType(IResolvable)
.type(java.lang.String)
.type(IResolvable)
// .autoPay(java.lang.Boolean)
// .autoPay(IResolvable)
// .autoStart(java.lang.Boolean)
// .autoStart(IResolvable)
// .computeUnit(java.lang.Number)
// .computeUnit(IResolvable)
// .databaseCount(java.lang.Number)
// .databaseCount(IResolvable)
// .destinationEndpointEngineName(java.lang.String)
// .destinationEndpointEngineName(IResolvable)
// .destinationRegion(java.lang.String)
// .destinationRegion(IResolvable)
// .du(java.lang.Number)
// .du(IResolvable)
// .feeType(java.lang.String)
// .feeType(IResolvable)
// .jobId(java.lang.String)
// .jobId(IResolvable)
// .period(java.lang.String)
// .period(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .sourceEndpointEngineName(java.lang.String)
// .sourceEndpointEngineName(IResolvable)
// .sourceRegion(java.lang.String)
// .sourceRegion(IResolvable)
// .syncArchitecture(java.lang.String)
// .syncArchitecture(IResolvable)
// .usedTime(java.lang.Number)
// .usedTime(IResolvable)
.build();
Properties
| Name | Type | Description |
|---|---|---|
instanceClass |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property instanceClass: The instance class. |
payType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property payType: The billing method. |
type |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property type: The type of the DTS instance. |
autoPay |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property autoPay: Specifies whether to automatically renew the DTS instance when it expires. |
autoStart |
java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable |
Property autoStart: Specifies whether to automatically start the task after the DTS instance is purchased. |
computeUnit |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property computeUnit: The specifications of the extract, transform, and load (ETL) instance. |
databaseCount |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property databaseCount: The number of private custom ApsaraDB RDS instances in a PolarDB-X instance. |
destinationEndpointEngineName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property destinationEndpointEngineName: The database engine of the destination instance. |
destinationRegion |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property destinationRegion: The ID of the region in which the destination instance resides. |
du |
java.lang.Number OR com.aliyun.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 |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property feeType: The billing type for a change tracking instance. |
jobId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property jobId: The ID of the task. |
period |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property period: The unit of the subscription duration. |
resourceGroupId |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property resourceGroupId: The ID of the resource group. |
sourceEndpointEngineName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property sourceEndpointEngineName: The database engine of the source instance. |
sourceRegion |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property sourceRegion: The ID of the region in which the source instance resides. |
syncArchitecture |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property syncArchitecture: The synchronization topology. |
usedTime |
java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable |
Property usedTime: The subscription duration. |
instanceClassRequired
public java.lang.Object getInstanceClass();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getPayType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property payType: The billing method.
Valid values:
- PrePaid: subscription
- PostPaid: pay-as-you-go
typeRequired
public java.lang.Object getType();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getAutoPay();
- Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getAutoStart();
- Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getComputeUnit();
- Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDatabaseCount();
- Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDestinationEndpointEngineName();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getDestinationRegion();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getDu();
- Type: java.lang.Number OR com.aliyun.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 java.lang.Object getFeeType();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getJobId();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getPeriod();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group.
sourceEndpointEngineNameOptional
public java.lang.Object getSourceEndpointEngineName();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getSourceRegion();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getSyncArchitecture();
- Type: java.lang.String OR com.aliyun.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 java.lang.Object getUsedTime();
- Type: java.lang.Number OR com.aliyun.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.