ALIYUN::ECS::Snapshot is used to create a disk Snapshot.

Statement

{
  "Type": "ALIYUN::ECS::Snapshot",
  "Properties": {
    "SnapshotName": String,
    "Timeout": Integer,
    "Description": String,
    "DiskId": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
DiskId String No No The ID of the disk for which you want to create the snapshot. None
SnapshotName String Yes Released The name of the snapshot. It must be 2 to 128 characters in length. And can contain letters, digits, underscores (_), and hyphens (-). It cannot start with auto. Snapshot names starting with auto are reserved for automatic snapshots. It cannot start with http:// or https://.
Timeout String Optional Released The timeout period that is specified for the snapshot creation request. If this parameter is set, the timeout period to create a resource stack is prolonged. If the snapshot is not created within the specified time period, the entire resource stack fails to be created. You must set the timeout period according to the disk size and data amount. Valid values: 200 to 1440. Unit: minute. The default value is 200 minutes.
Description String Yes Released The description of the snapshot. The length must be 2 to 256 characters in length. This parameter is empty by default. It cannot start with http:// or https://.

Response parameters

Fn::GetAtt

SnapshotId: the ID of the snapshot.

Sample request

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Snapshot": {
      "Type": "ALIYUN::ECS::Snapshot",
      "Properties": {
        "DiskId": "d-2zedgvuvu8cylvrd****"
      }
    }
  },
  "Outputs": {
    "SnapshotId": {
      "Value": {
        "Fn::GetAtt": [
          "Snapshot",
          "SnapshotId"
        ]
      }
    }
  }
}