IVault

• Extends: ros_cdk_core.IResource

• Implemented By: Vault, IVault

Represents a Vault.

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

attr_backup_plan_statistics^Required

attr_backup_plan_statistics: typing.Union[str, IResolvable]

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

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

attr_bytes_done^Required

attr_bytes_done: typing.Union[str, IResolvable]

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

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

Unit: bytes.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

Attribute Dedup: Indicates whether the deduplication feature is enabled.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the backup vault.

attr_index_available^Required

attr_index_available: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

Attribute IndexUpdateTime: The time when the index was updated.

attr_latest_replication_time^Required

attr_latest_replication_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

Attribute PaymentType: PaymentType.

attr_redundancy_type^Required

attr_redundancy_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_retention^Required

attr_retention: typing.Union[str, IResolvable]

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

Attribute Retention: The retention period of the backup vault.

Unit: days.

attr_search_enabled^Required

attr_search_enabled: typing.Union[str, IResolvable]

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

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

attr_source_types^Required

attr_source_types: typing.Union[str, IResolvable]

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

Attribute SourceTypes: The information about the data source.

attr_storage_size^Required

attr_storage_size: typing.Union[str, IResolvable]

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

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: The tags of the backup vault.

attr_trial_info^Required

attr_trial_info: typing.Union[str, IResolvable]

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

Attribute TrialInfo: The free trial information.

attr_updated_time^Required

attr_updated_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

Attribute VaultId: The ID of the backup vault.

attr_vault_name^Required

attr_vault_name: typing.Union[str, IResolvable]

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

Attribute VaultName: The name of the backup vault.

attr_vault_status_message^Required

attr_vault_status_message: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

Attribute VaultType: The type of the backup vault.

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

props^Required

props: VaultProps

• Type: VaultProps