Vault

• Implements: IVault

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Hbr;
new Vault(Construct Scope, string Id, VaultProps Props, bool EnableResourcePropertyConstraint = null);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

Id^Required

• Type: string

Props^Required

• Type: VaultProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Hbr;
Vault.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrBackupPlanStatistics^Required

public object AttrBackupPlanStatistics { get; }

• Type: object

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

AttrBytesDone^Required

public object AttrBytesDone { get; }

• Type: object

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

Unit: bytes.

AttrCreateTime^Required

public object AttrCreateTime { get; }

• Type: object

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

This value is a UNIX timestamp. Unit: seconds.

AttrDedup^Required

public object AttrDedup { get; }

• Type: object

Attribute Dedup: Indicates whether the deduplication feature is enabled.

AttrDescription^Required

public object AttrDescription { get; }

• Type: object

Attribute Description: The description of the backup vault.

AttrIndexAvailable^Required

public object AttrIndexAvailable { get; }

• Type: object

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

AttrIndexLevel^Required

public object AttrIndexLevel { get; }

• Type: object

Attribute IndexLevel: The index level.

• OFF: No indexes are created.
• META: Metadata indexes are created.
• ALL: Full-text indexes are created.

AttrIndexUpdateTime^Required

public object AttrIndexUpdateTime { get; }

• Type: object

Attribute IndexUpdateTime: The time when the index was updated.

AttrLatestReplicationTime^Required

public object AttrLatestReplicationTime { get; }

• Type: object

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

This value is a UNIX timestamp. Unit: seconds.

AttrPaymentType^Required

public object AttrPaymentType { get; }

• Type: object

Attribute PaymentType: PaymentType.

AttrRedundancyType^Required

public object AttrRedundancyType { get; }

• Type: object

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 object AttrReplication { get; }

• Type: object

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 object AttrReplicationProgress { get; }

• Type: object

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

AttrReplicationSourceRegionId^Required

public object AttrReplicationSourceRegionId { get; }

• Type: object

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

AttrReplicationSourceVaultId^Required

public object AttrReplicationSourceVaultId { get; }

• Type: object

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

AttrResourceGroupId^Required

public object AttrResourceGroupId { get; }

• Type: object

Attribute ResourceGroupId: The ID of the resource group.

AttrRetention^Required

public object AttrRetention { get; }

• Type: object

Attribute Retention: The retention period of the backup vault.

Unit: days.

AttrSearchEnabled^Required

public object AttrSearchEnabled { get; }

• Type: object

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

AttrSourceTypes^Required

public object AttrSourceTypes { get; }

• Type: object

Attribute SourceTypes: The information about the data source.

AttrStorageSize^Required

public object AttrStorageSize { get; }

• Type: object

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

AttrTags^Required

public object AttrTags { get; }

• Type: object

Attribute Tags: The tags of the backup vault.

AttrTrialInfo^Required

public object AttrTrialInfo { get; }

• Type: object

Attribute TrialInfo: The free trial information.

AttrUpdatedTime^Required

public object AttrUpdatedTime { get; }

• Type: object

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

This value is a UNIX timestamp. Unit: seconds.

AttrVaultId^Required

public object AttrVaultId { get; }

• Type: object

Attribute VaultId: The ID of the backup vault.

AttrVaultName^Required

public object AttrVaultName { get; }

• Type: object

Attribute VaultName: The name of the backup vault.

AttrVaultStatusMessage^Required

public object AttrVaultStatusMessage { get; }

• Type: object

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 object AttrVaultStorageClass { get; }

• Type: object

Attribute VaultStorageClass: The storage type of the backup vault.

Valid value: STANDARD, which indicates standard storage.

AttrVaultType^Required

public object AttrVaultType { get; }

• Type: object

Attribute VaultType: The type of the backup vault.

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

Props^Required

public VaultProps Props { get; }

• Type: VaultProps