文档

ALIYUN::HBR::Vault

更新时间:

ALIYUN::HBR::Vault类型用于创建一个备份仓库。

语法

{
  "Type": "ALIYUN::HBR::Vault",
  "Properties": {
    "VaultType": String,
    "Description": String,
    "EncryptType": String,
    "ResourceGroupId": String,
    "KmsKeyId": String,
    "VaultName": String,
    "RedundancyType": String,
    "VaultStorageClass": String,
    "Tags": List
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

VaultType

String

备份仓库类型。

取值:

  • STANDARD:表示普通仓库。

  • OTS_BACKUP:表示OTS备份库。

Description

String

备份仓库描述信息。

长度为0~255个字符。

EncryptType

String

源端加密类型。

取值:

  • HBR_PRIVATE:HBR完全托管,使用备份服务自带加密方式。

  • KMS:使用阿里云KMS服务自定义密钥加密。

当VaultType为STANDARD或OTS_BACKUP时,本参数有效。

ResourceGroupId

String

资源组ID。

KmsKeyId

String

阿里云KMS服务自定义密钥Key或Alias。

当EncryptType为KMS时,本参数必填。

VaultName

String

备份仓库名称。

长度为1~64个字符。

RedundancyType

String

备份仓库的数据冗余存储方式。

取值:

  • LRS:备份库(本地冗余LRS)。采用数据冗余存储机制,将每个对象的不同冗余存储在同一个可用区内多个设施的多个设备上,确保硬件失效时的数据持久性和可用性。

  • ZRS:备份库(同城冗余ZRS)。采用多可用区(AZ)机制,将用户的数据分散存放在同一地域(Region)的3个可用区。当某个可用区不可用时,仍然能够保障数据的正常访问。

VaultStorageClass

String

备份仓库存储类型。

取值:STANDARD,表示标准存储。

Tags

List

标签。

最多支持20个标签。

Tags语法

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

Tags属性

属性名称

类型

必须

允许更新

描述

约束

Value

String

标签值。

长度为0~128个字符,不能以aliyunacs:开头,不能包含http://或者https://

Key

String

标签键。

长度为1~128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

返回值

Fn::GetAtt

  • Description:备份仓库描述信息

  • ResourceGroupId:资源组ID。

  • TrialInfo:免费试用信息。

  • ReplicationSourceRegionId:源仓库所属的地域ID

  • IndexUpdateTime:索引更新的时间

  • VaultId:备份仓库ID。

  • Retention:备份vault的保留期。

  • Dedup:显示是否启用重复数据删除特性。

  • VaultStatusMessage:备份仓库处于ERROR状态时返回的状态信息。

  • BytesDone:备份的数据量。 

  • ReplicationProgress:从备份仓库到镜像仓库的数据同步进度。 

  • PaymentType:付费类型。

  • BackupPlanStatistics:使用备份库的备份计划统计信息。 

  • Tags:备份库的标签。

  • VaultName:备份仓库名称

  • RedundancyType:备份仓库的数据冗余类型。 

  • VaultStorageClass:备份仓库的存储类型。

  • CreateTime:备份仓库创建的时间。 

  • StorageSize:备份仓库的使用情况。

  • ReplicationSourceVaultId:源仓库ID。

  • VaultType:备份仓库的类型。

  • LatestReplicationTime:最后一次远程备份同步的时间。

  • Replication:该备份仓库是否为远端备份仓库。 

  • IndexLevel:索引级别。

  • UpdatedTime:备份仓库更新的时间。

  • SourceTypes:关于数据源的信息。

  • IndexAvailable:指示索引是否可用。

  • SearchEnabled:是否启用备份搜索特性。 

示例

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  VaultName:
    Description: The name of the backup vault. The name must be 1 to 64 characters
      in length.
    MaxLength: 64
    MinLength: 1
    Type: String
    Default: test-valut
Resources:
  ExtensionResource:
    Properties:
      VaultName:
        Ref: VaultName
      VaultType: STANDARD
    Type: ALIYUN::HBR::Vault
Outputs:
  BackupPlanStatistics:
    Description: The statistics of backup plans that use the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - BackupPlanStatistics
  BytesDone:
    Description: 'The amount of data that is backed up. Unit: bytes.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - BytesDone
  CreateTime:
    Description: 'The time when the backup vault was created. This value is a UNIX
      timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - CreateTime
  Dedup:
    Description: Indicates whether the deduplication feature is enabled.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Dedup
  Description:
    Description: The description of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Description
  IndexAvailable:
    Description: Indicates whether indexes are available. Indexes are available when
      they are not being updated.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexAvailable
  IndexLevel:
    Description: 'The index level.

      - **OFF**: No indexes are created.

      - **META**: Metadata indexes are created.

      - **ALL**: Full-text indexes are created.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexLevel
  IndexUpdateTime:
    Description: The time when the index was updated.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - IndexUpdateTime
  LatestReplicationTime:
    Description: 'The time when the last remote backup was synchronized. This value
      is a UNIX timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - LatestReplicationTime
  PaymentType:
    Description: PaymentType.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - PaymentType
  RedundancyType:
    Description: 'The data redundancy type of the backup vault. Valid values:

      - **LRS**: Locally redundant storage (LRS) is enabled for the backup vault.
      HBR stores the copies of each object on multiple devices of different facilities
      in the same zone. This way, HBR ensures data durability and availability even
      if hardware failures occur.

      - **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR
      uses the multi-zone mechanism to distribute data across three zones within the
      same region. If a zone fails, the data that is stored in the other two zones
      is still accessible.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - RedundancyType
  Replication:
    Description: 'Indicates whether the backup vault is a remote backup vault. Valid
      values:

      - **true**: The backup vault is a remote backup vault.

      - **false**: The backup vault is an on-premises backup vault.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Replication
  ReplicationProgress:
    Description: The progress of data synchronization from the backup vault to the
      mirror vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationProgress
  ReplicationSourceRegionId:
    Description: The ID of the region where the remote backup vault resides.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationSourceRegionId
  ReplicationSourceVaultId:
    Description: The ID of the source vault that corresponds to the remote backup
      vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ReplicationSourceVaultId
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - ResourceGroupId
  Retention:
    Description: 'The retention period of the backup vault. Unit: days.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Retention
  SearchEnabled:
    Description: Indicates whether the backup search feature is enabled.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - SearchEnabled
  SourceTypes:
    Description: The information about the data source.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - SourceTypes
  StorageSize:
    Description: 'The usage of the backup vault. Unit: bytes.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - StorageSize
  Tags:
    Description: The tags of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - Tags
  TrialInfo:
    Description: The free trial information.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - TrialInfo
  UpdatedTime:
    Description: 'The time when the backup vault was updated. This value is a UNIX
      timestamp. Unit: seconds.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - UpdatedTime
  VaultId:
    Description: The ID of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultId
  VaultName:
    Description: The name of the backup vault.
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultName
  VaultStatusMessage:
    Description: 'The status message that is returned when the backup vault is in
      the ERROR state. This parameter is available only for remote backup vaults.
      Valid values:

      - **UNKNOWN_ERROR*: An unknown error occurs.

      - **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for
      the source vault.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultStatusMessage
  VaultStorageClass:
    Description: 'The storage type of the backup vault. Valid value: **STANDARD**,
      which indicates standard storage.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultStorageClass
  VaultType:
    Description: 'The type of the backup vault. Valid value: **STANDARD**, which indicates
      a standard backup vault.'
    Value:
      Fn::GetAtt:
      - ExtensionResource
      - VaultType

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "VaultName": {
      "Description": "The name of the backup vault. The name must be 1 to 64 characters in length.",
      "MaxLength": 64,
      "MinLength": 1,
      "Type": "String",
      "Default": "test-valut"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Properties": {
        "VaultName": {
          "Ref": "VaultName"
        },
        "VaultType": "STANDARD"
      },
      "Type": "ALIYUN::HBR::Vault"
    }
  },
  "Outputs": {
    "BackupPlanStatistics": {
      "Description": "The statistics of backup plans that use the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BackupPlanStatistics"
        ]
      }
    },
    "BytesDone": {
      "Description": "The amount of data that is backed up. Unit: bytes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "BytesDone"
        ]
      }
    },
    "CreateTime": {
      "Description": "The time when the backup vault was created. This value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "Dedup": {
      "Description": "Indicates whether the deduplication feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Dedup"
        ]
      }
    },
    "Description": {
      "Description": "The description of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Description"
        ]
      }
    },
    "IndexAvailable": {
      "Description": "Indicates whether indexes are available. Indexes are available when they are not being updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexAvailable"
        ]
      }
    },
    "IndexLevel": {
      "Description": "The index level.\n- **OFF**: No indexes are created.\n- **META**: Metadata indexes are created.\n- **ALL**: Full-text indexes are created.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexLevel"
        ]
      }
    },
    "IndexUpdateTime": {
      "Description": "The time when the index was updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IndexUpdateTime"
        ]
      }
    },
    "LatestReplicationTime": {
      "Description": "The time when the last remote backup was synchronized. This value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "LatestReplicationTime"
        ]
      }
    },
    "PaymentType": {
      "Description": "PaymentType.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "PaymentType"
        ]
      }
    },
    "RedundancyType": {
      "Description": "The data redundancy type of the backup vault. Valid values:\n- **LRS**: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.\n- **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "RedundancyType"
        ]
      }
    },
    "Replication": {
      "Description": "Indicates whether the backup vault is a remote backup vault. Valid values:\n- **true**: The backup vault is a remote backup vault.\n- **false**: The backup vault is an on-premises backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Replication"
        ]
      }
    },
    "ReplicationProgress": {
      "Description": "The progress of data synchronization from the backup vault to the mirror vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationProgress"
        ]
      }
    },
    "ReplicationSourceRegionId": {
      "Description": "The ID of the region where the remote backup vault resides.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationSourceRegionId"
        ]
      }
    },
    "ReplicationSourceVaultId": {
      "Description": "The ID of the source vault that corresponds to the remote backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ReplicationSourceVaultId"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "ResourceGroupId"
        ]
      }
    },
    "Retention": {
      "Description": "The retention period of the backup vault. Unit: days.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Retention"
        ]
      }
    },
    "SearchEnabled": {
      "Description": "Indicates whether the backup search feature is enabled.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SearchEnabled"
        ]
      }
    },
    "SourceTypes": {
      "Description": "The information about the data source.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "SourceTypes"
        ]
      }
    },
    "StorageSize": {
      "Description": "The usage of the backup vault. Unit: bytes.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "StorageSize"
        ]
      }
    },
    "Tags": {
      "Description": "The tags of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    },
    "TrialInfo": {
      "Description": "The free trial information.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "TrialInfo"
        ]
      }
    },
    "UpdatedTime": {
      "Description": "The time when the backup vault was updated. This value is a UNIX timestamp. Unit: seconds.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "UpdatedTime"
        ]
      }
    },
    "VaultId": {
      "Description": "The ID of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultId"
        ]
      }
    },
    "VaultName": {
      "Description": "The name of the backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultName"
        ]
      }
    },
    "VaultStatusMessage": {
      "Description": "The status message that is returned when the backup vault is in the ERROR state. This parameter is available only for remote backup vaults. Valid values:\n- **UNKNOWN_ERROR*: An unknown error occurs.\n- **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for the source vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultStatusMessage"
        ]
      }
    },
    "VaultStorageClass": {
      "Description": "The storage type of the backup vault. Valid value: **STANDARD**, which indicates standard storage.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultStorageClass"
        ]
      }
    },
    "VaultType": {
      "Description": "The type of the backup vault. Valid value: **STANDARD**, which indicates a standard backup vault.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "VaultType"
        ]
      }
    }
  }
}
  • 本页导读 (1)
文档反馈