Skip to content

Vault

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-hbr'
new datasource.Vault(scope: Construct, id: string, props: VaultProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props VaultProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrBackupPlanStatistics @alicloud/ros-cdk-core.IResolvable Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.
attrBytesDone @alicloud/ros-cdk-core.IResolvable Attribute BytesDone: The amount of data that is backed up.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time of the backup vault.
attrDedup @alicloud/ros-cdk-core.IResolvable Attribute Dedup: Indicates whether the deduplication feature is enabled.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the backup vault.
attrIndexAvailable @alicloud/ros-cdk-core.IResolvable Attribute IndexAvailable: Indicates whether indexes are available.
attrIndexLevel @alicloud/ros-cdk-core.IResolvable Attribute IndexLevel: The index level.
attrIndexUpdateTime @alicloud/ros-cdk-core.IResolvable Attribute IndexUpdateTime: The time when the index was updated.
attrLatestReplicationTime @alicloud/ros-cdk-core.IResolvable Attribute LatestReplicationTime: The time when the last remote backup was synchronized.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The payment type of the backup vault.
attrRedundancyType @alicloud/ros-cdk-core.IResolvable Attribute RedundancyType: The data redundancy type of the backup vault.
attrReplication @alicloud/ros-cdk-core.IResolvable Attribute Replication: Indicates whether the backup vault is a remote backup vault.
attrReplicationProgress @alicloud/ros-cdk-core.IResolvable Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.
attrReplicationSourceRegionId @alicloud/ros-cdk-core.IResolvable Attribute ReplicationSourceRegionId: The ID of the region in which the source vault resides.
attrReplicationSourceVaultId @alicloud/ros-cdk-core.IResolvable Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrRetention @alicloud/ros-cdk-core.IResolvable Attribute Retention: The retention period of the backup vault.
attrSearchEnabled @alicloud/ros-cdk-core.IResolvable Attribute SearchEnabled: Indicates whether the backup search feature is enabled.
attrSourceTypes @alicloud/ros-cdk-core.IResolvable Attribute SourceTypes: The data source types of the backup vault.
attrStorageSize @alicloud/ros-cdk-core.IResolvable Attribute StorageSize: The usage of the backup vault.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of the backup vault.
attrTrialInfo @alicloud/ros-cdk-core.IResolvable Attribute TrialInfo: The free trial information.
attrUpdatedTime @alicloud/ros-cdk-core.IResolvable Attribute UpdatedTime: The time when the backup vault was updated.
attrVaultId @alicloud/ros-cdk-core.IResolvable Attribute VaultId: The ID of the backup vault.
attrVaultName @alicloud/ros-cdk-core.IResolvable Attribute VaultName: The name of the backup vault.
attrVaultStatusMessage @alicloud/ros-cdk-core.IResolvable Attribute VaultStatusMessage: The status message that is returned when the backup vault is in the ERROR state.
attrVaultStorageClass @alicloud/ros-cdk-core.IResolvable Attribute VaultStorageClass: Backup repository storage type.
attrVaultType @alicloud/ros-cdk-core.IResolvable Attribute VaultType: The type of the backup vault.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrBackupPlanStatisticsRequired 

public readonly attrBackupPlanStatistics: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrBytesDoneRequired 

public readonly attrBytesDone: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

Unit: bytes.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the backup vault.

attrDedupRequired 

public readonly attrDedup: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Dedup: Indicates whether the deduplication feature is enabled.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the backup vault.

attrIndexAvailableRequired 

public readonly attrIndexAvailable: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

attrIndexLevelRequired 

public readonly attrIndexLevel: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IndexLevel: The index level.

attrIndexUpdateTimeRequired 

public readonly attrIndexUpdateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IndexUpdateTime: The time when the index was updated.

attrLatestReplicationTimeRequired 

public readonly attrLatestReplicationTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

The value is a UNIX timestamp. Unit: seconds.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The payment type of the backup vault.

attrRedundancyTypeRequired 

public readonly attrRedundancyType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrReplicationRequired 

public readonly attrReplication: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Replication: Indicates whether the backup vault is a remote backup vault.

attrReplicationProgressRequired 

public readonly attrReplicationProgress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrReplicationSourceRegionIdRequired 

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

attrReplicationSourceVaultIdRequired 

public readonly attrReplicationSourceVaultId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrRetentionRequired 

public readonly attrRetention: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Retention: The retention period of the backup vault.

Unit: days.

attrSearchEnabledRequired 

public readonly attrSearchEnabled: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrSourceTypesRequired 

public readonly attrSourceTypes: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceTypes: The data source types of the backup vault.

attrStorageSizeRequired 

public readonly attrStorageSize: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags of the backup vault.

attrTrialInfoRequired 

public readonly attrTrialInfo: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute TrialInfo: The free trial information.

attrUpdatedTimeRequired 

public readonly attrUpdatedTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

The value is a UNIX timestamp. Unit: seconds.

attrVaultIdRequired 

public readonly attrVaultId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VaultId: The ID of the backup vault.

attrVaultNameRequired 

public readonly attrVaultName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VaultName: The name of the backup vault.

attrVaultStatusMessageRequired 

public readonly attrVaultStatusMessage: IResolvable;
  • Type: @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 valid only for remote backup vaults.

attrVaultStorageClassRequired 

public readonly attrVaultStorageClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VaultStorageClass: Backup repository storage type.

The value is only STANDARD, which indicates STANDARD storage.

attrVaultTypeRequired 

public readonly attrVaultType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VaultType: The type of the backup vault.