ALIYUN::HBR::Vault類型用于創(chuàng)建一個備份倉庫。
語法
{
"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 | 是 | 否 | 備份倉庫類型。 | 取值:
|
Description | String | 否 | 是 | 備份倉庫描述信息。 | 長度為0~255個字符。 |
EncryptType | String | 否 | 否 | 源端加密類型。 | 取值:
當VaultType為STANDARD或OTS_BACKUP時,本參數(shù)有效。 |
ResourceGroupId | String | 否 | 是 | 資源組ID。 | 無 |
KmsKeyId | String | 否 | 否 | 阿里云KMS服務自定義密鑰Key或Alias。 | 當EncryptType為KMS時,本參數(shù)必填。 |
VaultName | String | 是 | 是 | 備份倉庫名稱。 | 長度為1~64個字符。 |
RedundancyType | String | 否 | 否 | 備份倉庫的數(shù)據冗余存儲方式。 | 取值:
|
VaultStorageClass | String | 否 | 否 | 備份倉庫存儲類型。 | 取值:STANDARD,表示標準存儲。 |
Tags | List | 否 | 是 | 標簽。 | 最多支持20個標簽。 |
Tags語法
"Tags": [
{
"Value": String,
"Key": String
}
]
Tags屬性
屬性名稱 | 類型 | 必須 | 允許更新 | 描述 | 約束 |
Value | String | 否 | 否 | 標簽值。 | 長度為0~128個字符,不能以 |
Key | String | 是 | 否 | 標簽鍵。 | 長度為1~128 個字符,不能以 |
返回值
Fn::GetAtt
Description:備份倉庫描述信息。
ResourceGroupId:資源組ID。
TrialInfo:免費試用信息。
ReplicationSourceRegionId:源倉庫所屬的地域ID。
IndexUpdateTime:索引更新的時間。
VaultId:備份倉庫ID。
Retention:備份vault的保留期。
Dedup:顯示是否啟用重復數(shù)據刪除特性。
VaultStatusMessage:備份倉庫處于
ERROR
狀態(tài)時返回的狀態(tài)信息。BytesDone:備份的數(shù)據量。
ReplicationProgress:從備份倉庫到鏡像倉庫的數(shù)據同步進度。
PaymentType:付費類型。
BackupPlanStatistics:使用備份庫的備份計劃統(tǒng)計信息。
Tags:備份庫的標簽。
VaultName:備份倉庫名稱。
RedundancyType:備份倉庫的數(shù)據冗余類型。
VaultStorageClass:備份倉庫的存儲類型。
CreateTime:備份倉庫創(chuàng)建的時間。
StorageSize:備份倉庫的使用情況。
ReplicationSourceVaultId:源倉庫ID。
VaultType:備份倉庫的類型。
LatestReplicationTime:最后一次遠程備份同步的時間。
Replication:該備份倉庫是否為遠端備份倉庫。
IndexLevel:索引級別。
UpdatedTime:備份倉庫更新的時間。
SourceTypes:關于數(shù)據源的信息。
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"
]
}
}
}
}