The ALIYUN::HBR::NasBackupPlan resource creates a NAS backup plan.
Syntax
{
"Type": "ALIYUN::HBR::NasBackupPlan",
"Properties": {
"BackupType": String,
"FileSystemId": String,
"Paths": List,
"PlanName": String,
"Retention": Integer,
"Schedule": String,
"VaultId": String,
"CrossAccountUserId": String,
"CrossAccountRoleName": String,
"CrossAccountType": String,
"Disabled": Boolean,
"Options": Map
}
}Properties
Parameter | Type | Required | Editable | Description | Constraints |
BackupType | String | Yes | No | The backup type. | Valid values:
|
FileSystemId | String | Yes | No | The ID of the file system. | None |
Paths | List | Yes | Yes | The paths to include in the backup plan. | Length: 1–20 |
PlanName | String | Yes | Yes | The name of the backup plan. | The name must be 1 to 64 characters in length. The name must be unique for each data source type within a single backup vault. |
Retention | Integer | Yes | Yes | The number of days to retain backups. | Minimum: 1 |
Schedule | String | Yes | Yes | The backup strategy. | The format is
|
VaultId | String | Yes | Yes | The ID of the backup vault. | None |
CrossAccountRoleName | String | No | No | The name of the RAM role created in the source account for cross-account backup. The current account assumes this role to perform backups. | None |
CrossAccountType | String | No | No | The type of cross-account backup. | Valid values:
|
CrossAccountUserId | String | No | No | The ID of the source account that owns the resource to be backed up. | None |
Disabled | Boolean | No | No | Specifies whether to disable the backup task. | None |
Options | Map | No | Yes | Specifies whether to use Windows Volume Shadow Copy Service (VSS) to back up the specified paths. | None |
Outputs
Fn::GetAtt
PlanId: The ID of the backup plan.
Example
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
Options:
Type: Json
Description:
en: Specifies whether to use Windows Volume Shadow Copy Service (VSS) to back up the specified paths.
Required: false
CrossAccountUserId:
Type: String
Description:
en: The ID of the source account that owns the resource to be backed up.
Required: false
CrossAccountRoleName:
Type: String
Description:
en: The name of the RAM role created in the source account for cross-account backup. The current account assumes this role to perform backups.
Required: false
Schedule:
Type: String
Description:
en: 'The backup strategy. The format is `I|{startTime}|{interval}`. This format defines a recurring backup task that starts at `{startTime}` and runs at the specified `{interval}`. Backup tasks for missed schedules are not run retroactively. If a backup task is still running, the next scheduled task is skipped.'
Required: true
CrossAccountType:
Type: String
Description:
en: 'The type of cross-account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.'
AllowedValues:
- SELF_ACCOUNT
- CROSS_ACCOUNT
Required: false
BackupType:
Type: String
Description:
en: 'The backup type. Valid values: COMPLETE.'
AllowedValues:
- COMPLETE
Required: true
FileSystemId:
Type: String
Description:
en: The ID of the file system.
Required: true
Paths:
AssociationPropertyMetadata:
Parameter:
Type: String
Required: false
Type: Json
AssociationProperty: List[Parameter]
Description:
en: The paths to include in the backup plan.
Required: true
MinLength: 1
MaxLength: 20
PlanName:
Type: String
Description:
en: The name of the backup plan. The name must be 1 to 64 characters in length. The name must be unique for each data source type within a single backup vault.
Required: true
MinLength: 1
MaxLength: 64
VaultId:
Type: String
Description:
en: The ID of the backup vault.
Required: true
Retention:
Type: Number
Description:
en: The number of days to retain backups. Minimum is 1.
Required: true
MinValue: 1
Disabled:
Type: Boolean
Description:
en: 'Specifies whether to disable the backup task. Valid values: true, false.'
Required: false
Resources:
NasBackupPlan:
Type: ALIYUN::HBR::NasBackupPlan
Properties:
Options:
Ref: Options
CrossAccountUserId:
Ref: CrossAccountUserId
CrossAccountRoleName:
Ref: CrossAccountRoleName
Schedule:
Ref: Schedule
CrossAccountType:
Ref: CrossAccountType
BackupType:
Ref: BackupType
FileSystemId:
Ref: FileSystemId
Paths:
Ref: Paths
PlanName:
Ref: PlanName
VaultId:
Ref: VaultId
Retention:
Ref: Retention
Disabled:
Ref: Disabled
Outputs:
PlanId:
Description: The ID of the backup plan.
Value:
Fn::GetAtt:
- NasBackupPlan
- PlanId
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"Options": {
"Type": "Json",
"Description": {
"en": "Specifies whether to use Windows Volume Shadow Copy Service (VSS) to back up the specified paths."
},
"Required": false
},
"CrossAccountUserId": {
"Type": "String",
"Description": {
"en": "The ID of the source account that owns the resource to be backed up."
},
"Required": false
},
"CrossAccountRoleName": {
"Type": "String",
"Description": {
"en": "The name of the RAM role created in the source account for cross-account backup. The current account assumes this role to perform backups."
},
"Required": false
},
"Schedule": {
"Type": "String",
"Description": {
"en": "The backup strategy. The format is `I|{startTime}|{interval}`. This format defines a recurring backup task that starts at `{startTime}` and runs at the specified `{interval}`. Backup tasks for missed schedules are not run retroactively. If a backup task is still running, the next scheduled task is skipped."
},
"Required": true
},
"CrossAccountType": {
"Type": "String",
"Description": {
"en": "The type of cross-account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT."
},
"AllowedValues": [
"SELF_ACCOUNT",
"CROSS_ACCOUNT"
],
"Required": false
},
"BackupType": {
"Type": "String",
"Description": {
"en": "The backup type. Valid values: COMPLETE."
},
"AllowedValues": [
"COMPLETE"
],
"Required": true
},
"FileSystemId": {
"Type": "String",
"Description": {
"en": "The ID of the file system."
},
"Required": true
},
"Paths": {
"AssociationPropertyMetadata": {
"Parameter": {
"Type": "String",
"Required": false
}
},
"Type": "Json",
"AssociationProperty": "List[Parameter]",
"Description": {
"en": "The paths to include in the backup plan."
},
"Required": true,
"MinLength": 1,
"MaxLength": 20
},
"PlanName": {
"Type": "String",
"Description": {
"en": "The name of the backup plan. The name must be 1 to 64 characters in length. The name must be unique for each data source type within a single backup vault."
},
"Required": true,
"MinLength": 1,
"MaxLength": 64
},
"VaultId": {
"Type": "String",
"Description": {
"en": "The ID of the backup vault."
},
"Required": true
},
"Retention": {
"Type": "Number",
"Description": {
"en": "The number of days to retain backups. Minimum is 1."
},
"Required": true,
"MinValue": 1
},
"Disabled": {
"Type": "Boolean",
"Description": {
"en": "Specifies whether to disable the backup task. Valid values: true, false."
},
"Required": false
}
},
"Resources": {
"NasBackupPlan": {
"Type": "ALIYUN::HBR::NasBackupPlan",
"Properties": {
"Options": {
"Ref": "Options"
},
"CrossAccountUserId": {
"Ref": "CrossAccountUserId"
},
"CrossAccountRoleName": {
"Ref": "CrossAccountRoleName"
},
"Schedule": {
"Ref": "Schedule"
},
"CrossAccountType": {
"Ref": "CrossAccountType"
},
"BackupType": {
"Ref": "BackupType"
},
"FileSystemId": {
"Ref": "FileSystemId"
},
"Paths": {
"Ref": "Paths"
},
"PlanName": {
"Ref": "PlanName"
},
"VaultId": {
"Ref": "VaultId"
},
"Retention": {
"Ref": "Retention"
},
"Disabled": {
"Ref": "Disabled"
}
}
}
},
"Outputs": {
"PlanId": {
"Description": "The ID of the backup plan.",
"Value": {
"Fn::GetAtt": [
"NasBackupPlan",
"PlanId"
]
}
}
}
}