ALIYUN::ADB::BackupPolicy - Resource Orchestration Service

The ALIYUN::ADB::BackupPolicy resource creates a backup policy.

Syntax

{
  "Type": "ALIYUN::ADB::BackupPolicy",
  "Properties": {
    "DBClusterId": String,
    "PreferredBackupPeriod": List,
    "PreferredBackupTime": String,
    "BackupRetentionPeriod": Integer,
    "EnableBackupLog": String,
    "LogBackupRetentionPeriod": Integer
  }
}

Properties

Property name	Type	Required	Update allowed	Description	Constraints
DBClusterId	String	Yes	No	The ID of the ADB instance.	None
PreferredBackupPeriod	List	Yes	Yes	Data backup cycles	Valid values: Monday : Monday. Tuesday: Tuesday. Wednesday Thursday Friday: Friday. Saturday: Saturday Sunday
PreferredBackupTime	String	Yes	Yes	The time range for data backups.	The time is in UTC. Format: HH:mmZ-HH:mmZ.
BackupRetentionPeriod	Integer	No	Yes	The number of days to retain data backups.	Valid values: 7 to 730.
EnableBackupLog	String	No	Yes	Specifies whether to enable incremental log backups.	Valid values: true: Enabled false: Disabled
LogBackupRetentionPeriod	Integer	No	Yes	The number of days to retain log backups.	Valid values: 7 to 730.

Return values

Fn::GetAtt

None

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PreferredBackupPeriod:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        AllowedValues:
          - Monday
          - Tuesday
          - Wednesday
          - Thursday
          - Friday
          - Saturday
          - Sunday
        Required: false
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: 'The preferred backup period. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.'
    Required: true
    MinLength: 1
    MaxLength: 7
  PreferredBackupTime:
    Type: String
    Description:
      en: 'The preferred backup time. Format: HH:mmZ-HH:mmZ. Example: 02:00Z-03:00Z'
    Required: true
  DBClusterId:
    Type: String
    Description:
      en: The ID of the ADB cluster.
    Required: true
Resources:
  BackupPolicy:
    Type: ALIYUN::ADB::BackupPolicy
    Properties:
      PreferredBackupPeriod:
        Ref: PreferredBackupPeriod
      PreferredBackupTime:
        Ref: PreferredBackupTime
      DBClusterId:
        Ref: DBClusterId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PreferredBackupPeriod": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "AllowedValues": [
            "Monday",
            "Tuesday",
            "Wednesday",
            "Thursday",
            "Friday",
            "Saturday",
            "Sunday"
          ],
          "Required": false
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "The preferred backup period. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday."
      },
      "Required": true,
      "MinLength": 1,
      "MaxLength": 7
    },
    "PreferredBackupTime": {
      "Type": "String",
      "Description": {
        "en": "The preferred backup time. Format: HH:mmZ-HH:mmZ. Example: 02:00Z-03:00Z"
      },
      "Required": true
    },
    "DBClusterId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the ADB cluster."
      },
      "Required": true
    }
  },
  "Resources": {
    "BackupPolicy": {
      "Type": "ALIYUN::ADB::BackupPolicy",
      "Properties": {
        "PreferredBackupPeriod": {
          "Ref": "PreferredBackupPeriod"
        },
        "PreferredBackupTime": {
          "Ref": "PreferredBackupTime"
        },
        "DBClusterId": {
          "Ref": "DBClusterId"
        }
      }
    }
  }
}