ALIYUN::POLARDB::Backup - Resource Orchestration Service

ALIYUN::POLARDB::Backup is used to create a full snapshot backup for a PolarDB cluster.

Syntax

{
  "Type": "ALIYUN::POLARDB::Backup",
  "Properties": {
    "DBClusterId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
DBClusterId	String	Yes	No	The cluster ID.	None.

Return values

Fn::GetAtt

DBClusterId: the cluster ID.
BackupJobId: the ID of the backup set.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DBClusterId:
    Type: String
    Description:
      en: The cluster ID.
    Required: true
    AssociationProperty: ALIYUN::POLARDB::DBCluster::DBClusterId
Resources:
  Backup:
    Type: ALIYUN::POLARDB::Backup
    Properties:
      DBClusterId:
        Ref: DBClusterId
Outputs:
  DBClusterId:
    Description: The ID of the cluster.
    Value:
      Fn::GetAtt:
        - Backup
        - DBClusterId
  BackupJobId:
    Description: The ID of the backup set.
    Value:
      Fn::GetAtt:
        - Backup
        - BackupJobId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DBClusterId": {
      "Type": "String",
      "Description": {
        "en": "The cluster ID."
      },
      "Required": true,
      "AssociationProperty": "ALIYUN::POLARDB::DBCluster::DBClusterId"
    }
  },
  "Resources": {
    "Backup": {
      "Type": "ALIYUN::POLARDB::Backup",
      "Properties": {
        "DBClusterId": {
          "Ref": "DBClusterId"
        }
      }
    }
  },
  "Outputs": {
    "DBClusterId": {
      "Description": "The ID of the cluster.",
      "Value": {
        "Fn::GetAtt": [
          "Backup",
          "DBClusterId"
        ]
      }
    },
    "BackupJobId": {
      "Description": "The ID of the backup set.",
      "Value": {
        "Fn::GetAtt": [
          "Backup",
          "BackupJobId"
        ]
      }
    }
  }
}