全部产品
Search
文档中心

资源编排:ALIYUN::ECS::Snapshot

更新时间:Aug 09, 2023

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磁盘和创建磁盘快照的组合示例:JSON示例YAML示例