Skip to content

RosVault

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

Initializers 

import com.aliyun.ros.cdk.hbr.RosVault;
RosVault.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .vaultName(java.lang.String)
    .vaultName(IResolvable)
    .vaultType(java.lang.String)
    .vaultType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .encryptType(java.lang.String)
//  .encryptType(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .redundancyType(java.lang.String)
//  .redundancyType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vaultStorageClass(java.lang.String)
//  .vaultStorageClass(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct - scope in which this resource is defined.
id java.lang.String - scoped id of the resource.
enableResourcePropertyConstraint java.lang.Boolean No description.
vaultName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vaultType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
kmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
redundancyType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
vaultStorageClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

scopeRequired

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

scope in which this resource is defined.

idRequired

  • Type: java.lang.String

scoped id of the resource.

enableResourcePropertyConstraintRequired

  • Type: java.lang.Boolean

vaultNameRequired

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

vaultTypeRequired

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

descriptionOptional

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

encryptTypeOptional

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

kmsKeyIdOptional

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

redundancyTypeOptional

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

resourceGroupIdOptional

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

tagsOptional

vaultStorageClassOptional

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

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 

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.

sessionRequired

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

The synthesis session.

overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired

  • Type: java.lang.String

The new logical ID to use for this stack element.

addCondition 

public void addCondition(RosCondition con)

conRequired

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

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

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

addDeletionOverride 

public void addDeletionOverride(java.lang.String path)

Syntactic sugar for addOverride(path, undefined).

pathRequired

  • Type: java.lang.String

The path of the value to delete.

addDependsOn 

public 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.

targetRequired

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

addDesc 

public void addDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

addMetaData 

public void addMetaData(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

addOverride 

public void addOverride(java.lang.String path, java.lang.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"
       ...
     },
   ]
   ...
}

pathRequired

  • Type: java.lang.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.

valueRequired

  • Type: java.lang.Object

The value.

Could be primitive or complex.

addPropertyDeletionOverride 

public void addPropertyDeletionOverride(java.lang.String propertyPath)

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

propertyPathRequired

  • Type: java.lang.String

The path to the property.

addPropertyOverride 

public void addPropertyOverride(java.lang.String propertyPath, java.lang.Object value)

Adds an override to a resource property.

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

propertyPathRequired

  • Type: java.lang.String

The path of the property.

valueRequired

  • Type: java.lang.Object

The value.

addRosDependency 

public void addRosDependency(java.lang.String target)

targetRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy()
public void applyRemovalPolicy(RemovalPolicy policy)
public void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)

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

policyOptional

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

optionsOptional

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

getAtt 

public Reference getAtt(java.lang.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.

attributeNameRequired

  • Type: java.lang.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 

import com.aliyun.ros.cdk.hbr.RosVault;
RosVault.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

isRosElement 

import com.aliyun.ros.cdk.hbr.RosVault;
RosVault.isRosElement(java.lang.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.

xRequired

  • Type: java.lang.Object

isRosResource 

import com.aliyun.ros.cdk.hbr.RosVault;
RosVault.isRosResource(IConstruct construct)

Check whether the given construct is a RosResource.

constructRequired

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

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
creationStack java.util.List No description.
logicalId java.lang.String The logical ID for this stack element.
stack com.aliyun.ros.cdk.core.Stack The stack in which this element is defined.
ref java.lang.String Return a string that will be resolved to a RosTemplate { Ref } for this element.
rosOptions com.aliyun.ros.cdk.core.IRosResourceOptions Options for this resource, such as condition, update policy etc.
rosResourceType java.lang.String ROS resource type.
attrBackupPlanStatistics com.aliyun.ros.cdk.core.IResolvable No description.
attrBytesDone com.aliyun.ros.cdk.core.IResolvable No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrDedup com.aliyun.ros.cdk.core.IResolvable No description.
attrDescription com.aliyun.ros.cdk.core.IResolvable No description.
attrIndexAvailable com.aliyun.ros.cdk.core.IResolvable No description.
attrIndexLevel com.aliyun.ros.cdk.core.IResolvable No description.
attrIndexUpdateTime com.aliyun.ros.cdk.core.IResolvable No description.
attrLatestReplicationTime com.aliyun.ros.cdk.core.IResolvable No description.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable No description.
attrRedundancyType com.aliyun.ros.cdk.core.IResolvable No description.
attrReplication com.aliyun.ros.cdk.core.IResolvable No description.
attrReplicationProgress com.aliyun.ros.cdk.core.IResolvable No description.
attrReplicationSourceRegionId com.aliyun.ros.cdk.core.IResolvable No description.
attrReplicationSourceVaultId com.aliyun.ros.cdk.core.IResolvable No description.
attrResourceGroupId com.aliyun.ros.cdk.core.IResolvable No description.
attrRetention com.aliyun.ros.cdk.core.IResolvable No description.
attrSearchEnabled com.aliyun.ros.cdk.core.IResolvable No description.
attrSourceTypes com.aliyun.ros.cdk.core.IResolvable No description.
attrStorageSize com.aliyun.ros.cdk.core.IResolvable No description.
attrTags com.aliyun.ros.cdk.core.IResolvable No description.
attrTrialInfo com.aliyun.ros.cdk.core.IResolvable No description.
attrUpdatedTime com.aliyun.ros.cdk.core.IResolvable No description.
attrVaultId com.aliyun.ros.cdk.core.IResolvable No description.
attrVaultName com.aliyun.ros.cdk.core.IResolvable No description.
attrVaultStatusMessage com.aliyun.ros.cdk.core.IResolvable No description.
attrVaultStorageClass com.aliyun.ros.cdk.core.IResolvable No description.
attrVaultType com.aliyun.ros.cdk.core.IResolvable No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
vaultName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
vaultType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
encryptType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
kmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
redundancyType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.
tags java.util.List<TagsProperty> No description.
vaultStorageClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable No description.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

creationStackRequired 

public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List

logicalIdRequired 

public java.lang.String getLogicalId();
  • Type: java.lang.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).

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this element is defined.

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

refRequired 

public java.lang.String getRef();
  • Type: java.lang.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 }).

