Vault

• Implements: IVault

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

Initializers

import { Vault } from '@alicloud/ros-cdk-hbr'
new Vault(scope: Construct, id: string, props: VaultProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: VaultProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { Vault } from '@alicloud/ros-cdk-hbr'
Vault.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrBackupPlanStatistics^Required

public readonly attrBackupPlanStatistics: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrBytesDone^Required

public readonly attrBytesDone: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

Unit: bytes.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

attrDedup^Required

public readonly attrDedup: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Dedup: Indicates whether the deduplication feature is enabled.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the backup vault.

attrIndexAvailable^Required

public readonly attrIndexAvailable: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

attrIndexLevel^Required

public readonly attrIndexLevel: string | IResolvable;

• Type: string | @alicloud/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.

attrIndexUpdateTime^Required

public readonly attrIndexUpdateTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute IndexUpdateTime: The time when the index was updated.

attrLatestReplicationTime^Required

public readonly attrLatestReplicationTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: PaymentType.

attrRedundancyType^Required

public readonly attrRedundancyType: string | IResolvable;

• Type: string | @alicloud/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.

attrReplication^Required

public readonly attrReplication: string | IResolvable;

• Type: string | @alicloud/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.

attrReplicationProgress^Required

public readonly attrReplicationProgress: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrReplicationSourceRegionId^Required

public readonly attrReplicationSourceRegionId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrReplicationSourceVaultId^Required

public readonly attrReplicationSourceVaultId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrRetention^Required

public readonly attrRetention: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Retention: The retention period of the backup vault.

Unit: days.

attrSearchEnabled^Required

public readonly attrSearchEnabled: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrSourceTypes^Required

public readonly attrSourceTypes: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SourceTypes: The information about the data source.

attrStorageSize^Required

public readonly attrStorageSize: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

attrTags^Required

public readonly attrTags: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags of the backup vault.

attrTrialInfo^Required

public readonly attrTrialInfo: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TrialInfo: The free trial information.

attrUpdatedTime^Required

public readonly attrUpdatedTime: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

attrVaultId^Required

public readonly attrVaultId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VaultId: The ID of the backup vault.

attrVaultName^Required

public readonly attrVaultName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VaultName: The name of the backup vault.

attrVaultStatusMessage^Required

public readonly attrVaultStatusMessage: string | IResolvable;

• Type: string | @alicloud/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.

attrVaultStorageClass^Required

public readonly attrVaultStorageClass: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VaultStorageClass: The storage type of the backup vault.

Valid value: STANDARD, which indicates standard storage.

attrVaultType^Required

public readonly attrVaultType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VaultType: The type of the backup vault.

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

props^Required

public readonly props: VaultProps;

• Type: VaultProps