データ同期インスタンスを購入し、データ同期タスクを構成するために ALIYUN::DTS::SynchronizationJob を使用します - Resource Orchestration Service

ALIYUN::DTS::SynchronizationJob は、データ同期インスタンスを購入し、データ同期タスクを構成するために使用されます。

説明

データ伝送サービス (DTS) インスタンスの購入には ALIYUN::DTS::Instance を、データ同期タスクの構成には ALIYUN::DTS::SynchronizationJob2 を使用することをお勧めします。

構文

{
  "Type": "ALIYUN::DTS::SynchronizationJob",
  "Properties": {
    "SynchronizationJobClass": String,
    "SourceEndpoint": Map,
    "PayType": String,
    "DataInitialization": Boolean,
    "Period": String,
    "DestRegion": String,
    "SourceRegion": String,
    "UsedTime": Integer,
    "SynchronizationObjects": List,
    "NetworkType": String,
    "DestinationEndpoint": Map,
    "StructureInitialization": Boolean,
    "Topology": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
SynchronizationJobClass	String	はい	いいえ	データ同期インスタンスの仕様。	有効な値： micro small (デフォルト) medium large
SourceEndpoint	Map	はい	いいえ	ソースインスタンスの構成。	詳細については、SourceEndpoint プロパティをご参照ください。
PayType	String	いいえ	いいえ	課金方法。	有効な値： Postpaid Prepaid
DataInitialization	Boolean	いいえ	いいえ	データ同期タスクの前に初期フルデータ同期を実行するかどうかを指定します。	有効な値： true (デフォルト) false
Period	String	いいえ	いいえ	サブスクリプション期間の単位。	有効な値： Year 月このプロパティは、PayType が Prepaid に設定されている場合に有効になります。
DestRegion	String	はい	いいえ	宛先インスタンスのリージョン ID です。	なし。
SourceRegion	String	はい	いいえ	ソースインスタンスのリージョン ID です。	なし。
DestRegion	String	はい	いいえ	宛先インスタンスのリージョン ID。	なし。
SourceRegion	String	はい	いいえ	ソースインスタンスのリージョン ID。	詳細については、「SynchronizationObjects プロパティ」をご参照ください。
UsedTime	Integer	いいえ	いいえ	データ同期インスタンスのサブスクリプション期間。	有効な値: インターネット (既定) イントラネット
SynchronizationObjects	List	いいえ	いいえ	同期するオブジェクト。	詳細については、「DestinationEndpoint プロパティ」をご参照ください。
StructureInitialization	Boolean	いいえ	いいえ	データ同期タスクの前に初期スキーマ同期を実行するかどうかを指定します。	有効な値: true (デフォルト) false
NetworkType	String	いいえ	いいえ	リージョン間同期に使用するデータ伝送ネットワークのタイプ。	有効な値： Internet (デフォルト) 双方向このプロパティは、MySQL データ間の同期の場合にのみ双方向に設定できます。

SourceEndpoint 構文

"SourceEndpoint": {
  "UserName": String,
  "InstanceId": String,
  "IP": String,
  "Port": String,
  "Role": String,
  "OwnerID": String,
  "Password": String,
  "InstanceType": String,
  "InstanceTypeForCreation": String
}

SourceEndpoint プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
UserName	String	いいえ	いいえ	ソースインスタンスへのアクセスに使用するユーザー名。	ソースインスタンスがElastic Compute Service（ECS）インスタンス、またはExpress Connect回線を介して接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。ソースインスタンスがApsaraDB for Redisインスタンスの場合は、このプロパティを指定する必要はありません。
InstanceId	String	いいえ	いいえ	ソースインスタンスのID。	なし。
IP	String	いいえ	いいえ	ソースインスタンスのIPアドレス。	ソースインスタンスがExpress Connect回線を介して接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。
Port	String	いいえ	いいえ	ソースインスタンスのリスニングポート。	ソースインスタンスがECSインスタンス、またはExpress Connect回線を介して接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。
Role	String	いいえ	いいえ	ソースインスタンスが属するAlibaba Cloudアカウントによって承認されたResource Access Management（RAM）ロールの名前。このプロパティは、ソースインスタンスとデスティネーションインスタンスが異なるAlibaba Cloudアカウントに属している場合に有効になります。 RAMロールの権限とRAMロールへの権限の付与方法の詳細については、アカウントをまたがるDTSタスクのRAM認証を設定するをご参照ください。	なし。
OwnerID	String	いいえ	いいえ	ソースインスタンスが属するAlibaba CloudアカウントのID。このプロパティは、ソースインスタンスとデスティネーションインスタンスが異なるAlibaba Cloudアカウントに属している場合に有効になります。	なし。
Password	String	いいえ	いいえ	ソースインスタンスへのアクセスに使用するパスワード。	ソースインスタンスがECSインスタンス、またはExpress Connect回線を介して接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。
InstanceType	String	はい	いいえ	ソースインスタンスのタイプ。	有効な値： Redis：ApsaraDB for Redisインスタンス RDS：ApsaraDB RDSインスタンス POLARDB：PolarDB for MySQLクラスター ECS：ECSインスタンスでホストされている自己管理データベース Express：Express Connect回線を介して接続されている自己管理データベース dg：Database Gateway（DG）を介して接続されている自己管理データベース cen：Cloud Enterprise Network（CEN）を介して接続されている自己管理データベース
InstanceTypeForCreation	String	いいえ	いいえ	同期チャネルのソースインスタンスのタイプ。	有効な値： MySQL PolarDB Redis SQLServer PostgreSQL PolarDB-X (旧称 DRDS)

SynchronizationObjects の構文

"SynchronizationObjects": [
  {
    "TableExcludes": List,
    "NewSchemaName": String,
    "NewDBName": String,
    "TableIncludes": List,
    "SchemaName": String,
    "DBName": String
  }
]

SynchronizationObjects プロパティ

プロパティ	種類	必須	編集可能	説明	制約
TableExcludes	リスト	いいえ	いいえ	ソースデータベースから同期したくないテーブルの名前です。	なし。
NewSchemaName	文字列	いいえ	いいえ	同期先インスタンスに同期するスキーマのマッピング名です。	なし。
NewDBName	文字列	いいえ	いいえ	同期先インスタンスに同期するデータベースのマッピング名です。	なし。
TableIncludes	リスト	いいえ	いいえ	ソースデータベースから同期するテーブルの名前です。	なし。
SchemaName	文字列	いいえ	いいえ	同期するスキーマの名前です。	なし。
DBName	文字列	いいえ	いいえ	同期するデータベースの名前です。	なし。

TableExcludes 構文

"TableExcludes": [
  {
    "TableName": String // テーブル名
  }
]

TableExcludes プロパティ

プロパティ	型	必須	編集可能	説明	制約
TableName	String	いいえ	いいえ	テーブル名。	なし。

TableIncludes 構文

"TableIncludes": [
  {
    "TableName": String, // テーブル名
    "FilterCondition": String, // フィルター条件
    "ColumnExcludes": List, // 除外する列
    "ColumnIncludes": List, // 含める列
    "NewTableName": String // 新しいテーブル名
  }
]

TableIncludes プロパティ

プロパティ	型	必須	編集可能	説明	制約
TableName	String	いいえ	いいえ	同期するテーブルの名前。	なし。
FilterCondition	String	いいえ	いいえ	フィルター条件。	なし。
ColumnExcludes	List	いいえ	いいえ	同期しない列の名前。	なし。
ColumnIncludes	List	いいえ	いいえ	同期する列の名前。	なし。
NewTableName	String	いいえ	いいえ	同期先のインスタンスに同期するテーブルのマッピングされた名前。	なし。

ColumnExcludes 構文

"ColumnExcludes": [
  {
    "ColumnName": String // 列名
  }
]

ColumnExcludes プロパティ

プロパティ	型	必須	編集可能	説明	制約
ColumnName	String	いいえ	いいえ	同期したくない列の名前。	なし。

ColumnIncludes 構文

"ColumnIncludes": [
  {
    "NewColumnName": String, // 新しい列名
    "ColumnName": String // 列名
  }
]

ColumnIncludes プロパティ

プロパティ	型	必須	編集可能	説明	制約
NewColumnName	String	いいえ	いいえ	宛先インスタンスに同期する列のマッピング名。	なし。
ColumnName	String	いいえ	いいえ	同期する列の名前。	なし。

SourceEndpoint 構文

"DestinationEndpoint": {
  "UserName": String, // ユーザー名
  "InstanceId": String, // インスタンス ID
  "IP": String, // IP アドレス
  "InstanceType": String, // インスタンスタイプ
  "Password": String, // パスワード
  "InstanceTypeForCreation": String, // 作成用のインスタンスタイプ
  "Port": String // ポート
}

DestinationEndpoint プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
UserName	String	いいえ	いいえ	宛先インスタンスへのアクセスに使用するユーザー名。	宛先インスタンスが ECS インスタンスまたは Express Connect 回線経由で接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。宛先インスタンスが ApsaraDB for Redis インスタンスの場合は、このプロパティを指定する必要はありません。
InstanceId	String	いいえ	いいえ	宛先インスタンスの ID。	宛先インスタンスが MaxCompute プロジェクトの場合、値を MaxCompute プロジェクトの名前に設定します。宛先インスタンスが AnalyticDB for MySQL クラスタの場合、値を AnalyticDB for MySQL クラスタの ID に設定します。宛先インスタンスが DataHub プロジェクトの場合、値を DataHub プロジェクトの名前に設定します。
IP	String	いいえ	いいえ	宛先インスタンスの IP アドレス。	宛先インスタンスが Express Connect 回線経由で接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。
InstanceType	String	はい	いいえ	宛先インスタンスのタイプ。	有効な値： Redis: ApsaraDB for Redis インスタンス RDS（デフォルト）: ApsaraDB RDS インスタンス POLARDB: PolarDB for MySQL クラスタ ECS: ECS インスタンスでホストされているセルフマネージドデータベース Express: Express Connect 回線経由で接続されたセルフマネージドデータベース MaxCompute: MaxCompute プロジェクト DataHub: DataHub プロジェクト AnalyticDB: AnalyticDB for MySQL V2.0 クラスタ AnalyticDB30: AnalyticDB for MySQL V3.0 クラスタ
InstanceTypeForCreation	String	いいえ	いいえ	同期チャネルの宛先インスタンスのタイプ。	有効な値: MySQL PolarDB Redis MaxCompute DataHub Kafka Elasticsearch Tablestore
Password	String	いいえ	いいえ	宛先インスタンスへのアクセスに使用するパスワード。	宛先インスタンスが ECS インスタンスまたは Express Connect 回線経由で接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。
Port	String	いいえ	いいえ	宛先インスタンスのリスニングポート。	宛先インスタンスが ECS インスタンスまたは Express Connect 回線経由で接続されたオンプレミスデータベースである場合は、このプロパティを指定する必要があります。

戻り値

Fn::GetAtt

SynchronizationJobId: データ同期インスタンスの ID です。

SourceEndpoint プロパティ

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RdsId:
    Type: String
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
Resources:
  SynchronizationJob:
    Type: ALIYUN::DTS::SynchronizationJob
    Properties:
      SynchronizationJobClass: small
      SourceEndpoint:
        InstanceId:
          Ref: RdsId
        InstanceTypeForCreation: MySQL
        InstanceType: RDS
      PayType: Postpaid
      DataInitialization: false
      DestRegion:
        Ref: ALIYUN::Region
      SourceRegion:
        Ref: ALIYUN::Region
      NetworkType: Internet
      DestinationEndpoint:
        InstanceId:
          Ref: RdsId
        InstanceTypeForCreation: MySQL
        InstanceType: RDS
      StructureInitialization: false
Outputs:
  SynchronizationJobId:
    Description: 同期インスタンスID
    Value:
      Fn::GetAtt:
        - SynchronizationJob
        - SynchronizationJobId

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RdsId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
    }
  },
  "Resources": {
    "SynchronizationJob": {
      "Type": "ALIYUN::DTS::SynchronizationJob",
      "Properties": {
        "SynchronizationJobClass": "small",
        "SourceEndpoint": {
          "InstanceId": {
            "Ref": "RdsId"
          },
          "InstanceTypeForCreation": "MySQL",
          "InstanceType": "RDS"
        },
        "PayType": "Postpaid",
        "DataInitialization": false,
        "DestRegion": {
          "Ref": "ALIYUN::Region"
        },
        "SourceRegion": {
          "Ref": "ALIYUN::Region"
        },
        "NetworkType": "Internet",
        "DestinationEndpoint": {
          "InstanceId": {
            "Ref": "RdsId"
          },
          "InstanceTypeForCreation": "MySQL",
          "InstanceType": "RDS"
        },
        "StructureInitialization": false
      }
    }
  },
  "Outputs": {
    "SynchronizationJobId": {
      "Description": "同期インスタンスID",
      "Value": {
        "Fn::GetAtt": [
          "SynchronizationJob",
          "SynchronizationJobId"
        ]
      }
    }
  }
}