全部產品
Search
文件中心

:ALIYUN::ECS::Snapshot

更新時間:Oct 24, 2024

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開頭。

Timeout

Integer

建立快照的逾時時間。

設定此時間會延長建立資源棧的逾時時間。如果快照在指定的時間內沒有建立完成,則整個資源棧將建立失敗。請根據磁碟的大小,資料的多少,設定合理的逾時時間。

取值範圍:200~1440。

預設值:200。

單位:分鐘。

Description

String

快照的描述。

快照的描述。長度為2~256個字元,不能以http://https://開頭。

預設值:空。

ResourceGroupId

String

磁碟快照所屬的資源群組ID。

Tags

List

標籤。

最多支援添加20個標籤。

更多資訊,請參見Tags屬性

InstantAccess

Boolean

是否開啟快照極速可用功能。

取值:

  • true:開啟。僅ESSD雲端硬碟支援開啟該功能。

  • false(預設值):關閉。即建立標準快照。

InstantAccessRetentionDays

Integer

設定快照極速可用功能的保留時間,保留時間到期後快照將自動釋放。

該參數僅在InstantAccess取值為true時生效。

取值範圍:1~65,535。

單位:天。

RetentionDays

Integer

設定快照的保留時間。

單位為天。保留時間到期後快照會被自動釋放。

取值範圍:1~65536。

預設值:空,表示快照不會被自動釋放。

Tags文法

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

Tags屬性

屬性名稱

類型

必須

允許更新

描述

約束

Key

String

標籤鍵。

長度為1~128個字元,不能以aliyunacs:開頭,不能包含http://或者https://

Value

String

標籤值。

長度為0~128個字元,不能以aliyunacs:開頭,不能包含http://或者https://

傳回值

Fn::GetAtt

SnapshotId:快照ID。

樣本

  • 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": "The snapshot ID.",
          "Value": {
            "Fn::GetAtt": [
              "Snapshot",
              "SnapshotId"
            ]
          }
        }
      }
    }

更多樣本,請參見掛載ECS磁碟和建立磁碟快照的組合樣本:YAML樣本