edit-icon download-icon

ALIYUN::ECS::Snapshot

Last Updated: Jun 13, 2018

Description

Creates a disk snapshot.

Syntax

  1. {
  2. "Type" : "ALIYUN::ECS::Snapshot",
  3. "Properties" : {
  4. "SnapshotName" : String,
  5. "Timeout" : Integer,
  6. "Description" : String,
  7. "DiskId" : String
  8. }
  9. }

Properties

Name Type Required Description Constraints
DiskId String Yes The ID of the disk to create a disk snapshot. N/A
SnapshotName String No The name of the snapshot. - It can contain 2 to 128 characters and must start with an uppercase or lowercase letter.
- It can contain English letters, numbers, underscores(_), and hyphens(-).
- It cannot start with “auto” (snapshot names starting with “auto” are automatic snapshots).
- It cannot start with http:// or https://.
Timeout Integer No The length of time that ROS waits for the creation to be completed. - Setting this parameter extends the timeout for creating the entire resource stack. If the snapshot is not created within the specified time, the entire resource stack cannot be created. Therefore, you must set this parameter appropriately, based on the disk size and the data amount.
- Value range: [200, 1440]; unit: minute; default value: 200.
Description String No Snapshot description. It can contain 2 to 256 characters. Default value: null. It cannot start with http:// or https://.

Return values

Fn::GetAtt

SnapshotId: The ID of the snapshot.

Example

  1. {
  2. "ROSTemplateFormatVersion" : "2015-09-01",
  3. "Resources" : {
  4. "Snapshot": {
  5. "Type": "ALIYUN::ECS::Snapshot",
  6. "Properties": {
  7. "DiskId" : "d-2zedgvuvu8cylvrdlfv2"
  8. }
  9. }
  10. },
  11. "Outputs": {
  12. "SnapshotId": {
  13. "Value" : {"Fn::GetAtt": ["Snapshot","SnapshotId"]}
  14. }
  15. }
  16. }
Thank you! We've received your feedback.