ALIYUN::HBR::NasBackupPlan-资源编排(ROS)-阿里云帮助中心

语法

{
  "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
  }
}

属性

属性名称	类型	必须	允许更新	描述	约束
BackupType	String	是	否	备份类型。	取值： COMPLETE
FileSystemId	String	是	否	文件系统的ID。	无
Paths	List	是	是	备份计划的路径。	长度范围：1-20
PlanName	String	是	是	备份计划的名称。	1~64个字符，单个仓库中每种数据源类型的备份计划名称必须唯一。
Retention	Integer	是	是	备份保留天数。	最小值：1
Schedule	String	是	是	备份策略。	可选格式：I\|{startTime}\|{interval}。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会执行已过去时间的备份任务。如果上一次备份任务没有完成，不会触发下一次备份任务。例如 I\|1631685600\|P1D 表示从 2021-09-15 14:00:00 开始每隔一天备份一次。 startTime：备份起始时间，UNIX 时间，单位为秒。 interval： ISO8601 时间间隔。例如：PT1H 表示间隔一小时。P1D 表示间隔一天。
VaultId	String	是	是	备份仓库的ID。	无
CrossAccountRoleName	String	否	否	当前账号管理的跨账号在原账号RAM备份中创建的角色名称。	无
CrossAccountType	String	否	否	跨账号备份的类型。	取值： SELF_ACCOUNT CROSS_ACCOUNT
CrossAccountUserId	String	否	否	当前账号管理的跨账号备份的原账号ID。	无
Disabled	Boolean	否	否	是否禁用备份任务。	无
Options	Map	否	是	此参数指定是否使用Windows VSS来定义备份路径。	无

返回值

Fn::GetAtt

PlanId：备份计划的ID。

示例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Options:
    Type: Json
    Description:
      en: This parameter specifies whether to use Windows VSS to define a backup path.
    Required: false
  CrossAccountUserId:
    Type: String
    Description:
      en: The original account ID of the cross account backup managed by the current account.
    Required: false
  CrossAccountRoleName:
    Type: String
    Description:
      en: The role name created in the original account RAM backup by the cross account managed by the current account.
    Required: false
  Schedule:
    Type: String
    Description:
      en: 'Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.'
    Required: true
  CrossAccountType:
    Type: String
    Description:
      en: 'The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.'
    AllowedValues:
      - SELF_ACCOUNT
      - CROSS_ACCOUNT
    Required: false
  BackupType:
    Type: String
    Description:
      en: '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 of the backup plan.
    Required: true
    MinLength: 1
    MaxLength: 20
  PlanName:
    Type: String
    Description:
      en: The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Required: true
    MinLength: 1
    MaxLength: 64
  VaultId:
    Type: String
    Description:
      en: The ID of backup vault.
    Required: true
  Retention:
    Type: Number
    Description:
      en: Backup retention days, the minimum is 1.
    Required: true
    MinValue: 1
  Disabled:
    Type: Boolean
    Description:
      en: '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

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Options": {
      "Type": "Json",
      "Description": {
        "en": "This parameter specifies whether to use Windows VSS to define a backup path."
      },
      "Required": false
    },
    "CrossAccountUserId": {
      "Type": "String",
      "Description": {
        "en": "The original account ID of the cross account backup managed by the current account."
      },
      "Required": false
    },
    "CrossAccountRoleName": {
      "Type": "String",
      "Description": {
        "en": "The role name created in the original account RAM backup by the cross account managed by the current account."
      },
      "Required": false
    },
    "Schedule": {
      "Type": "String",
      "Description": {
        "en": "Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered."
      },
      "Required": true
    },
    "CrossAccountType": {
      "Type": "String",
      "Description": {
        "en": "The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT."
      },
      "AllowedValues": [
        "SELF_ACCOUNT",
        "CROSS_ACCOUNT"
      ],
      "Required": false
    },
    "BackupType": {
      "Type": "String",
      "Description": {
        "en": "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 of the backup plan."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 20
    },
    "PlanName": {
      "Type": "String",
      "Description": {
        "en": "The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 64
    },
    "VaultId": {
      "Type": "String",
      "Description": {
        "en": "The ID of backup vault."
      },
      "Required": true
    },
    "Retention": {
      "Type": "Number",
      "Description": {
        "en": "Backup retention days, the minimum is 1."
      },
      "Required": true,
      "MinValue": 1
    },
    "Disabled": {
      "Type": "Boolean",
      "Description": {
        "en": "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"
        ]
      }
    }
  }
}