Use ALIYUN::HBR::DbVault to create a backup vault - Resource Orchestration Service

Syntax

{
  "Type": "ALIYUN::HBR::DbVault",
  "Properties": {
    "Description": String,
    "VaultName": String,
    "RetentionDays": Integer,
    "VaultRegionId": String,
    "Tags": List
  }
}

Properties

Property name	Type	Required	Allow updates	Description	Constraints
Description	String	No	No	The description of the vault.	None
VaultName	String	Yes	No	The name of the vault.	None
RetentionDays	Integer	Yes	Yes	The backup retention period, in days.	None
VaultRegionId	String	Yes	No	The region ID of the vault.	The vault must be in a region that supports Cloud Backup. For more information, see Available regions.
Tags	List	No	Yes	The tags of the resource.	For more information, see the Tags property section.

Tags syntax

"Tags": [
  {
    "Key": String,
    "Value": String
  }
]

Tags property

Property name	Type	Required	Updatable	Description	Constraints
Key	String	Yes	No	The tag key.	The tag key can be 1 to 128 characters in length. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.
Value	String	No	No	The tag value.	The tag value can be 1 to 128 characters in length. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.

Return values

Fn::GetAtt

Description: The description of the vault.
VaultName: The name of the vault.
RetentionDays: The backup retention period, in days.
VaultId: The ID of the vault.
VaultRegionId: The region ID of the vault.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultName:
    Type: String
    Description: Display name of the vault.
    Default: test
  RetentionDays:
    Type: Number
    Description: Data retention days of the vault. Data will be deleted when it's older than this time.
    Default: 1
  VaultRegionId:
    Type: String
    Description: The region ID to create the vault.
    Default: cn-hangzhou
Resources:
  HBRDbVault:
    Type: ALIYUN::HBR::DbVault
    Properties:
      VaultName:
        Ref: VaultName
      RetentionDays:
        Ref: RetentionDays
      VaultRegionId:
        Ref: VaultRegionId
Outputs:
  Description:
    Description: Description of the vault.
    Value:
      Fn::GetAtt:
        - HBRDbVault
        - Description
  VaultName:
    Description: Display name of the vault.
    Value:
      Fn::GetAtt:
        - HBRDbVault
        - VaultName
  RetentionDays:
    Description: Data retention days of the vault. Data will be deleted when it's older than this time.
    Value:
      Fn::GetAtt:
        - HBRDbVault
        - RetentionDays
  VaultId:
    Description: Vault ID.
    Value:
      Fn::GetAtt:
        - HBRDbVault
        - VaultId
  VaultRegionId:
    Description: The region ID to create the vault.
    Value:
      Fn::GetAtt:
        - HBRDbVault
        - VaultRegionId

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VaultName": {
      "Type": "String",
      "Description": "Display name of the vault.",
      "Default": "test"
    },
    "RetentionDays": {
      "Type": "Number",
      "Description": "Data retention days of the vault. Data will be deleted when it's older than this time.",
      "Default": 1
    },
    "VaultRegionId": {
      "Type": "String",
      "Description": "The region ID to create the vault.",
      "Default": "cn-hangzhou"
    }
  },
  "Resources": {
    "HBRDbVault": {
      "Type": "ALIYUN::HBR::DbVault",
      "Properties": {
        "VaultName": {
          "Ref": "VaultName"
        },
        "RetentionDays": {
          "Ref": "RetentionDays"
        },
        "VaultRegionId": {
          "Ref": "VaultRegionId"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "Description of the vault.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbVault",
          "Description"
        ]
      }
    },
    "VaultName": {
      "Description": "Display name of the vault.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbVault",
          "VaultName"
        ]
      }
    },
    "RetentionDays": {
      "Description": "Data retention days of the vault. Data will be deleted when it's older than this time.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbVault",
          "RetentionDays"
        ]
      }
    },
    "VaultId": {
      "Description": "Vault ID.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbVault",
          "VaultId"
        ]
      }
    },
    "VaultRegionId": {
      "Description": "The region ID to create the vault.",
      "Value": {
        "Fn::GetAtt": [
          "HBRDbVault",
          "VaultRegionId"
        ]
      }
    }
  }
}