Vault

• Implements: IVault

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkhbr"
alicloudroscdkhbr.NewVault(scope Construct, id *string, props VaultProps, enableResourcePropertyConstraint *bool) Vault

scope^Required

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

id^Required

• Type: *string

props^Required

• Type: VaultProps

enableResourcePropertyConstraint^Optional

• Type: *bool

Methods

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.

session^Required

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

The synthesis session.

AddCondition

func AddCondition(condition RosCondition)

condition^Required

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

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

AddDependency

func AddDependency(resource Resource)

resource^Required

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

AddResourceDesc

func AddResourceDesc(desc *string)

desc^Required

• Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policy^Required

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

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

name^Required

• Type: *string

SetMetadata

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

key^Required

• Type: *string

value^Required

• Type: interface{}

Static Functions

IsConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: interface{}

Properties

Node^Required

func Node() ConstructNode

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

The construct tree node associated with this construct.

Env^Required

func Env() IResourceEnvironment

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

func Ref() *string

• Type: *string

Stack^Required

func Stack() Stack

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

The stack in which this resource is defined.

Resource^Optional

func Resource() RosResource

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

AttrBackupPlanStatistics^Required

func AttrBackupPlanStatistics() interface{}

• Type: interface{}

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

AttrBytesDone^Required

func AttrBytesDone() interface{}

• Type: interface{}

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

Unit: bytes.

AttrCreateTime^Required

func AttrCreateTime() interface{}

• Type: interface{}

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

This value is a UNIX timestamp. Unit: seconds.

AttrDedup^Required

func AttrDedup() interface{}

• Type: interface{}

Attribute Dedup: Indicates whether the deduplication feature is enabled.

AttrDescription^Required

func AttrDescription() interface{}

• Type: interface{}

Attribute Description: The description of the backup vault.

AttrIndexAvailable^Required

func AttrIndexAvailable() interface{}

• Type: interface{}

Attribute IndexAvailable: Indicates whether indexes are available.

Indexes are available when they are not being updated.

AttrIndexLevel^Required

func AttrIndexLevel() interface{}

• Type: interface{}

Attribute IndexLevel: The index level.

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

AttrIndexUpdateTime^Required

func AttrIndexUpdateTime() interface{}

• Type: interface{}

Attribute IndexUpdateTime: The time when the index was updated.

AttrLatestReplicationTime^Required

func AttrLatestReplicationTime() interface{}

• Type: interface{}

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

This value is a UNIX timestamp. Unit: seconds.

AttrPaymentType^Required

func AttrPaymentType() interface{}

• Type: interface{}

Attribute PaymentType: PaymentType.

AttrRedundancyType^Required

func AttrRedundancyType() interface{}

• Type: interface{}

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

func AttrReplication() interface{}

• Type: interface{}

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

func AttrReplicationProgress() interface{}

• Type: interface{}

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

AttrReplicationSourceRegionId^Required

func AttrReplicationSourceRegionId() interface{}

• Type: interface{}

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

AttrReplicationSourceVaultId^Required

func AttrReplicationSourceVaultId() interface{}

• Type: interface{}

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

AttrResourceGroupId^Required

func AttrResourceGroupId() interface{}

• Type: interface{}

Attribute ResourceGroupId: The ID of the resource group.

AttrRetention^Required

func AttrRetention() interface{}

• Type: interface{}

Attribute Retention: The retention period of the backup vault.

Unit: days.

AttrSearchEnabled^Required

func AttrSearchEnabled() interface{}

• Type: interface{}

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

AttrSourceTypes^Required

func AttrSourceTypes() interface{}

• Type: interface{}

Attribute SourceTypes: The information about the data source.

AttrStorageSize^Required

func AttrStorageSize() interface{}

• Type: interface{}

Attribute StorageSize: The usage of the backup vault.

Unit: bytes.

AttrTags^Required

func AttrTags() interface{}

• Type: interface{}

Attribute Tags: The tags of the backup vault.

AttrTrialInfo^Required

func AttrTrialInfo() interface{}

• Type: interface{}

Attribute TrialInfo: The free trial information.

AttrUpdatedTime^Required

func AttrUpdatedTime() interface{}

• Type: interface{}

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

This value is a UNIX timestamp. Unit: seconds.

AttrVaultId^Required

func AttrVaultId() interface{}

• Type: interface{}

Attribute VaultId: The ID of the backup vault.

AttrVaultName^Required

func AttrVaultName() interface{}

• Type: interface{}

Attribute VaultName: The name of the backup vault.

AttrVaultStatusMessage^Required

func AttrVaultStatusMessage() interface{}

• Type: interface{}

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

func AttrVaultStorageClass() interface{}

• Type: interface{}

Attribute VaultStorageClass: The storage type of the backup vault.

Valid value: STANDARD, which indicates standard storage.

AttrVaultType^Required

func AttrVaultType() interface{}

• Type: interface{}

Attribute VaultType: The type of the backup vault.

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

Props^Required

func Props() VaultProps

• Type: VaultProps