Skip to content

VaultProps

Properties for defining a Vault.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-vault

Initializer 

import ros_cdk_hbr
ros_cdk_hbr.VaultProps(
  vault_name: typing.Union[str, IResolvable],
  vault_type: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  encrypt_type: typing.Union[str, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  redundancy_type: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vault_storage_class: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
vault_name typing.Union[str, ros_cdk_core.IResolvable] Property vaultName: The name of the backup vault.
vault_type typing.Union[str, ros_cdk_core.IResolvable] Property vaultType: The type of the backup vault.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the backup vault.
encrypt_type typing.Union[str, ros_cdk_core.IResolvable] Property encryptType: The method that is used to encrypt the source data.
kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key.
redundancy_type typing.Union[str, ros_cdk_core.IResolvable] Property redundancyType: The data redundancy type of the backup vault.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
tags typing.List[TagsProperty] Property tags: Tags of The resource attribute field representing the resource tag..
vault_storage_class typing.Union[str, ros_cdk_core.IResolvable] Property vaultStorageClass: The storage type of the backup vault.

vault_nameRequired 

vault_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultName: The name of the backup vault.

The name must be 1 to 64 characters in length.

vault_typeRequired 

vault_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultType: The type of the backup vault.

Valid values:

  • STANDARD: standard backup vault.
  • OTS_BACKUP: backup vault for Tablestore.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the backup vault.

The description must be 0 to 255 characters in length.

encrypt_typeOptional 

encrypt_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property encryptType: The method that is used to encrypt the source data.

This parameter is valid only if you set the VaultType parameter to STANDARD or OTS_BACKUP. Valid values:- HBR_PRIVATE: The source data is encrypted by using the built-in encryption method of Hybrid Backup Recovery (HBR).

  • KMS: The source data is encrypted by using Key Management Service (KMS).

kms_key_idOptional 

kms_key_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key.

This parameter is required only if you set the EncryptType parameter to KMS.

redundancy_typeOptional 

redundancy_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property redundancyType: 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.

resource_group_idOptional 

resource_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tagsOptional 

tags: typing.List[TagsProperty]

Property tags: Tags of The resource attribute field representing the resource tag..

vault_storage_classOptional 

vault_storage_class: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultStorageClass: The storage type of the backup vault.

The value is only STANDARD, which indicates STANDARD storage.