All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::DTS::MigrationInstances

Last Updated:Jun 01, 2023

DATASOURCE::DTS::MigrationInstances is used to query information about Data Transmission Service (DTS) tasks.

Syntax

{
  "Type": "DATASOURCE::DTS::MigrationInstances",
  "Properties": {
    "DtsInstanceId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

DtsInstanceId

String

No

Yes

The ID of the DTS instance that provides the migration, synchronization, or subscription service.

None

Return values

Fn::GetAtt

  • DtsInstanceIds: the IDs of the DTS instances that provide the migration, synchronization, or subscription service.

  • DtsInstanceIds: the DTS instances that provide the migration, synchronization, or subscription service.

Property

Type

Description

Constraint

DtsInstanceIds

List

The IDs of the DTS instances that provide the migration, synchronization, or subscription service.

None

MigrationInstances

List

The DTS instances that provide the migration, synchronization, or subscription service.

None

DestinationEndpointEngineName

String

The database engine of the destination instance.

None

DtsInstanceId

String

The ID of the DTS instance that provides the migration, synchronization, or subscription service.

None

SourceEndpointEngineName

String

The database engine of the source instance.

None

PaymentType

String

The billing method of the DTS instance.

None

InstanceClass

String

The specification of the DTS instance.

None

SourceEndpointRegion

String

The region of the source instance.

None

CreateTime

String

The time when the DTS task was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

DestinationSourceEndpointRegion

String

The region of the destination instance.

None

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DtsInstanceId:
    Description: Synchronization instance ID.
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DtsInstanceId:
        Ref: DtsInstanceId
    Type: DATASOURCE::DTS::MigrationInstances
Outputs:
  DtsInstanceIds:
    Description: The list of dts instance IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DtsInstanceIds
  MigrationInstances:
    Description: The list of migration instances.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - MigrationInstances

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DtsInstanceId": {
      "Type": "String",
      "Description": "Synchronization instance ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::MigrationInstances",
      "Properties": {
        "DtsInstanceId": {
          "Ref": "DtsInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DtsInstanceIds": {
      "Description": "The list of dts instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsInstanceIds"
        ]
      }
    },
    "MigrationInstances": {
      "Description": "The list of migration instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "MigrationInstances"
        ]
      }
    }
  }
}