Skip to content

Vault

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

Initializers 

import com.aliyun.ros.cdk.hbr.Vault;
Vault.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .vaultName(java.lang.String)
    .vaultName(IResolvable)
    .vaultType(java.lang.String)
    .vaultType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .encryptType(java.lang.String)
//  .encryptType(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .redundancyType(java.lang.String)
//  .redundancyType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vaultStorageClass(java.lang.String)
//  .vaultStorageClass(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
vaultName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vaultName: The name of the backup vault.
vaultType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vaultType: The type of the backup vault.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the backup vault.
encryptType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property encryptType: The method that is used to encrypt the source data.
kmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key.
redundancyType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property redundancyType: The data redundancy type of the backup vault.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags of The resource attribute field representing the resource tag..
vaultStorageClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vaultStorageClass: The storage type of the backup vault.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

vaultNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vaultName: The name of the backup vault.

The name must be 1 to 64 characters in length.

vaultTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vaultType: The type of the backup vault.

Valid values:

  • STANDARD: standard backup vault.
  • OTS_BACKUP: backup vault for Tablestore.

descriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the backup vault.

The description must be 0 to 255 characters in length.

encryptTypeOptional

  • Type: java.lang.String OR com.aliyun.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).

kmsKeyIdOptional

  • Type: java.lang.String OR com.aliyun.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.

redundancyTypeOptional

  • Type: java.lang.String OR com.aliyun.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.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional

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

vaultStorageClassOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vaultStorageClass: The storage type of the backup vault.

The value is only STANDARD, which indicates STANDARD storage.

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.hbr.Vault;
Vault.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrBackupPlanStatisticsRequired 

public IResolvable getAttrBackupPlanStatistics();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrBytesDoneRequired 

public IResolvable getAttrBytesDone();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

Unit: bytes.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

attrDedupRequired 

public IResolvable getAttrDedup();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Dedup: Indicates whether the deduplication feature is enabled.

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the backup vault.

attrIndexAvailableRequired 

public IResolvable getAttrIndexAvailable();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

attrIndexLevelRequired 

public IResolvable getAttrIndexLevel();
  • Type: com.aliyun.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.

attrIndexUpdateTimeRequired 

public IResolvable getAttrIndexUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IndexUpdateTime: The time when the index was updated.

attrLatestReplicationTimeRequired 

public IResolvable getAttrLatestReplicationTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: PaymentType.

attrRedundancyTypeRequired 

public IResolvable getAttrRedundancyType();
  • Type: com.aliyun.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.

attrReplicationRequired 

public IResolvable getAttrReplication();
  • Type: com.aliyun.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.

attrReplicationProgressRequired 

public IResolvable getAttrReplicationProgress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrReplicationSourceRegionIdRequired 

public IResolvable getAttrReplicationSourceRegionId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrReplicationSourceVaultIdRequired 

public IResolvable getAttrReplicationSourceVaultId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrRetentionRequired 

public IResolvable getAttrRetention();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Retention: The retention period of the backup vault.

Unit: days.

attrSearchEnabledRequired 

public IResolvable getAttrSearchEnabled();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrSourceTypesRequired 

public IResolvable getAttrSourceTypes();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceTypes: The information about the data source.

attrStorageSizeRequired 

public IResolvable getAttrStorageSize();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of the backup vault.

attrTrialInfoRequired 

public IResolvable getAttrTrialInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TrialInfo: The free trial information.

attrUpdatedTimeRequired 

public IResolvable getAttrUpdatedTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

attrVaultIdRequired 

public IResolvable getAttrVaultId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VaultId: The ID of the backup vault.

attrVaultNameRequired 

public IResolvable getAttrVaultName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VaultName: The name of the backup vault.

attrVaultStatusMessageRequired 

public IResolvable getAttrVaultStatusMessage();
  • Type: com.aliyun.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.

attrVaultStorageClassRequired 

public IResolvable getAttrVaultStorageClass();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VaultStorageClass: The storage type of the backup vault.

Valid value: STANDARD, which indicates standard storage.

attrVaultTypeRequired 

public IResolvable getAttrVaultType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VaultType: The type of the backup vault.

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