ディスクスナップショットを作成するための ALIYUN::ECS::Snapshot の使用方法 - Resource Orchestration Service

ALIYUN::ECS::Snapshot は、ディスクのスナップショットを作成するために使用されます。

構文

{
  "Type": "ALIYUN::ECS::Snapshot",
  "Properties": {
    "SnapshotName": String,
    "Timeout": Integer,
    "Description": String,
    "DiskId": String,
    "Tags": List,
    "InstantAccess": Boolean,
    "InstantAccessRetentionDays": Integer,
    "ResourceGroupId": String,
    "RetentionDays": Integer
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DiskId	String	はい	いいえ	スナップショットを作成するディスクの ID。	なし。
SnapshotName	String	いいえ	いいえ	スナップショット名。	名前は 2 ～ 128 文字の長さでなければなりません。文字で始まり、`http://` または `https://` で始めることはできません。文字、数字、コロン（:）、アンダースコア（_）、ハイフン（-）を含めることができます。 auto で始まるスナップショットは自動スナップショットとして認識されるため、名前を auto で始めることはできません。
Timeout	Integer	いいえ	いいえ	スナップショットを作成するためのタイムアウト期間。	このプロパティを指定すると、スタック作成のタイムアウト期間が延長されます。指定されたタイムアウト期間内にスナップショットが作成されない場合、スタックの作成は失敗します。ディスクサイズとデータサイズに基づいてこのプロパティを指定できます。有効な値：200 ～ 1440。デフォルト値：200。単位：分。
Description	String	いいえ	いいえ	スナップショットの説明。	説明は 2 ～ 256 文字の長さでなければならず、`http://` または `https://` で始めることはできません。このプロパティはデフォルトでは空です。
ResourceGroupId	String	いいえ	はい	スナップショットが属するリソースグループの ID。	なし。
Tags	List	いいえ	はい	タグ。	最大 20 個のタグを追加できます。詳細については、「タグのプロパティ」をご参照ください。
InstantAccess	Boolean	いいえ	いいえ	スナップショットのインスタントアクセス機能を有効にするかどうかを指定します。	有効な値： true：スナップショットのインスタントアクセス機能を有効にします。この機能は、企業向け SSD（ESSD）に対してのみ有効にできます。 false（デフォルト）：スナップショットのインスタントアクセス機能を無効にします。作成されたスナップショットは標準スナップショットです。
InstantAccessRetentionDays	Integer	いいえ	いいえ	インスタントアクセス機能の保持期間。保持期間が終了すると、スナップショットは自動的に解放されます。	このプロパティは、InstantAccess が true に設定されている場合にのみ有効になります。有効な値：1 ～ 65535。単位：日。
RetentionDays	Integer	いいえ	いいえ	スナップショットの保持期間。	単位：日。保持期間が終了すると、スナップショットは自動的に解放されます。有効な値：1 ～ 65536。このプロパティはデフォルトでは空で、スナップショットが自動的に解放されないことを示します。

タグの構文

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

タグのプロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Key	String	はい	いいえ	タグキー。	タグキーは 1 ～ 128 文字の長さでなければならず、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。
Value	String	いいえ	いいえ	タグ値。	タグ値は最大 128 文字の長さで、`http://` または `https://` を含めることはできません。`aliyun` または `acs:` で始めることはできません。

戻り値

Fn::GetAtt

SnapshotId：スナップショット ID。
Arn：Alibaba Cloud リソースネーム (ARN)。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DiskId:
    Type: String
    AssociationProperty: ALIYUN::ECS::Disk::DiskId
Resources:
  Snapshot:
    Type: ALIYUN::ECS::Snapshot
    Properties:
      Timeout: 300
      DiskId:
        Ref: DiskId
Outputs:
  SnapshotId:
    Description: The snapshot ID.
    Value:
      Fn::GetAtt:
        - Snapshot
        - SnapshotId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DiskId": {
      "Type": "String",
      "AssociationProperty": "ALIYUN::ECS::Disk::DiskId"
    }
  },
  "Resources": {
    "Snapshot": {
      "Type": "ALIYUN::ECS::Snapshot",
      "Properties": {
        "Timeout": 300,
        "DiskId": {
          "Ref": "DiskId"
        }
      }
    }
  },
  "Outputs": {
    "SnapshotId": {
      "Description": "スナップショット ID。",
      "Value": {
        "Fn::GetAtt": [
          "Snapshot",
          "SnapshotId"
        ]
      }
    }
  }
}

その他の例については、auto-snapshot-policy.yml をご覧ください。例では、ALIYUN::ECS::DiskAttachment リソースタイプと ALIYUN::ECS::Snapshot リソースタイプが使用されています。