DATASOURCE::DTS::SynchronizationJobs - Resource Orchestration Service

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

Syntax

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

SynchronizationInstances: details of the data synchronization instances.
DtsInstanceIds: the IDs of the data synchronization instances.

Property	Type	Description	Constraint
DtsInstanceIds	List	The IDs of the data synchronization instances.	None.
SynchronizationInstances	List	Details of the data synchronization 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 synchronization instance.	None.
SourceEndpointEngineName	String	The database engine type of the source instance.	None.
PaymentType	String	The billing method of the data synchronization instance.	None.
InstanceClass	String	The instance class.	None.
SourceEndpointRegion	String	The region of the source instance.	None.
CreateTime	String	The time when the data synchronization task was created.	None.

Examples

YAML

                              ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DtsInstanceId:
    Description:
      en: Synchronization instance ID.
    Required: false
    Type: String
  RefreshOptions:
    AllowedValues:
    - Always
    - Never
    Default: Never
    Description:
      en: 'The refresh strategy for the datasource resource when the stack is updated.
        Valid values:

        - Never: Never refresh the datasource resource when the stack is updated.

        - Always: Always refresh the datasource resource when the stack is updated.

        Default is Never.'
    Required: false
    Type: String
Resources:
  ExtensionDataSource:
    Properties:
      DtsInstanceId:
        Ref: DtsInstanceId
      RefreshOptions:
        Ref: RefreshOptions
    Type: DATASOURCE::DTS::SynchronizationJobs
Outputs:
  DtsInstanceIds:
    Description: The list of dts instance IDs.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - DtsInstanceIds
  SynchronizationInstances:
    Description: The list of synchronization instances.
    Value:
      Fn::GetAtt:
      - ExtensionDataSource
      - SynchronizationInstances

JSON

                        {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DtsInstanceId": {
      "Type": "String",
      "Description": {
        "en": "Synchronization instance ID."
      },
      "Required": false
    },
    "RefreshOptions": {
      "Type": "String",
      "Description": {
        "en": "The refresh strategy for the datasource resource when the stack is updated. Valid values:\n- Never: Never refresh the datasource resource when the stack is updated.\n- Always: Always refresh the datasource resource when the stack is updated.\nDefault is Never."
      },
      "AllowedValues": [
        "Always",
        "Never"
      ],
      "Required": false,
      "Default": "Never"
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::DTS::SynchronizationJobs",
      "Properties": {
        "DtsInstanceId": {
          "Ref": "DtsInstanceId"
        },
        "RefreshOptions": {
          "Ref": "RefreshOptions"
        }
      }
    }
  },
  "Outputs": {
    "SynchronizationInstances": {
      "Description": "The list of synchronization instances.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SynchronizationInstances"
        ]
      }
    },
    "DtsInstanceIds": {
      "Description": "The list of dts instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsInstanceIds"
        ]
      }
    }
  }
}