ALIYUN::ECS::AutoSnapshotPolicy is used to create an automatic snapshot policy.
Syntax
{
"Type" : "ALIYUN::ECS::AutoSnapshotPolicy",
"Properties" : {
"TimePoints" : String,
"RepeatWeekdays" : String,
"RetentionDays" : Integer,
"DiskIds" : List,
"Tags": List,
"AutoSnapshotPolicyName" : String,
"ResourceGroupId": String
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
TimePoints | List | Yes | Yes | The points in time of a day at which to create automatic snapshots. | Valid values: 0 to 23. The values from 0 to 23 indicate the 24 points in time on the
hour from 00:00 to 23:00. For example, 1 indicates 01:00.
Unit: hours. If you need automatic snapshots to be created at several times in a day, you can specify multiple hours.
|
RepeatWeekdays | List | Yes | Yes | The days of a week on which to create automatic snapshots. | Valid values: 1 to 7. The values from 1 to 7 indicate the seven days in a week from
Monday to Sunday.
Cycle: week. If you need automatic snapshots to be created at several times in a week, you can specify multiple days. You must set this property to a list. Example: [1, 2, ... 7]. Separate multiple days with commas (,). You can specify up to seven days. |
RetentionDays | Integer | Yes | Yes | The number of days for which the system retains automatic snapshots. |
Default value: -1. Valid values:
Unit: days. |
DiskIds | List | No | Yes |
The IDs of disks to which you want to apply the automatic snapshot policy. |
If you need to apply the automatic snapshot policy to multiple disks, you must set this property to a list in the ["d-xxxxxxxxx", "d-yyyyyyyyy", … "d-zzzzzzzzz"] format. Separate multiple IDs with commas (,). |
ResourceGroupId | String | No | Yes | The ID of the resource group to which the automatic snapshot policy belongs. | None |
Tags | List | No | Yes | The tags of the automatic snapshot policy. | You can add up to 20 tags.
For more information, see Tags properties. |
AutoSnapshotPolicyName | String | No | Yes | The name of the automatic snapshot policy. | The name must be 2 to 128 characters in length, and can contain letters, digits, colons
(:), underscores (_), and hyphens (-). The name must start with a letter but cannot
start with http:// or https:// .
By default, this property is empty. |
Tags syntax
"Tags": [
{
"Key": String,
"Value": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
---|---|---|---|---|---|
Key | String | Yes | No | The key of the tag. | The tag key must be 1 to 128 characters in length, and cannot contain http:// or https:// . The tag key cannot start with aliyun or acs: .
|
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length, and cannot contain http:// or https:// . The tag value cannot start with aliyun or acs: .
|
Return value
Fn::GetAtt
AutoSnapshotPolicyId: the ID of the automatic snapshot policy.
Examples
JSON
format
{
"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."
},
"Tags": {
"Type": "Json",
"Description": "Tags to attach to instance. Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.",
"MaxLength": 20
}
},
"Resources": {
"AutoSnapshotPolicy": {
"Type": "ALIYUN::ECS::AutoSnapshotPolicy",
"Properties": {
"TimePoints": {
"Ref": "TimePoints"
},
"DiskIds": {
"Ref": "DiskIds"
},
"RetentionDays": {
"Ref": "RetentionDays"
},
"RepeatWeekdays": {
"Ref": "RepeatWeekdays"
},
"AutoSnapshotPolicyName": {
"Ref": "AutoSnapshotPolicyName"
},
"Tags": {
"Ref": "Tags"
}
}
}
},
"Outputs": {
"AutoSnapshotPolicyId": {
"Description": "The automatic snapshot policy ID.",
"Value": {
"Fn::GetAtt": [
"AutoSnapshotPolicy",
"AutoSnapshotPolicyId"
]
}
}
}
}
YAML
format
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
AutoSnapshotPolicyName:
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.'
Type: String
DiskIds:
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 (,).
Type: Json
RepeatWeekdays:
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 (,).'
Type: Json
RetentionDays:
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.'
MaxValue: 65536
MinValue: -1
Type: Number
Tags:
Description: Tags to attach to instance. Max support 20 tags to add during create
instance. Each tag with two properties Key and Value, and Key is required.
MaxLength: 20
Type: Json
TimePoints:
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 (,).'
Type: CommaDelimitedList
Resources:
AutoSnapshotPolicy:
Properties:
AutoSnapshotPolicyName:
Ref: AutoSnapshotPolicyName
DiskIds:
Ref: DiskIds
RepeatWeekdays:
Ref: RepeatWeekdays
RetentionDays:
Ref: RetentionDays
Tags:
Ref: Tags
TimePoints:
Ref: TimePoints
Type: ALIYUN::ECS::AutoSnapshotPolicy
Outputs:
AutoSnapshotPolicyId:
Description: The automatic snapshot policy ID.
Value:
Fn::GetAtt:
- AutoSnapshotPolicy
- AutoSnapshotPolicyId
For more examples, visit AutoSnapshotPolicy.json and AutoSnapshotPolicy.yml.