rosOptionsRequired 

public IRosResourceOptions getRosOptions();
  • Type: com.aliyun.ros.cdk.core.IRosResourceOptions

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

rosResourceTypeRequired 

public java.lang.String getRosResourceType();
  • Type: java.lang.String

ROS resource type.

attrBackupPlanStatisticsRequired 

public IResolvable getAttrBackupPlanStatistics();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrBytesDoneRequired 

public IResolvable getAttrBytesDone();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDedupRequired 

public IResolvable getAttrDedup();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrDescriptionRequired 

public IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrIndexAvailableRequired 

public IResolvable getAttrIndexAvailable();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrIndexLevelRequired 

public IResolvable getAttrIndexLevel();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrIndexUpdateTimeRequired 

public IResolvable getAttrIndexUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrLatestReplicationTimeRequired 

public IResolvable getAttrLatestReplicationTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrRedundancyTypeRequired 

public IResolvable getAttrRedundancyType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrReplicationRequired 

public IResolvable getAttrReplication();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrReplicationProgressRequired 

public IResolvable getAttrReplicationProgress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrReplicationSourceRegionIdRequired 

public IResolvable getAttrReplicationSourceRegionId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrReplicationSourceVaultIdRequired 

public IResolvable getAttrReplicationSourceVaultId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrRetentionRequired 

public IResolvable getAttrRetention();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSearchEnabledRequired 

public IResolvable getAttrSearchEnabled();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrSourceTypesRequired 

public IResolvable getAttrSourceTypes();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrStorageSizeRequired 

public IResolvable getAttrStorageSize();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrTrialInfoRequired 

public IResolvable getAttrTrialInfo();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrUpdatedTimeRequired 

public IResolvable getAttrUpdatedTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVaultIdRequired 

public IResolvable getAttrVaultId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVaultNameRequired 

public IResolvable getAttrVaultName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVaultStatusMessageRequired 

public IResolvable getAttrVaultStatusMessage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVaultStorageClassRequired 

public IResolvable getAttrVaultStorageClass();
  • Type: com.aliyun.ros.cdk.core.IResolvable

attrVaultTypeRequired 

public IResolvable getAttrVaultType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

enableResourcePropertyConstraintRequired 

public java.lang.Boolean getEnableResourcePropertyConstraint();
  • Type: java.lang.Boolean

vaultNameRequired 

public java.lang.Object getVaultName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

vaultTypeRequired 

public java.lang.Object getVaultType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

descriptionOptional 

public java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

encryptTypeOptional 

public java.lang.Object getEncryptType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

kmsKeyIdOptional 

public java.lang.Object getKmsKeyId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

redundancyTypeOptional 

public java.lang.Object getRedundancyType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

tagsOptional 

public java.util.List<TagsProperty> getTags();

vaultStorageClassOptional 

public java.lang.Object getVaultStorageClass();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Constants

Name Type Description
ROS_RESOURCE_TYPE_NAME java.lang.String The resource type name for this resource class.

ROS_RESOURCE_TYPE_NAMERequired 

public java.lang.String getRosResourceTypeName();
  • Type: java.lang.String

The resource type name for this resource class.