DATASOURCE::DTS::SynchronizationJobs资源类型用于查询DTS同步任务列表-资源编排-阿里云

DATASOURCE::DTS::SynchronizationJobs类型用于查询DTS同步任务列表。

语法

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

属性

属性名称

类型

必须

允许更新

描述

约束

DtsInstanceId

String

否

是

同步实例ID。

无

RefreshOptions

String

否

是

当资源栈更新时，数据源资源的刷新策略。

取值：

Never（默认值）：更新堆栈时，从不刷新数据源资源。
Always：更新堆栈时，始终刷新数据源资源。

返回值

Fn::GetAtt

SynchronizationInstances：同步实例详情列表。
DtsInstanceIds：同步实例ID列表。

属性名称	类型	描述	约束
DtsInstanceIds	List	同步实例ID列表。	无
SynchronizationInstances	List	同步实例详情列表。	无
DestinationEndpointEngineName	String	目标实例的数据库类型。	无
DestinationEndpointRegion	String	目标实例区域。	无
DtsInstanceId	String	同步实例ID。	无
SourceEndpointEngineName	String	实例的数据库类型。	无
PaymentType	String	实例的付费类型。	无
InstanceClass	String	实例规格。	无
SourceEndpointRegion	String	源实例区域。	无
CreateTime	String	任务创建时间。	无

示例

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"
        ]
      }
    }
  }
}