ALIYUN::ECS::AutoSnapshotPolicy用于创建自动快照策略。

语法

{
  "Type" : "ALIYUN::ECS::AutoSnapshotPolicy",
  "Properties" : {
    "TimePoints" : String,
    "RepeatWeekdays" : String,
    "RetentionDays" : Integer,
    "DiskIds" : List,
    "AutoSnapshotPolicyName" : String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
TimePoints List 自动快照的创建时间点。 取值范围:0~23。表示00:00至23:00共24个时间点,例如1表示01:00。

单位:小时。

当一天内需要创建多次自动快照时,可以传入多个时间点:

  • 最多传入24个时间点。
  • 多个时间点用格式为[0, 1, … 23]的列表表示,时间点之间用英文逗号(,)隔开。
RepeatWeekdays List 自动快照的重复日期。 取值范围:1~7,例如1表示周一。

单位:天。

周期:星期。

当一星期内需要创建多次自动快照时,可以传入多个时间点:

  • 最多传入7个时间点。
  • 多个时间点用格式为[1, 2, … 7]的列表表示,时间点之间用英文逗号(,)隔开。
RetentionDays Integer 自动快照的保留时间。

取值范围:

  • -1(默认值):永久保存。
  • 1~65,535:指定保存天数。

单位:天。

DiskIds List

目标磁盘ID。

当您需要将自动快照策略应用于多块磁盘时,多块磁盘ID用格式为["d-xxxxxxxxx", "d-yyyyyyyyy", … "d-zzzzzzzzz"]的列表表示,磁盘ID之间用英文逗号(,)隔开。
AutoSnapshotPolicyName String 自动快照策略的名称。 长度为2~128个字符。必须以英文字母或汉字开头,不能以http://https://开头。可包含英文字母、汉字、数字、半角冒号(:)、下划线(_)或短划线(-)。

默认值:空。

返回值

Fn::GetAtt

AutoSnapshotPolicyId:自动快照策略ID。

示例

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TimePoints": {
      "Type": "CommaDelimitedList",
      "Description": "The automatic snapshot creation schedule, and the unit of measurement is hour. Value range: [0, 23], which represents from 00:00 to 24:00, for example 1 indicates 01:00. When you want to schedule multiple automatic snapshot tasks for a disk in a day, you can set the TimePoints to an array.\nA maximum of 24 time points can be selected.\nThe format is a list of [0, 1, ..., 23] and the time points are separated by commas (,)."
    },
    "DiskIds": {
      "Type": "Json",
      "Description": "The disk ID. When you want to apply the automatic snapshot policy to multiple disks, you can set the DiskIds to an array. The format is list of [\"d-xxxxxxxxx\", \"d-yyyyyyyyy\", ..., \"d-zzzzzzzzz\"] and the IDs are separated by commas (,)."
    },
    "RetentionDays": {
      "Type": "Number",
      "Description": "The snapshot retention time, and the unit of measurement is day. Optional values:\n-1: The automatic snapshots are retained permanently.\n[1, 65536]: The number of days retained.\nDefault value: -1.",
      "MinValue": -1,
      "MaxValue": 65536
    },
    "RepeatWeekdays": {
      "Type": "Json",
      "Description": "The automatic snapshot repetition dates. The unit of measurement is day and the repeating cycle is a week. Value range: [1, 7], which represents days starting from Monday to Sunday, for example 1 indicates Monday. When you want to schedule multiple automatic snapshot tasks for a disk in a week, you can set the RepeatWeekdays to an array.\nA maximum of seven time points can be selected.\nThe format is a list of [1, 2, ..., 7] and the time points are separated by commas (,)."
    },
    "AutoSnapshotPolicyName": {
      "Type": "String",
      "Description": "The name of the automatic snapshot policy.\nIt can consist of [2, 128] English or Chinese characters.\nMust begin with an uppercase or lowercase letter or a Chinese character. Can contain numbers, periods (.), colons (:), underscores (_), and hyphens (-).\nCannot start with http:// or https://.\nDefault value: null."
    }
  },
  "Resources": {
    "AutoSnapshotPolicy": {
      "Type": "ALIYUN::ECS::AutoSnapshotPolicy",
      "Properties": {
        "TimePoints": {
          "Ref": "TimePoints"
        },
        "DiskIds": {
          "Ref": "DiskIds"
        },
        "RetentionDays": {
          "Ref": "RetentionDays"
        },
        "RepeatWeekdays": {
          "Ref": "RepeatWeekdays"
        },
        "AutoSnapshotPolicyName": {
          "Ref": "AutoSnapshotPolicyName"
        }
      }
    }
  },
  "Outputs": {
    "AutoSnapshotPolicyId": {
      "Description": "The automatic snapshot policy ID.",
      "Value": {
        "Fn::GetAtt": [
          "AutoSnapshotPolicy",
          "AutoSnapshotPolicyId"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TimePoints:
    Type: CommaDelimitedList
    Description: >-
      The automatic snapshot creation schedule, and the unit of measurement is
      hour. Value range: [0, 23], which represents from 00:00 to 24:00, for
      example 1 indicates 01:00. When you want to schedule multiple automatic
      snapshot tasks for a disk in a day, you can set the TimePoints to an
      array.

      A maximum of 24 time points can be selected.

      The format is a list of [0, 1, ..., 23] and the time points are separated
      by commas (,).
  DiskIds:
    Type: Json
    Description: >-
      The disk ID. When you want to apply the automatic snapshot policy to
      multiple disks, you can set the DiskIds to an array. The format is list of
      ["d-xxxxxxxxx", "d-yyyyyyyyy", ..., "d-zzzzzzzzz"] and the IDs are
      separated by commas (,).
  RetentionDays:
    Type: Number
    Description: >-
      The snapshot retention time, and the unit of measurement is day. Optional
      values:

      -1: The automatic snapshots are retained permanently.

      [1, 65536]: The number of days retained.

      Default value: -1.
    MinValue: -1
    MaxValue: 65536
  RepeatWeekdays:
    Type: Json
    Description: >-
      The automatic snapshot repetition dates. The unit of measurement is day
      and the repeating cycle is a week. Value range: [1, 7], which represents
      days starting from Monday to Sunday, for example 1 indicates Monday. When
      you want to schedule multiple automatic snapshot tasks for a disk in a
      week, you can set the RepeatWeekdays to an array.

      A maximum of seven time points can be selected.

      The format is a list of [1, 2, ..., 7] and the time points are separated
      by commas (,).
  AutoSnapshotPolicyName:
    Type: String
    Description: >-
      The name of the automatic snapshot policy.

      It can consist of [2, 128] English or Chinese characters.

      Must begin with an uppercase or lowercase letter or a Chinese character.
      Can contain numbers, periods (.), colons (:), underscores (_), and hyphens
      (-).

      Cannot start with http:// or https://.

      Default value: null.
Resources:
  AutoSnapshotPolicy:
    Type: 'ALIYUN::ECS::AutoSnapshotPolicy'
    Properties:
      TimePoints:
        Ref: TimePoints
      DiskIds:
        Ref: DiskIds
      RetentionDays:
        Ref: RetentionDays
      RepeatWeekdays:
        Ref: RepeatWeekdays
      AutoSnapshotPolicyName:
        Ref: AutoSnapshotPolicyName
Outputs:
  AutoSnapshotPolicyId:
    Description: The automatic snapshot policy ID.
    Value:
      'Fn::GetAtt':
        - AutoSnapshotPolicy
        - AutoSnapshotPolicyId