Vault

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

Initializers

import com.aliyun.ros.cdk.hbr.datasource.Vault;
Vault.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .vaultId(java.lang.String)
    .vaultId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(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.
vaultId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vaultId: The ID of the backup vault.
refreshOptions	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

vaultId^Required

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

Property vaultId: The ID of the backup vault.

---

refreshOptions^Optional

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

---

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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• 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 creation time of the backup vault.
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: The payment type of the backup vault.
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 in which the source 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 data source types of the backup vault.
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: Backup repository storage type.
attrVaultType	com.aliyun.ros.cdk.core.IResolvable	Attribute VaultType: The type of the backup vault.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrBackupPlanStatistics^Required

public IResolvable getAttrBackupPlanStatistics();

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

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

---

attrBytesDone^Required

public IResolvable getAttrBytesDone();

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

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

Unit: bytes.

---

attrCreateTime^Required

public IResolvable getAttrCreateTime();

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

Attribute CreateTime: The creation time of the backup vault.

---

attrDedup^Required

public IResolvable getAttrDedup();

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

Attribute Dedup: Indicates whether the deduplication feature is enabled.

---

attrDescription^Required

public IResolvable getAttrDescription();

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

Attribute Description: The description of the backup vault.

---

attrIndexAvailable^Required

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.

---

attrIndexLevel^Required

public IResolvable getAttrIndexLevel();

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

Attribute IndexLevel: The index level.

---

attrIndexUpdateTime^Required

public IResolvable getAttrIndexUpdateTime();

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

Attribute IndexUpdateTime: The time when the index was updated.

---

attrLatestReplicationTime^Required

public IResolvable getAttrLatestReplicationTime();

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

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

The value is a UNIX timestamp. Unit: seconds.

---

attrPaymentType^Required

public IResolvable getAttrPaymentType();

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

Attribute PaymentType: The payment type of the backup vault.

---

attrRedundancyType^Required

public IResolvable getAttrRedundancyType();

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

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

---

attrReplication^Required

public IResolvable getAttrReplication();

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

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

---

attrReplicationProgress^Required

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.

---

attrReplicationSourceRegionId^Required

public IResolvable getAttrReplicationSourceRegionId();

• Type: com.aliyun.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.

---

attrReplicationSourceVaultId^Required

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.

---

attrResourceGroupId^Required

public IResolvable getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

---

attrRetention^Required

public IResolvable getAttrRetention();

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

Attribute Retention: The retention period of the backup vault.

Unit: days.

---

attrSearchEnabled^Required

public IResolvable getAttrSearchEnabled();

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

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

---

attrSourceTypes^Required

public IResolvable getAttrSourceTypes();

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

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

---

attrStorageSize^Required

public IResolvable getAttrStorageSize();

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

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

---

attrTags^Required

public IResolvable getAttrTags();

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

Attribute Tags: The tags of the backup vault.

---

attrTrialInfo^Required

public IResolvable getAttrTrialInfo();

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

Attribute TrialInfo: The free trial information.

---

attrUpdatedTime^Required

public IResolvable getAttrUpdatedTime();

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

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

The value is a UNIX timestamp. Unit: seconds.

---

attrVaultId^Required

public IResolvable getAttrVaultId();

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

Attribute VaultId: The ID of the backup vault.

---

attrVaultName^Required

public IResolvable getAttrVaultName();

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

Attribute VaultName: The name of the backup vault.

---

attrVaultStatusMessage^Required

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

---

attrVaultStorageClass^Required

public IResolvable getAttrVaultStorageClass();

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

Attribute VaultStorageClass: Backup repository storage type.

The value is only STANDARD, which indicates STANDARD storage.

---

attrVaultType^Required

public IResolvable getAttrVaultType();

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

Attribute VaultType: The type of the backup vault.

---