ALIYUN::DTS::Instance is a new resource type that is used to create a Data Transmission Service (DTS) instance.
We recommend that you use new resource types to replace previous resource types that are used to create DTS resources. The following information shows the correspondence between the previous and new resource types:
ALIYUN::DTS::MigrationJob (previous): ALIYUN::DTS::MigrationJob2 (new) and ALIYUN::DTS::Instance (new)
ALIYUN::DTS::SynchronizationJob (previous): ALIYUN::DTS::SynchronizationJob2 (new) and ALIYUN::DTS::Instance (new)
ALIYUN::DTS::SubscriptionInstance (previous): ALIYUN::DTS::SubscriptionJob2 (new) and ALIYUN::DTS::Instance (new)
Syntax
{
"Type": "ALIYUN::DTS::Instance",
"Properties": {
"ResourceGroupId": String,
"FeeType": String,
"ComputeUnit": Integer,
"Period": String,
"DestinationRegion": String,
"InstanceClass": String,
"SourceEndpointEngineName": String,
"PayType": String,
"AutoPay": Boolean,
"DestinationEndpointEngineName": String,
"SourceRegion": String,
"Du": Integer,
"Type": String,
"DatabaseCount": Integer,
"UsedTime": Integer,
"AutoStart": Boolean,
"JobId": String,
"SyncArchitecture": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
ResourceGroupId | String | No | No | The ID of the resource group. | None. |
FeeType | String | No | No | The billing type of the subscription. | Valid values:
|
ComputeUnit | Integer | No | No | The specification of extract, transform, and load (ETL). | The unit is compute unit (CU). One CU is equal to one vCPU and four GB of memory. The value of this property must be an integer greater than or equal to 2. Note You can specify this property to enable the ETL feature and cleanse and transform data. For more information, see Configure an ETL task in DAG mode. |
Period | String | No | Yes | The billing cycle of the subscription instance. | Valid values:
Note You must specify this property when PayType is set to PrePaid. |
DestinationRegion | String | No | No | The region of the destination instance. | For more information, see Supported regions. Note You must specify one of DestinationRegion and JobId. |
InstanceClass | String | Yes | Yes | The specification of a data migration or synchronization instance. |
Note For more information about the performance of each specification, see Instance classes of data migration instances and Instance classes of data synchronization instances. |
SourceEndpointEngineName | String | No | No | The database engine of the source instance. | Valid values:
Note You must specify one of SourceEndpointEngineName and JobId. For more information about the supported source and destination databases, see Overview of data migration scenarios and Overview of data synchronization scenarios. |
PayType | String | Yes | Yes | The billing method of the instance. | Valid values:
|
AutoPay | Boolean | No | No | Specifies whether to enable auto-renewal when the instance expires. | Valid values:
|
DestinationEndpointEngineName | String | No | No | The database engine of the destination instance. | Valid values:
For more information about the supported source and destination databases, see Overview of data migration scenarios and Overview of data synchronization scenarios. Note You must specify one of DestinationEndpointEngineName and JobId. |
SourceRegion | String | No | No | The region of the source instance. | For more information, see Supported regions. Note You must specify one of SourceRegion and JobId. |
Du | Integer | No | No | The number of DTS units (DUs) that you want to assign to a DTS task on a DTS dedicated cluster. | Valid values: 1 to 100. Note The value of this property must be within the range of the number of DUs available for the DTS dedicated cluster. For more information about DTS dedicated clusters, see What is a DTS dedicated cluster? |
Type | String | Yes | No | The type of the instance. | Valid values:
|
DatabaseCount | Integer | No | No | The number of private custom ApsaraDB RDS instances in a PolarDB-X instance. | Default value: 1. Note You must specify this property when SourceEndpointEngineName is set to DRDS. |
UsedTime | Integer | No | Yes | The subscription duration of the instance. |
Note You must specify this property when PayType is set to PrePaid. You can configure Period to specify the unit of the subscription duration. |
AutoStart | Boolean | No | No | Specifies whether to automatically start the task after the instance is purchased. | Valid values:
|
JobId | String | No | No | The task ID. | If you specify JobId, you do not need to specify SourceRegion, DestinationRegion, SourceEndpointEngineName, or DestinationEndpointEngineName. The value of JobId still takes precedence even if SourceRegion, DestinationRegion, SourceEndpointEngineName, and DestinationEndpointEngineName are specified. |
SyncArchitecture | String | No | No | The synchronization topology. | Valid values:
|
Return values
Fn::GetAtt
InstanceId: the instance ID.
JobId: the task ID.