DATASOURCE::DTS::MigrationJob - Resource Orchestration Service

DATASOURCE::DTS::MigrationJob is used to query the execution information about a data migration task in Data Transmission Service (DTS).

Syntax

{
  "Type": "DATASOURCE::DTS::MigrationJob",
  "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

SourceEndpointRegion: the region of the source instance.
DestinationSourceEndpointRegion: the region of the destination instance.
CreateTime: the time when the data migration task was created.
PaymentType: the payment type of the data migration instance.
SourceEndpointEngineName: the database engine type of the source instance.
InstanceClass: the instance class.
DestinationEndpointEngineName: the database engine type of the destination instance.
DtsInstanceId: the ID of the data migration instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DtsInstanceId:
    Type: String
    Description:
      en: The ID of the synchronization instance.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DTS::MigrationJob
    Properties:
      DtsInstanceId:
        Ref: DtsInstanceId
Outputs:
  SourceEndpointRegion:
    Description: The type of the source instance database engine.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointRegion
  DestinationSourceEndpointRegion:
    Description: The target database engine type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationSourceEndpointRegion
  CreateTime:
    Description: The task creation time, which follows the yyyy-MM-ddTHH:mm:ssZ(UTC time).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreateTime
  PaymentType:
    Description: The payment type of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - PaymentType
  SourceEndpointEngineName:
    Description: The type of the source instance database engine.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointEngineName
  InstanceClass:
    Description: The specification of the migration or synchronization instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - InstanceClass
  DestinationEndpointEngineName:
    Description: The target database engine type.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationEndpointEngineName
  DtsInstanceId:
    Description: The ID of the synchronization instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DtsInstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DtsInstanceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the synchronization instance."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::MigrationJob",
      "Properties": {
        "DtsInstanceId": {
          "Ref": "DtsInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "SourceEndpointRegion": {
      "Description": "The type of the source instance database engine.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointRegion"
        ]
      }
    },
    "DestinationSourceEndpointRegion": {
      "Description": "The target database engine type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationSourceEndpointRegion"
        ]
      }
    },
    "CreateTime": {
      "Description": "The task creation time, which follows the yyyy-MM-ddTHH:mm:ssZ(UTC time).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreateTime"
        ]
      }
    },
    "PaymentType": {
      "Description": "The payment type of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "PaymentType"
        ]
      }
    },
    "SourceEndpointEngineName": {
      "Description": "The type of the source instance database engine.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointEngineName"
        ]
      }
    },
    "InstanceClass": {
      "Description": "The specification of the migration or synchronization instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "InstanceClass"
        ]
      }
    },
    "DestinationEndpointEngineName": {
      "Description": "The target database engine type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationEndpointEngineName"
        ]
      }
    },
    "DtsInstanceId": {
      "Description": "The ID of the synchronization instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsInstanceId"
        ]
      }
    }
  }
}