Skip to content

VaultProps

Properties for defining a Vault.

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

Initializer 

import { VaultProps } from '@alicloud/ros-cdk-hbr'
const vaultProps: VaultProps = { ... }

Properties

Name Type Description
vaultName string | @alicloud/ros-cdk-core.IResolvable Property vaultName: The name of the backup vault.
vaultType string | @alicloud/ros-cdk-core.IResolvable Property vaultType: The type of the backup vault.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the backup vault.
encryptType string | @alicloud/ros-cdk-core.IResolvable Property encryptType: The method that is used to encrypt the source data.
kmsKeyId string | @alicloud/ros-cdk-core.IResolvable Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key.
redundancyType string | @alicloud/ros-cdk-core.IResolvable Property redundancyType: The data redundancy type of the backup vault.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags of The resource attribute field representing the resource tag..
vaultStorageClass string | @alicloud/ros-cdk-core.IResolvable Property vaultStorageClass: The storage type of the backup vault.

vaultNameRequired 

public readonly vaultName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vaultName: The name of the backup vault.

The name must be 1 to 64 characters in length.

vaultTypeRequired 

public readonly vaultType: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the backup vault.

The description must be 0 to 255 characters in length.

encryptTypeOptional 

public readonly encryptType: string | IResolvable;
  • Type: string | @alicloud/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).

kmsKeyIdOptional 

public readonly kmsKeyId: string | IResolvable;
  • Type: string | @alicloud/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.

redundancyTypeOptional 

public readonly redundancyType: string | IResolvable;
  • Type: string | @alicloud/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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly tags: TagsProperty[];

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

vaultStorageClassOptional 

public readonly vaultStorageClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vaultStorageClass: The storage type of the backup vault.

The value is only STANDARD, which indicates STANDARD storage.