RosVault

This class is a base encapsulation around the ROS resource type ALIYUN::HBR::Vault, which is used to create a backup vault.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Hbr;
new RosVault(Construct Scope, string Id, RosVaultProps Props, bool EnableResourcePropertyConstraint);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	- scope in which this resource is defined.
Id	string	- scoped id of the resource.
Props	RosVaultProps	- resource properties.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

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

scope in which this resource is defined.

---

Id^Required

• Type: string

scoped id of the resource.

---

Props^Required

• Type: RosVaultProps

resource properties.

---

EnableResourcePropertyConstraint^Required

• 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.
OverrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
AddCondition	No description.
AddCount	No description.
AddDeletionOverride	Syntactic sugar for addOverride(path, undefined).
AddDependsOn	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc	No description.
AddMetaData	No description.
AddOverride	Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride	Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride	Adds an override to a resource property.
AddRosDependency	No description.
ApplyRemovalPolicy	Sets the deletion policy of the resource based on the removal policy specified.
GetAtt	Returns a token for an runtime attribute of this resource.

---

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.

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

AddCondition

private void AddCondition(RosCondition Con)

Con^Required

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

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

Path^Required

• Type: string

The path of the value to delete.

---

AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Target^Required

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

---

AddDesc

private void AddDesc(string Desc)

Desc^Required

• Type: string

---

AddMetaData

private void AddMetaData(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

Path^Required

• Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

Value^Required

• Type: object

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPath^Required

• Type: string

The path to the property.

---

AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPath^Required

• Type: string

The path of the property.

---

Value^Required

• Type: object

The value.

---

AddRosDependency

private void AddRosDependency(string Target)

Target^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

Policy^Optional

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

---

Options^Optional

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

---

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeName^Required

• Type: string

The name of the attribute.

---

Static Functions

Name	Description
IsConstruct	Return whether the given object is a Construct.
IsRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource	Check whether the given construct is a RosResource.

---

IsConstruct

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

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Hbr;
RosVault.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

X^Required

• Type: object

---

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Hbr;
RosVault.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

Construct^Required

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

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode	The construct tree node associated with this construct.
CreationStack	string[]	No description.
LogicalId	string	The logical ID for this stack element.
Stack	AlibabaCloud.SDK.ROS.CDK.Core.Stack	The stack in which this element is defined.
Ref	string	Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions	AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	string	ROS resource type.
AttrBackupPlanStatistics	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrBytesDone	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCreateTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDedup	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDescription	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrIndexAvailable	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrIndexLevel	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrIndexUpdateTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrLatestReplicationTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPaymentType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrRedundancyType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrReplication	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrReplicationProgress	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrReplicationSourceRegionId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrReplicationSourceVaultId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrResourceGroupId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrRetention	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSearchEnabled	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSourceTypes	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrStorageSize	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrTags	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrTrialInfo	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrUpdatedTime	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVaultId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVaultName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVaultStatusMessage	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVaultStorageClass	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVaultType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
EnableResourcePropertyConstraint	bool	No description.
VaultName	object	No description.
VaultType	object	No description.
Description	object	No description.
EncryptType	object	No description.
KmsKeyId	object	No description.
RedundancyType	object	No description.
ResourceGroupId	object	No description.
Tags	TagsProperty[]	No description.
VaultStorageClass	object	No description.

---

Node^Required

public ConstructNode Node { get; }

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

The construct tree node associated with this construct.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

---

LogicalId^Required

public string LogicalId { get; }

• Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

Stack^Required

public Stack Stack { get; }

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

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

Ref^Required

public string Ref { get; }

• Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

RosOptions^Required

public IRosResourceOptions RosOptions { get; }

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

Options for this resource, such as condition, update policy etc.

---

RosResourceType^Required

public string RosResourceType { get; }

• Type: string

ROS resource type.

---

AttrBackupPlanStatistics^Required

public IResolvable AttrBackupPlanStatistics { get; }

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

---

AttrBytesDone^Required

public IResolvable AttrBytesDone { get; }

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

---

AttrCreateTime^Required

public IResolvable AttrCreateTime { get; }

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

---

AttrDedup^Required

public IResolvable AttrDedup { get; }

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

---

AttrDescription^Required

public IResolvable AttrDescription { get; }

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

---

AttrIndexAvailable^Required

public IResolvable AttrIndexAvailable { get; }

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

---

AttrIndexLevel^Required

public IResolvable AttrIndexLevel { get; }

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

---

AttrIndexUpdateTime^Required

public IResolvable AttrIndexUpdateTime { get; }

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

---

AttrLatestReplicationTime^Required

public IResolvable AttrLatestReplicationTime { get; }

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

---

AttrPaymentType^Required

public IResolvable AttrPaymentType { get; }

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

---

AttrRedundancyType^Required

public IResolvable AttrRedundancyType { get; }

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

---

AttrReplication^Required

public IResolvable AttrReplication { get; }

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

---

AttrReplicationProgress^Required

public IResolvable AttrReplicationProgress { get; }

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

---

AttrReplicationSourceRegionId^Required

public IResolvable AttrReplicationSourceRegionId { get; }

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

---

AttrReplicationSourceVaultId^Required

public IResolvable AttrReplicationSourceVaultId { get; }

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

---

AttrResourceGroupId^Required

public IResolvable AttrResourceGroupId { get; }

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

---

AttrRetention^Required

public IResolvable AttrRetention { get; }

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

---

AttrSearchEnabled^Required

public IResolvable AttrSearchEnabled { get; }

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

---

AttrSourceTypes^Required

public IResolvable AttrSourceTypes { get; }

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

---

AttrStorageSize^Required

public IResolvable AttrStorageSize { get; }

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

---

AttrTags^Required

public IResolvable AttrTags { get; }

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

---

AttrTrialInfo^Required

public IResolvable AttrTrialInfo { get; }

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

---

AttrUpdatedTime^Required

public IResolvable AttrUpdatedTime { get; }

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

---

AttrVaultId^Required

public IResolvable AttrVaultId { get; }

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

---

AttrVaultName^Required

public IResolvable AttrVaultName { get; }

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

---

AttrVaultStatusMessage^Required

public IResolvable AttrVaultStatusMessage { get; }

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

---

AttrVaultStorageClass^Required

public IResolvable AttrVaultStorageClass { get; }

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

---

AttrVaultType^Required

public IResolvable AttrVaultType { get; }

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

---

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

---

VaultName^Required

public object VaultName { get; }

• Type: object

---

VaultType^Required

public object VaultType { get; }

• Type: object

---

Description^Optional

public object Description { get; }

• Type: object

---

EncryptType^Optional

public object EncryptType { get; }

• Type: object

---

KmsKeyId^Optional

public object KmsKeyId { get; }

• Type: object

---

RedundancyType^Optional

public object RedundancyType { get; }

• Type: object

---

ResourceGroupId^Optional

public object ResourceGroupId { get; }

• Type: object

---

Tags^Optional

public TagsProperty[] Tags { get; }

• Type: TagsProperty[]

---

VaultStorageClass^Optional

public object VaultStorageClass { get; }

• Type: object

---

Constants

Name	Type	Description
RosResourceTypeName	string	The resource type name for this resource class.

---

RosResourceTypeName^Required

public string RosResourceTypeName { get; }

• Type: string

The resource type name for this resource class.

---