Use DATASOURCE::DTS::MigrationInstances to query the information about DTS tasks - Resource Orchestration Service

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

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

DtsInstanceId

String

Yes

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

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

DtsInstanceIds: the IDs of the DTS instances that provide the migration, synchronization, or subscription service.
MigrationInstances: the names of 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 instance type.	None.
SourceEndpointRegion	String	The region in which the source instance resides.	None.
CreateTime	String	The time when the DTS task was created.	The time is displayed in the `yyyy-MM-ddTHH:mm:ssZ` format in UTC.
DestinationSourceEndpointRegion	String	The region in which the destination instance resides.	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"
        ]
      }
    }
  }
}