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 "github.com/alibabacloud-go/ros-cdk/alicloudroscdkhbr"
alicloudroscdkhbr.NewVault(scope Construct, id *string, props VaultProps, enableResourcePropertyConstraint *bool) Vault
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct No description.
id *string No description.
props VaultProps No description.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

idRequired

  • Type: *string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: *bool

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 

func ToString() *string

Returns a string representation of this construct.

Synthesize 

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

AddCondition 

func AddCondition(condition RosCondition)

conditionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount 

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency 

func AddDependency(resource Resource)

resourceRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc 

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy 

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

GetAtt 

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata 

func SetMetadata(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

Static Functions

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

IsConstruct 

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkhbr"
alicloudroscdkhbr.Vault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
Ref *string No description.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this resource is defined.
Resource github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource No description.
AttrBackupPlanStatistics github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.
AttrBytesDone github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute BytesDone: The amount of data that is backed up.
AttrCreateTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute CreateTime: The time when the backup vault was created.
AttrDedup github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Dedup: Indicates whether the deduplication feature is enabled.
AttrDescription github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Description: The description of the backup vault.
AttrIndexAvailable github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute IndexAvailable: Indicates whether indexes are available.
AttrIndexLevel github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute IndexLevel: The index level.
AttrIndexUpdateTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute IndexUpdateTime: The time when the index was updated.
AttrLatestReplicationTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute LatestReplicationTime: The time when the last remote backup was synchronized.
AttrPaymentType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute PaymentType: PaymentType.
AttrRedundancyType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute RedundancyType: The data redundancy type of the backup vault.
AttrReplication github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Replication: Indicates whether the backup vault is a remote backup vault.
AttrReplicationProgress github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.
AttrReplicationSourceRegionId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ReplicationSourceRegionId: The ID of the region where the remote backup vault resides.
AttrReplicationSourceVaultId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.
AttrResourceGroupId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute ResourceGroupId: The ID of the resource group.
AttrRetention github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Retention: The retention period of the backup vault.
AttrSearchEnabled github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute SearchEnabled: Indicates whether the backup search feature is enabled.
AttrSourceTypes github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute SourceTypes: The information about the data source.
AttrStorageSize github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute StorageSize: The usage of the backup vault.
AttrTags github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute Tags: The tags of the backup vault.
AttrTrialInfo github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute TrialInfo: The free trial information.
AttrUpdatedTime github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute UpdatedTime: The time when the backup vault was updated.
AttrVaultId github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VaultId: The ID of the backup vault.
AttrVaultName github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VaultName: The name of the backup vault.
AttrVaultStatusMessage github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VaultStatusMessage: The status message that is returned when the backup vault is in the ERROR state.
AttrVaultStorageClass github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VaultStorageClass: The storage type of the backup vault.
AttrVaultType github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable Attribute VaultType: The type of the backup vault.

NodeRequired 

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

RefRequired 

func Ref() *string
  • Type: *string

StackRequired 

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.

ResourceOptional 

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrBackupPlanStatisticsRequired 

func AttrBackupPlanStatistics() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrBytesDoneRequired 

func AttrBytesDone() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

Unit: bytes.

AttrCreateTimeRequired 

func AttrCreateTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

AttrDedupRequired 

func AttrDedup() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Dedup: Indicates whether the deduplication feature is enabled.

AttrDescriptionRequired 

func AttrDescription() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Description: The description of the backup vault.

AttrIndexAvailableRequired 

func AttrIndexAvailable() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

AttrIndexLevelRequired 

func AttrIndexLevel() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute IndexLevel: The index level.

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

AttrIndexUpdateTimeRequired 

func AttrIndexUpdateTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute IndexUpdateTime: The time when the index was updated.

AttrLatestReplicationTimeRequired 

func AttrLatestReplicationTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

AttrPaymentTypeRequired 

func AttrPaymentType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute PaymentType: PaymentType.

AttrRedundancyTypeRequired 

func AttrRedundancyType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrReplication() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrReplicationProgress() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrReplicationSourceRegionIdRequired 

func AttrReplicationSourceRegionId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrReplicationSourceVaultIdRequired 

func AttrReplicationSourceVaultId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrResourceGroupIdRequired 

func AttrResourceGroupId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

AttrRetentionRequired 

func AttrRetention() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Retention: The retention period of the backup vault.

Unit: days.

AttrSearchEnabledRequired 

func AttrSearchEnabled() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

AttrSourceTypesRequired 

func AttrSourceTypes() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute SourceTypes: The information about the data source.

AttrStorageSizeRequired 

func AttrStorageSize() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

AttrTagsRequired 

func AttrTags() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute Tags: The tags of the backup vault.

AttrTrialInfoRequired 

func AttrTrialInfo() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute TrialInfo: The free trial information.

AttrUpdatedTimeRequired 

func AttrUpdatedTime() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

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

This value is a UNIX timestamp. Unit: seconds.

AttrVaultIdRequired 

func AttrVaultId() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute VaultId: The ID of the backup vault.

AttrVaultNameRequired 

func AttrVaultName() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute VaultName: The name of the backup vault.

AttrVaultStatusMessageRequired 

func AttrVaultStatusMessage() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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 

func AttrVaultStorageClass() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute VaultStorageClass: The storage type of the backup vault.

Valid value: STANDARD, which indicates standard storage.

AttrVaultTypeRequired 

func AttrVaultType() IResolvable
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResolvable

Attribute VaultType: The type of the backup vault.

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