DATASOURCE::DTS::MigrationJobs - Resource Orchestration Service

DATASOURCE::DTS::MigrationJobs is used to query the information about data migration tasks in Data Transmission Service (DTS).

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

DtsInstanceId

String

Yes

The ID of the data migration instance.

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 data migration instances.
MigrationInstances: details of the data migration instances.

Property	Type	Description	Constraint
DtsInstanceIds	List	The IDs of the data migration instances.	None.
SynchronizationInstances	List	Details of the data migration instances.	None.
DestinationEndpointEngineName	String	The database engine type of the destination instance.	None.
DestinationEndpointRegion	String	The region of the destination instance.	None.
DtsInstanceId	String	The ID of the data migration instance.	None.
SourceEndpointEngineName	String	The database engine type of the source instance.	None.
PaymentType	String	The billing method of the data migration instance.	None.
InstanceClass	String	The instance class.	None.
SourceEndpointRegion	String	The region of the source instance.	None.
CreateTime	String	The time when the data migration task was created.	None.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DtsInstanceId:
    Type: String
    Description:
      en: Synchronization instance ID.
    Required: false
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DTS::MigrationJobs
    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

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DtsInstanceId": {
      "Type": "String",
      "Description": {
        "en": "Synchronization instance ID."
      },
      "Required": false
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::MigrationJobs",
      "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"
        ]
      }
    }
  }
}