Vault

• Implements: com.aliyun.ros.cdk.hbr.datasource.IVault

This class encapsulates and extends the ROS resource type DATASOURCE::HBR::Vault, which is used to query the information about a backup 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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 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 java.lang.Object getAttrBackupPlanStatistics();

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

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

attrBytesDone^Required

public java.lang.Object getAttrBytesDone();

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

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

Unit: bytes.

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

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

Attribute CreateTime: The creation time of the backup vault.

attrDedup^Required

public java.lang.Object getAttrDedup();

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

Attribute Dedup: Indicates whether the deduplication feature is enabled.

attrDescription^Required

public java.lang.Object getAttrDescription();

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

Attribute Description: The description of the backup vault.

attrIndexAvailable^Required

public java.lang.Object getAttrIndexAvailable();

• Type: java.lang.String OR 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 java.lang.Object getAttrIndexLevel();

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

Attribute IndexLevel: The index level.

attrIndexUpdateTime^Required

public java.lang.Object getAttrIndexUpdateTime();

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

Attribute IndexUpdateTime: The time when the index was updated.

attrLatestReplicationTime^Required

public java.lang.Object getAttrLatestReplicationTime();

• Type: java.lang.String OR 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 java.lang.Object getAttrPaymentType();

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

Attribute PaymentType: The payment type of the backup vault.

attrRedundancyType^Required

public java.lang.Object getAttrRedundancyType();

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

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

attrReplication^Required

public java.lang.Object getAttrReplication();

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

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

attrReplicationProgress^Required

public java.lang.Object getAttrReplicationProgress();

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

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

attrReplicationSourceRegionId^Required

public java.lang.Object getAttrReplicationSourceRegionId();

• Type: java.lang.String OR 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 java.lang.Object getAttrReplicationSourceVaultId();

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

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

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

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

Attribute ResourceGroupId: The ID of the resource group.

attrRetention^Required

public java.lang.Object getAttrRetention();

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

Attribute Retention: The retention period of the backup vault.

Unit: days.

attrSearchEnabled^Required

public java.lang.Object getAttrSearchEnabled();

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

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

attrSourceTypes^Required

public java.lang.Object getAttrSourceTypes();

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

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

attrStorageSize^Required

public java.lang.Object getAttrStorageSize();

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

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

attrTags^Required

public java.lang.Object getAttrTags();

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

Attribute Tags: The tags of the backup vault.

attrTrialInfo^Required

public java.lang.Object getAttrTrialInfo();

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

Attribute TrialInfo: The free trial information.

attrUpdatedTime^Required

public java.lang.Object getAttrUpdatedTime();

• Type: java.lang.String OR 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 java.lang.Object getAttrVaultId();

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

Attribute VaultId: The ID of the backup vault.

attrVaultName^Required

public java.lang.Object getAttrVaultName();

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

Attribute VaultName: The name of the backup vault.

attrVaultStatusMessage^Required

public java.lang.Object getAttrVaultStatusMessage();

• Type: java.lang.String OR 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 java.lang.Object getAttrVaultStorageClass();

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

Attribute VaultStorageClass: Backup repository storage type.

The value is only STANDARD, which indicates STANDARD storage.

attrVaultType^Required

public java.lang.Object getAttrVaultType();

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

Attribute VaultType: The type of the backup vault.

props^Required

public VaultProps getProps();

• Type: VaultProps