ALIYUN::RDS::MigrateTask類型用于將OSS上的備份文件還原到RDS SQL Server實例中，實現(xiàn)數(shù)據(jù)上云。

語法

{
  "Type": "ALIYUN::RDS::MigrateTask",
  "Properties": {
    "IsOnlineDB": Boolean,
    "DBInstanceId": String,
    "OssObjectPositions": String,
    "CheckDBMode": String,
    "BackupMode": String,
    "DBName": String,
    "OSSUrls": String
  }
}

屬性

屬性名稱類型必須允許更新描述約束
IsOnlineDBBoolean是否是否將還原后的數(shù)據(jù)庫帶上線。取值：
  • true：將數(shù)據(jù)庫帶上線。
  • false：不將數(shù)據(jù)庫帶上線。
說明 當數(shù)據(jù)庫類型為SQL Server 2008 R2版本時，該值恒定為true。
DBInstanceIdString是否實例ID。無
OssObjectPositionsString否否OSS的組成部分。取值由3段組成，用英文冒號（:）分隔：
  • OSS Endpoint地址：oss-ap-southeast-1.aliyuncs.com。
  • OSS Bucket名稱：rdsmssqlsingapore。
  • OSS上的備份文件Key：autotest_2008R2_TestMigration_FULL.bak。
說明
  • 當數(shù)據(jù)庫為SQL Server 2008 R2 版本時，本參數(shù)可選。
  • 當數(shù)據(jù)庫為SQL Server 2008 R2以上版本時，本參數(shù)必選。

示例：oss-ap-southeast-1.aliyuncs.com:rdsmssqlsingapore:autotest_2008R2_TestMigration_FULL.bak

CheckDBModeString否否打開數(shù)據(jù)庫后一致性檢查方法。取值：
  • SyncExecuteDBCheck：同步執(zhí)行DB檢查。
  • AsyncExecuteDBCheck（默認值）：異步執(zhí)行DB檢查。

    兼容SQL Server 2008 R2版本。

說明 當 IsOnlineDB參數(shù)取值為true時，本參數(shù)有效。
BackupModeString是否遷移上云任務(wù)類型。取值：
  • FULL：通過全量備份文件執(zhí)行還原操作。
  • UPDF：通過增量文件或日志文件還原增量部分的數(shù)據(jù)。
DBNameString是否目標數(shù)據(jù)庫名稱。無
OSSUrlsString否否備份文件所在的OSS共享URL地址（Encode編碼后的URL）。有多個地址時，先使用“|”隔開，在編碼后傳入?yún)?shù)。
說明 當數(shù)據(jù)庫為SQL Server 2008 R2版本時，本參數(shù)必選。

返回值

Fn::GetAtt

MigrateTaskId：遷移任務(wù)ID。

DBName：目標數(shù)據(jù)庫名稱。

示例

  • YAML 格式

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  RdsId:
    Type: String
    AssociationProperty: ALIYUN::RDS::Instance::InstanceId
  DBName:
    Type: String
    Description: The name of the database that you want to restore.
Resources:
  MigrateTask:
    Type: ALIYUN::RDS::MigrateTask
    Properties:
      IsOnlineDB: true
      DBInstanceId:
        Ref: RdsId
      BackupMode: FULL
      DBName:
        Ref: DBName
Outputs:
  MigrateTaskId:
    Description: The ID of the migrate task.
    Value:
      Fn::GetAtt:
        - MigrateTask
        - MigrateTaskId

  • JSON格式

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "RdsId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::RDS::Instance::InstanceId"
    },
    "DBName": {
      "Type": "String",
      "Description": "The name of the database that you want to restore."
    }
  },
  "Resources": {
    "MigrateTask": {
      "Type": "ALIYUN::RDS::MigrateTask",
      "Properties": {
        "IsOnlineDB": true,
        "DBInstanceId": {
          "Ref": "RdsId"
        },
        "BackupMode": "FULL",
        "DBName": {
          "Ref": "DBName"
        }
      }
    }
  },
  "Outputs": {
    "MigrateTaskId": {
      "Description": "The ID of the migrate task.",
      "Value": {
        "Fn::GetAtt": [
          "MigrateTask",
          "MigrateTaskId"
        ]
      }
    }
  }
}