ALIYUN::DBS::Download リソースタイプ - ROS

ALIYUN::DBS::Download は、高度なダウンロードタスクを作成するために使用されます。

構文

{
  "Type": "ALIYUN::DBS::Download",
  "Properties": {
    "BakSetId": String,
    "InstanceName": String,
    "DownloadPointInTime": String,
    "BakSetType": String,
    "BakSetSize": String,
    "TargetPath": String,
    "TargetType": String,
    "TargetOssRegion": String,
    "DeleteBackupSetInOss": Boolean,
    "TargetBucket": String,
    "FormatType": String,
    "DownloadAddressDuration": Integer
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
BakSetId	String	いいえ	いいえ	完全バックアップセットの ID。	DescribeBackups オペレーションを呼び出して、完全バックアップセットの ID をクエリできます。オペレーションの詳細については、「データバックアップファイルをクエリする」をご参照ください。説明このプロパティは、BakSetType が full に設定されている場合に指定する必要があります。
InstanceName	String	はい	いいえ	インスタンス ID。	なし。
DownloadPointInTime	String	いいえ	いいえ	バックアップセットがダウンロードされる時点。	エポックタイム 1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプを指定します。タイムスタンプは Long 型です。例：1661331864000。説明このプロパティは、BakSetType が pitr に設定されている場合に指定する必要があります。
BakSetType	String	いいえ	いいえ	ダウンロードタスクのタイプ。	有効な値： full: タスクは完全バックアップセットをダウンロードするために使用されます。 pitr: タスクは特定の時点のバックアップセットをダウンロードするために使用されます。
BakSetSize	String	いいえ	いいえ	完全バックアップセットのサイズ。	DescribeBackups オペレーションを呼び出して、完全バックアップセットのサイズをクエリできます。オペレーションの詳細については、「データバックアップファイルをクエリする」をご参照ください。
TargetPath	String	いいえ	いいえ	バックアップセットのダウンロード先のパス。	このプロパティは、TargetType が OSS に設定されている場合に指定する必要があります。
TargetType	String	いいえ	いいえ	バックアップセットのダウンロード先のタイプ。	有効な値： OSS URL
TargetOssRegion	String	いいえ	いいえ	Object Storage Service (OSS) バケットが存在するリージョン。	このプロパティは、TargetType が OSS に設定されている場合に指定する必要があります。
DeleteBackupSetInOss	Boolean	いいえ	はい	スタックの削除時に OSS からバックアップセットを削除するかどうかを指定します。	有効な値： true false (デフォルト)
TargetBucket	String	いいえ	いいえ	バックアップセットの格納に使用する OSS バケットの名前。	このプロパティは、TargetType が OSS に設定されている場合に指定する必要があります。アカウントに AliyunDBSDefaultRole 権限が付与されていることを確認してください。権限の取得方法については、「リソース承認に RAM を使用する」をご参照ください。権限を取得するには、Resource Access Management (RAM) コンソールの操作手順に従うこともできます。
FormatType	String	はい	いいえ	ダウンロードしたバックアップセットの変換先形式。	有効な値： CSV SQL Parquet
DownloadAddressDuration	Integer	いいえ	いいえ	TargetType が URL に設定されている場合の URL の有効期間。	有効な値：300 ～ 86400。単位：秒。デフォルト値：7200。

戻り値

Fn::GetAtt

InstanceName: インスタンス ID。
BakSetId: バックアップセットの ID。
DownloadAddressInfo: ダウンロードアドレスに関する情報。
TaskId: ダウンロードタスクの ID。

例

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BakSetId:
    Type: String
    Description:
      ja: |-
        バックアップセットの ID。DescribeBackups オペレーションを呼び出して、バックアップセットの ID をクエリできます。
        このパラメーターは、BakSetType パラメーターが full に設定されている場合に必須です。
    Default: 146005****
  InstanceName:
    Type: String
    Description:
      ja: インスタンスの ID。
    Default: rm-wz994c1t1****
  DownloadPointInTime:
    Type: String
    Description:
      ja: |-
        バックアップセットがダウンロードされる時点。
        1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプを指定します。
        このパラメーターは、BakSetType パラメーターが pitr に設定されている場合に必須です。
    Default: '1661331864000'
  BakSetType:
    Type: String
    Description:
      ja: |-
        ダウンロードタスクのタイプ。有効な値：
        full: 完全バックアップセットをダウンロードします
        pitr: 特定の時点のバックアップセットをダウンロードします
    Default: full
  BakSetSize:
    Type: String
    Description:
      ja: |-
        完全バックアップセットのサイズ。単位：バイト。
        DescribeBackups オペレーションを呼び出して、完全バックアップセットのサイズをクエリできます。
    Default: 216****
  TargetPath:
    Type: String
    Description:
      ja: |-
        バックアップセットのダウンロード先のパス。
        このパラメーターは、TargetType パラメーターが OSS に設定されている場合に必須です。
    Default: test_db/path
  TargetType:
    Type: String
    Description:
      ja: |-
        バックアップセットのダウンロード先のタイプ。
        有効な値：OSS|URL
    Default: OSS
  TargetOssRegion:
    Type: String
    Description:
      ja: |-
        OSS バケットが存在するリージョン。
        このパラメーターは、TargetType パラメーターが OSS に設定されている場合に必須です。
    Default: cn-beijing
  DeleteBackupSetInOss:
    Type: Boolean
    Description:
      ja: |-
        スタックの削除時に OSS のバックアップセットを削除するかどうか。
        有効な値：true|false、デフォルトは true です。
    Default: true
  TargetBucket:
    Type: String
    Description:
      ja: |-
        バックアップセットの格納に使用する OSS バケットの名前。
        このパラメーターは、TargetType パラメーターが OSS に設定されている場合に必須です。
        アカウントに AliyunDBSDefaultRole 権限が付与されていることを確認してください。
        詳細については、「RAM を使用したリソース承認」をご参照ください。
        Resource Access Management (RAM) コンソールの操作手順に基づいて権限を付与することもできます。
    Default: test123
  FormatType:
    Type: String
    Description:
      ja: |-
        ダウンロードしたバックアップセットの変換先形式。
        有効な値：CSV|SQL|Parquet
    Default: CSV
  DownloadAddressDuration:
    Type: Number
    Description:
      ja: |-
        ダウンロードターゲットが URL の場合、リンクの有効期間を設定します。
        デフォルトの URL 有効期間は 7200 秒です。
        有効期間の範囲は 300 秒から 86400 秒に設定できます
    MinValue: 300
    MaxValue: 86400
    Default: 2700
Resources:
  Download:
    Type: ALIYUN::DBS::Download
    Properties:
      BakSetId:
        Ref: BakSetId
      InstanceName:
        Ref: InstanceName
      DownloadPointInTime:
        Ref: DownloadPointInTime
      BakSetType:
        Ref: BakSetType
      BakSetSize:
        Ref: BakSetSize
      TargetPath:
        Ref: TargetPath
      TargetType:
        Ref: TargetType
      TargetOssRegion:
        Ref: TargetOssRegion
      DeleteBackupSetInOss:
        Ref: DeleteBackupSetInOss
      TargetBucket:
        Ref: TargetBucket
      FormatType:
        Ref: FormatType
      DownloadAddressDuration:
        Ref: DownloadAddressDuration
Outputs:
  InstanceName:
    Description: インスタンスの ID。
    Value:
      Fn::GetAtt:
        - Download
        - InstanceName
  BakSetId:
    Description: バックアップセットの ID。
    Value:
      Fn::GetAtt:
        - Download
        - BakSetId
  DownloadAddressInfo:
    Description: ダウンロードアドレス情報。
    Value:
      Fn::GetAtt:
        - Download
        - DownloadAddressInfo
  TaskId:
    Description: ダウンロードタスクの ID。
    Value:
      Fn::GetAtt:
        - Download
        - TaskId

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BakSetId": {
      "Type": "String",
      "Description": {
        "ja": "バックアップセットの ID。DescribeBackups オペレーションを呼び出して、バックアップセットの ID をクエリできます。\nこのパラメーターは、BakSetType パラメーターが full に設定されている場合に必須です。"
      },
      "Default": "146005****"
    },
    "InstanceName": {
      "Type": "String",
      "Description": {
        "ja": "インスタンスの ID。"
      },
      "Default": "rm-wz994c1t1****"
    },
    "DownloadPointInTime": {
      "Type": "String",
      "Description": {
        "ja": "バックアップセットがダウンロードされる時点。\n1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプを指定します。\nこのパラメーターは、BakSetType パラメーターが pitr に設定されている場合に必須です。"
      },
      "Default": "1661331864000"
    },
    "BakSetType": {
      "Type": "String",
      "Description": {
        "ja": "ダウンロードタスクのタイプ。有効な値：\nfull: 完全バックアップセットをダウンロードします\npitr: 特定の時点のバックアップセットをダウンロードします"
      },
      "Default": "full"
    },
    "BakSetSize": {
      "Type": "String",
      "Description": {
        "ja": "完全バックアップセットのサイズ。単位：バイト。\nDescribeBackups オペレーションを呼び出して、完全バックアップセットのサイズをクエリできます。"
      },
      "Default": "216****"
    },
    "TargetPath": {
      "Type": "String",
      "Description": {
        "ja": "バックアップセットのダウンロード先のパス。\nこのパラメーターは、TargetType パラメーターが OSS に設定されている場合に必須です。"
      },
      "Default": "test_db/path"
    },
    "TargetType": {
      "Type": "String",
      "Description": {
        "ja": "バックアップセットのダウンロード先のタイプ。\n有効な値：OSS|URL"
      },
      "Default": "OSS"
    },
    "TargetOssRegion": {
      "Type": "String",
      "Description": {
        "ja": "OSS バケットが存在するリージョン。\nこのパラメーターは、TargetType パラメーターが OSS に設定されている場合に必須です。"
      },
      "Default": "cn-beijing"
    },
    "DeleteBackupSetInOss": {
      "Type": "Boolean",
      "Description": {
        "ja": "スタックの削除時に OSS のバックアップセットを削除するかどうか。\n有効な値：true|false、デフォルトは true です。"
      },
      "Default": true
    },
    "TargetBucket": {
      "Type": "String",
      "Description": {
        "ja": "バックアップセットの格納に使用する OSS バケットの名前。\nこのパラメーターは、TargetType パラメーターが OSS に設定されている場合に必須です。\nアカウントに AliyunDBSDefaultRole 権限が付与されていることを確認してください。\n詳細については、「RAM を使用したリソース承認」をご参照ください。\nResource Access Management (RAM) コンソールの操作手順に基づいて権限を付与することもできます。"
      },
      "Default": "test123"
    },
    "FormatType": {
      "Type": "String",
      "Description": {
        "ja": "ダウンロードしたバックアップセットの変換先形式。\n有効な値：CSV|SQL|Parquet"
      },
      "Default": "CSV"
    },
    "DownloadAddressDuration": {
      "Type": "Number",
      "Description": {
        "ja": "ダウンロードターゲットが URL の場合、リンクの有効期間を設定します。\nデフォルトの URL 有効期間は 7200 秒です。\n有効期間の範囲は 300 秒から 86400 秒に設定できます"
      },
      "MinValue": 300,
      "MaxValue": 86400,
      "Default": 2700
    }
  },
  "Resources": {
    "Download": {
      "Type": "ALIYUN::DBS::Download",
      "Properties": {
        "BakSetId": {
          "Ref": "BakSetId"
        },
        "InstanceName": {
          "Ref": "InstanceName"
        },
        "DownloadPointInTime": {
          "Ref": "DownloadPointInTime"
        },
        "BakSetType": {
          "Ref": "BakSetType"
        },
        "BakSetSize": {
          "Ref": "BakSetSize"
        },
        "TargetPath": {
          "Ref": "TargetPath"
        },
        "TargetType": {
          "Ref": "TargetType"
        },
        "TargetOssRegion": {
          "Ref": "TargetOssRegion"
        },
        "DeleteBackupSetInOss": {
          "Ref": "DeleteBackupSetInOss"
        },
        "TargetBucket": {
          "Ref": "TargetBucket"
        },
        "FormatType": {
          "Ref": "FormatType"
        },
        "DownloadAddressDuration": {
          "Ref": "DownloadAddressDuration"
        }
      }
    }
  },
  "Outputs": {
    "InstanceName": {
      "Description": "インスタンスの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Download",
          "InstanceName"
        ]
      }
    },
    "BakSetId": {
      "Description": "バックアップセットの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Download",
          "BakSetId"
        ]
      }
    },
    "DownloadAddressInfo": {
      "Description": "ダウンロードアドレス情報。",
      "Value": {
        "Fn::GetAtt": [
          "Download",
          "DownloadAddressInfo"
        ]
      }
    },
    "TaskId": {
      "Description": "ダウンロードタスクの ID。",
      "Value": {
        "Fn::GetAtt": [
          "Download",
          "TaskId"
        ]
      }
    }
  }
}