DATASOURCE::DTS::SynchronizationJob - Resource Orchestration Service

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

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

DtsInstanceId

String

Yes

The ID of the data synchronization 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

DestinationEndpointRegion: the region of the destination instance.
SourceEndpointRegion: the region of the source instance.
CreateTime: the time when the data synchronization task was created.
PaymentType: the billing method of the data synchronization 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 synchronization instance.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DtsInstanceId:
    Type: String
    Description:
      en: Synchronization instance ID.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::DTS::SynchronizationJob
    Properties:
      DtsInstanceId:
        Ref: DtsInstanceId
Outputs:
  DestinationEndpointRegion:
    Description: Region of source instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DestinationEndpointRegion
  SourceEndpointRegion:
    Description: Region of source instance.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - SourceEndpointRegion
  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: Source instance database engine type.
    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: Synchronization instance ID.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DtsInstanceId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DtsInstanceId": {
      "Type": "String",
      "Description": {
        "en": "Synchronization instance ID."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::SynchronizationJob",
      "Properties": {
        "DtsInstanceId": {
          "Ref": "DtsInstanceId"
        }
      }
    }
  },
  "Outputs": {
    "DestinationEndpointRegion": {
      "Description": "Region of source instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DestinationEndpointRegion"
        ]
      }
    },
    "SourceEndpointRegion": {
      "Description": "Region of source instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SourceEndpointRegion"
        ]
      }
    },
    "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": "Source instance database engine type.",
      "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": "Synchronization instance ID.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsInstanceId"
        ]
      }
    }
  }
}