Resource Orchestration Service:ALIYUN::DTS::SynchronizationJob

Syntax

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

Properties

SourceEndpoint syntax

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

SourceEndpoint properties

SynchronizationObjects syntax

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

SynchronizationObjects properties

TableExcludes syntax

"TableExcludes": [
  {
    "TableName": String
  }
]

TableExcludes properties

TableIncludes syntax

"TableIncludes": [
  {
    "TableName": String,
    "FilterCondition": String,
    "ColumnExcludes": List,
    "ColumnIncludes": List,
    "NewTableName": String
  }
]

TableIncludes properties

ColumnExcludes syntax

"ColumnExcludes": [
  {
    "ColumnName": String
  }
]

ColumnExcludes properties

ColumnIncludes syntax

"ColumnIncludes": [
  {
    "NewColumnName": String,
    "ColumnName": String
  }
]

ColumnIncludes properties

DestinationEndpoint syntax

"DestinationEndpoint": {
  "UserName": String,
  "InstanceId": String,
  "IP": String,
  "InstanceType": String,
  "Password": String,
  "InstanceTypeForCreation": String,
  "Port": String
}

DestinationEndpoint properties

Response parameters

Fn::GetAtt

SynchronizationJobId: the ID of the synchronization instance.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "SynchronizationObjects": {
      "Type": "Json",
      "Description": "Objects that need to be synchronized"
    },
    "Period": {
      "Type": "String",
      "Description": "If prepaid payment type, then the parameters specified in the purchase package instance or instances as examples of a monthly subscription, which can be:\nYear: Annual, Month: monthly",
      "AllowedValues": [
        "Year",
        "Month"
      ]
    },
    "PayType": {
      "Type": "String",
      "Description": "Payment type, which include:\nPostpaid: postpaid type, Prepaid: Prepaid type. Default is Postpaid",
      "AllowedValues": [
        "Postpaid",
        "Prepaid"
      ],
      "Default": "Postpaid"
    },
    "Topology": {
      "Type": "String",
      "Description": "Synchronous topology, the value includes: oneway, bidirectional.the default value is: oneway, only MySQL-> MySQL synchronization, this parameter can receive the value bidirectional"
    },
    "SourceRegion": {
      "Type": "String",
      "Description": "Region where the synchronization source instance is located."
    },
    "DataInitialization": {
      "Type": "Boolean",
      "Description": "Whether to perform full data initialization before synchronization. The values include:true: means full data initialization\nfalse: no full data initialization\nThe default value is: true",
      "AllowedValues": [
        "true",
        "false"
      ],
      "Default": true
    },
    "NetworkType": {
      "Type": "String",
      "Description": "When synchronization geographies, the type of data transmission network used. Value include: Internet, Intranet. The default value is: Internet",
      "AllowedValues": [
        "Internet",
        "Intranet"
      ]
    },
    "DestinationEndpoint": {
      "Type": "Json",
      "Description": "Migration target configuration"
    },
    "SourceEndpoint": {
      "Type": "Json",
      "Description": "Migration source configuration"
    },
    "UsedTime": {
      "Type": "Number",
      "Description": "f the payment type is prepaid, then this parameter is the length of the purchase, and parameters such as 1, 2, 3 can be passed in as needed"
    },
    "StructureInitialization": {
      "Type": "Boolean",
      "Description": "Whether to initialize the structure object before synchronization. The values include:true: indicates that the structure object is initialized\nfalse: no result object initialization\nThe default value is: true",
      "AllowedValues": [
        "true",
        "false"
      ],
      "Default": true
    },
    "SynchronizationJobClass": {
      "Type": "String",
      "Description": "Synchronous instance specifications, which can be:\nmicro, small, medium, large and so on. The default value is: small"
    },
    "DestRegion": {
      "Type": "String",
      "Description": "Region where the synchronization target instance is located."
    }
  },
  "Resources": {
    "SynchronizationJob": {
      "Type": "ALIYUN::DTS::SynchronizationJob",
      "Properties": {
        "SynchronizationObjects": {
          "Ref": "SynchronizationObjects"
        },
        "Period": {
          "Ref": "Period"
        },
        "PayType": {
          "Ref": "PayType"
        },
        "Topology": {
          "Ref": "Topology"
        },
        "SourceRegion": {
          "Ref": "SourceRegion"
        },
        "DataInitialization": {
          "Ref": "DataInitialization"
        },
        "NetworkType": {
          "Ref": "NetworkType"
        },
        "DestinationEndpoint": {
          "Ref": "DestinationEndpoint"
        },
        "SourceEndpoint": {
          "Ref": "SourceEndpoint"
        },
        "UsedTime": {
          "Ref": "UsedTime"
        },
        "StructureInitialization": {
          "Ref": "StructureInitialization"
        },
        "SynchronizationJobClass": {
          "Ref": "SynchronizationJobClass"
        },
        "DestRegion": {
          "Ref": "DestRegion"
        }
      }
    }
  },
  "Outputs": {
    "SynchronizationJobId": {
      "Description": "Synchronization instance ID",
      "Value": {
        "Fn::GetAtt": [
          "SynchronizationJob",
          "SynchronizationJobId"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  SynchronizationObjects:
    Type: Json
    Description: Objects that need to be synchronized
  Period:
    Type: String
    Description: >-
      If prepaid payment type, then the parameters specified in the purchase
      package instance or instances as examples of a monthly subscription, which
      can be:

      Year: Annual, Month: monthly
    AllowedValues:
      - Year
      - Month
  PayType:
    Type: String
    Description: |-
      Payment type, which include:
      Postpaid: postpaid type, Prepaid: Prepaid type. Default is Postpaid
    AllowedValues:
      - Postpaid
      - Prepaid
    Default: Postpaid
  Topology:
    Type: String
    Description: >-
      Synchronous topology, the value includes: oneway, bidirectional.the
      default value is: oneway, only MySQL-> MySQL synchronization, this
      parameter can receive the value bidirectional
  SourceRegion:
    Type: String
    Description: Region where the synchronization source instance is located.
  DataInitialization:
    Type: Boolean
    Description: >-
      Whether to perform full data initialization before synchronization. The
      values include:true: means full data initialization

      false: no full data initialization

      The default value is: true
    AllowedValues:
      - 'true'
      - 'false'
    Default: true
  NetworkType:
    Type: String
    Description: >-
      When synchronization geographies, the type of data transmission network
      used. Value include: Internet, Intranet. The default value is: Internet
    AllowedValues:
      - Internet
      - Intranet
  DestinationEndpoint:
    Type: Json
    Description: Migration target configuration
  SourceEndpoint:
    Type: Json
    Description: Migration source configuration
  UsedTime:
    Type: Number
    Description: >-
      f the payment type is prepaid, then this parameter is the length of the
      purchase, and parameters such as 1, 2, 3 can be passed in as needed
  StructureInitialization:
    Type: Boolean
    Description: >-
      Whether to initialize the structure object before synchronization. The
      values include:true: indicates that the structure object is initialized

      false: no result object initialization

      The default value is: true
    AllowedValues:
      - 'true'
      - 'false'
    Default: true
  SynchronizationJobClass:
    Type: String
    Description: |-
      Synchronous instance specifications, which can be:
      micro, small, medium, large and so on. The default value is: small
  DestRegion:
    Type: String
    Description: Region where the synchronization target instance is located.
Resources:
  SynchronizationJob:
    Type: 'ALIYUN::DTS::SynchronizationJob'
    Properties:
      SynchronizationObjects:
        Ref: SynchronizationObjects
      Period:
        Ref: Period
      PayType:
        Ref: PayType
      Topology:
        Ref: Topology
      SourceRegion:
        Ref: SourceRegion
      DataInitialization:
        Ref: DataInitialization
      NetworkType:
        Ref: NetworkType
      DestinationEndpoint:
        Ref: DestinationEndpoint
      SourceEndpoint:
        Ref: SourceEndpoint
      UsedTime:
        Ref: UsedTime
      StructureInitialization:
        Ref: StructureInitialization
      SynchronizationJobClass:
        Ref: SynchronizationJobClass
      DestRegion:
        Ref: DestRegion
Outputs:
  SynchronizationJobId:
    Description: Synchronization instance ID
    Value:
      'Fn::GetAtt':
        - SynchronizationJob
        - SynchronizationJobId