Vault

This class encapsulates and extends the ROS resource type ALIYUN::HBR::Vault, which is used to create a backup vault.

Initializers

import ros_cdk_hbr
ros_cdk_hbr.Vault(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

vault_name^Required

• 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_type^Required

• 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.

---

description^Optional

• 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_type^Optional

• 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_id^Optional

• 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_type^Optional

• 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_id^Optional

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

Property resourceGroupId: The ID of the resource group.

---

tags^Optional

• Type: typing.List[TagsProperty]

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

---

vault_storage_class^Optional

• 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.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_hbr
ros_cdk_hbr.Vault.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_backup_plan_statistics	ros_cdk_core.IResolvable	Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.
attr_bytes_done	ros_cdk_core.IResolvable	Attribute BytesDone: The amount of data that is backed up.
attr_create_time	ros_cdk_core.IResolvable	Attribute CreateTime: The time when the backup vault was created.
attr_dedup	ros_cdk_core.IResolvable	Attribute Dedup: Indicates whether the deduplication feature is enabled.
attr_description	ros_cdk_core.IResolvable	Attribute Description: The description of the backup vault.
attr_index_available	ros_cdk_core.IResolvable	Attribute IndexAvailable: Indicates whether indexes are available.
attr_index_level	ros_cdk_core.IResolvable	Attribute IndexLevel: The index level.
attr_index_update_time	ros_cdk_core.IResolvable	Attribute IndexUpdateTime: The time when the index was updated.
attr_latest_replication_time	ros_cdk_core.IResolvable	Attribute LatestReplicationTime: The time when the last remote backup was synchronized.
attr_payment_type	ros_cdk_core.IResolvable	Attribute PaymentType: PaymentType.
attr_redundancy_type	ros_cdk_core.IResolvable	Attribute RedundancyType: The data redundancy type of the backup vault.
attr_replication	ros_cdk_core.IResolvable	Attribute Replication: Indicates whether the backup vault is a remote backup vault.
attr_replication_progress	ros_cdk_core.IResolvable	Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.
attr_replication_source_region_id	ros_cdk_core.IResolvable	Attribute ReplicationSourceRegionId: The ID of the region where the remote backup vault resides.
attr_replication_source_vault_id	ros_cdk_core.IResolvable	Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.
attr_resource_group_id	ros_cdk_core.IResolvable	Attribute ResourceGroupId: The ID of the resource group.
attr_retention	ros_cdk_core.IResolvable	Attribute Retention: The retention period of the backup vault.
attr_search_enabled	ros_cdk_core.IResolvable	Attribute SearchEnabled: Indicates whether the backup search feature is enabled.
attr_source_types	ros_cdk_core.IResolvable	Attribute SourceTypes: The information about the data source.
attr_storage_size	ros_cdk_core.IResolvable	Attribute StorageSize: The usage of the backup vault.
attr_tags	ros_cdk_core.IResolvable	Attribute Tags: The tags of the backup vault.
attr_trial_info	ros_cdk_core.IResolvable	Attribute TrialInfo: The free trial information.
attr_updated_time	ros_cdk_core.IResolvable	Attribute UpdatedTime: The time when the backup vault was updated.
attr_vault_id	ros_cdk_core.IResolvable	Attribute VaultId: The ID of the backup vault.
attr_vault_name	ros_cdk_core.IResolvable	Attribute VaultName: The name of the backup vault.
attr_vault_status_message	ros_cdk_core.IResolvable	Attribute VaultStatusMessage: The status message that is returned when the backup vault is in the ERROR state.
attr_vault_storage_class	ros_cdk_core.IResolvable	Attribute VaultStorageClass: The storage type of the backup vault.
attr_vault_type	ros_cdk_core.IResolvable	Attribute VaultType: The type of the backup vault.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_backup_plan_statistics^Required

attr_backup_plan_statistics: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.

---

attr_bytes_done^Required

attr_bytes_done: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute BytesDone: The amount of data that is backed up.

Unit: bytes.

---

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CreateTime: The time when the backup vault was created.

This value is a UNIX timestamp. Unit: seconds.

---

attr_dedup^Required

attr_dedup: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Dedup: Indicates whether the deduplication feature is enabled.

---

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Description: The description of the backup vault.

---

attr_index_available^Required

attr_index_available: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

---

attr_index_level^Required

attr_index_level: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IndexLevel: The index level.

• OFF: No indexes are created.
• META: Metadata indexes are created.
• ALL: Full-text indexes are created.

---

attr_index_update_time^Required

attr_index_update_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute IndexUpdateTime: The time when the index was updated.

---

attr_latest_replication_time^Required

attr_latest_replication_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LatestReplicationTime: The time when the last remote backup was synchronized.

This value is a UNIX timestamp. Unit: seconds.

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PaymentType: PaymentType.

---

attr_redundancy_type^Required

attr_redundancy_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute 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.

---

attr_replication^Required

attr_replication: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Replication: 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.

---

attr_replication_progress^Required

attr_replication_progress: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.

---

attr_replication_source_region_id^Required

attr_replication_source_region_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReplicationSourceRegionId: The ID of the region where the remote backup vault resides.

---

attr_replication_source_vault_id^Required

attr_replication_source_vault_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.

---

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

---

attr_retention^Required

attr_retention: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Retention: The retention period of the backup vault.

Unit: days.

---

attr_search_enabled^Required

attr_search_enabled: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SearchEnabled: Indicates whether the backup search feature is enabled.

---

attr_source_types^Required

attr_source_types: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceTypes: The information about the data source.

---

attr_storage_size^Required

attr_storage_size: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

---

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the backup vault.

---

attr_trial_info^Required

attr_trial_info: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute TrialInfo: The free trial information.

---

attr_updated_time^Required

attr_updated_time: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute UpdatedTime: The time when the backup vault was updated.

This value is a UNIX timestamp. Unit: seconds.

---

attr_vault_id^Required

attr_vault_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VaultId: The ID of the backup vault.

---

attr_vault_name^Required

attr_vault_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VaultName: The name of the backup vault.

---

attr_vault_status_message^Required

attr_vault_status_message: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VaultStatusMessage: 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.

---

attr_vault_storage_class^Required

attr_vault_storage_class: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VaultStorageClass: The storage type of the backup vault.

Valid value: STANDARD, which indicates standard storage.

---

attr_vault_type^Required

attr_vault_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VaultType: The type of the backup vault.

Valid value: STANDARD, which indicates a standard backup vault.

---