DATASOURCE::DTS::SynchronizationJobs リファレンス - Resource Orchestration Service

DATASOURCE::DTS::SynchronizationJobs は、Data Transmission Service (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": "同期インスタンスのリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "SynchronizationInstances"
        ]
      }
    },
    "DtsInstanceIds": {
      "Description": "dts インスタンス ID のリスト。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DtsInstanceIds"
        ]
      }
    }
  }
}