Vault

This class encapsulates and extends the ROS resource type DATASOURCE::HBR::Vault.

Initializers

from ros_cdk_hbr import datasource
datasource.Vault(
  scope: Construct,
  id: str,
  vault_id: typing.Union[str, IResolvable],
  refresh_options: 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_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vaultId: The ID of the backup vault.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

vault_id^Required

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

Property vaultId: The ID of the backup vault.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

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

from ros_cdk_hbr import datasource
datasource.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 creation time of the backup vault.
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: The payment type of the backup vault.
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 in which the source 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 data source types of the backup vault.
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: Backup repository storage type.
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 creation time of the backup vault.

---

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.

---

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.

The value is a UNIX timestamp. Unit: seconds.

---

attr_payment_type^Required

attr_payment_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute PaymentType: The payment type of the backup vault.

---

attr_redundancy_type^Required

attr_redundancy_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RedundancyType: The data redundancy type of the backup vault.

---

attr_replication^Required

attr_replication: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Replication: Indicates whether the backup vault is a remote 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 in which the source vault resides.

This parameter is valid only for remote backup vaults.

---

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 data source types of the backup vault.

---

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.

The 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 valid only for remote backup vaults.

---

attr_vault_storage_class^Required

attr_vault_storage_class: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute VaultStorageClass: Backup repository storage type.

The value is only 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.

---