ALIYUN::HBR::Vault is used to create a backup vault.
Syntax
{
"Type": "ALIYUN::HBR::Vault",
"Properties": {
"VaultType": String,
"Description": String,
"EncryptType": String,
"ResourceGroupId": String,
"KmsKeyId": String,
"VaultName": String,
"RedundancyType": String,
"VaultStorageClass": String,
"Tags": List
}
}
Properties
Property | Type | Required | Editable | Description | Constraint |
VaultType | String | Yes | No | The type of the backup vault. | Valid values:
|
Description | String | No | Yes | The description of the backup vault. | The description can be up to 255 characters in length. |
EncryptType | String | No | No | The method that is used to encrypt the source data. | Valid values:
This property takes effect only when VaultType is set to STANDARD or OTS_BACKUP. |
ResourceGroupId | String | No | Yes | The ID of the resource group. | None. |
KmsKeyId | String | No | No | The custom key of KMS or the alias of the KMS key. | This property must be specified when EncryptType is set to KMS. |
VaultName | String | Yes | Yes | The name of the backup vault. | The name must be 1 to 64 characters in length. |
RedundancyType | String | No | No | The data redundancy type of the backup vault. | Valid values:
|
VaultStorageClass | String | No | No | The storage type of the backup vault. | Set the value to STANDARD. A value of STANDARD specifies standard storage. |
Tags | List | No | Yes | The tags of the backup vault. | You can add up to 20 tags. |
Tags syntax
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags properties
Property | Type | Required | Editable | Description | Constraint |
Value | String | No | No | The value of the tag. | The tag value can be up to 128 characters in length, and cannot contain |
Key | String | Yes | No | The key of the tag. | The tag key must be 1 to 128 characters in length, and cannot contain |
Return values
Fn::GetAtt
Description: the description of the backup vault.
ResourceGroupId: the ID of the resource group.
TrialInfo: the information about the free trial.
ReplicationSourceRegionId: the region ID of the source vault.
IndexUpdateTime: the time when the index was updated.
VaultId: the ID of the backup vault.
Retention: the retention period of the backup vault.
Dedup: indicates whether the deduplication feature is enabled.
VaultStatusMessage: the status message that is returned when the backup vault is in the
ERROR
state.BytesDone: the amount of data that is backed up.
ReplicationProgress: the progress of data synchronization from the backup vault to the mirror vault.
PaymentType: the billing method of the backup vault.
BackupPlanStatistics: the statistics of backup plans that use the backup vault.
Tags: the tags of the backup vault.
VaultName: the name of the backup vault.
RedundancyType: the data redundancy type of the backup vault.
VaultStorageClass: the storage type of the backup vault.
CreateTime: the time when the backup vault was created.
StorageSize: the usage of the backup vault.
ReplicationSourceVaultId: the ID of the source vault.
VaultType: the type of the backup vault.
LatestReplicationTime: the time of the most recent successful remote backup.
Replication: indicates whether the backup vault is a remote backup vault.
IndexLevel: the index level.
UpdatedTime: the time when the backup vault was updated.
SourceTypes: the information about the data sources.
IndexAvailable: indicates whether indexes are available.
SearchEnabled: indicates whether the backup search feature is enabled.