ReplicationVault
- Implements: IReplicationVault
This class encapsulates and extends the ROS resource type ALIYUN::HBR::ReplicationVault.
Initializers
import com.aliyun.ros.cdk.hbr.ReplicationVault;
ReplicationVault.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.replicationSourceRegionId(java.lang.String)
.replicationSourceRegionId(IResolvable)
.replicationSourceVaultId(java.lang.String)
.replicationSourceVaultId(IResolvable)
.vaultName(java.lang.String)
.vaultName(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)
// .vaultStorageClass(java.lang.String)
// .vaultStorageClass(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
replicationSourceRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property replicationSourceRegionId: The region ID of the source vault for replication. |
replicationSourceVaultId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property replicationSourceVaultId: The ID of the source vault for replication. |
vaultName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vaultName: The name of the vault. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the vault. |
encryptType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property encryptType: The method that is used to encrypt the source data. |
kmsKeyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key. |
redundancyType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property redundancyType: The data redundancy type of the backup vault. |
vaultStorageClass | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vaultStorageClass: The storage type of the backup vault. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
replicationSourceRegionIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property replicationSourceRegionId: The region ID of the source vault for replication.
replicationSourceVaultIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property replicationSourceVaultId: The ID of the source vault for replication.
vaultNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vaultName: The name of the vault.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the vault.
encryptTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property encryptType: The method that is used to encrypt the source data.
This parameter is valid only if you set the VaultType parameter to STANDARD or OTS_BACKUP. Valid values:
- HBR_PRIVATE: The source data is encrypted by using the built-in encryption method of Hybrid Backup Recovery (HBR).
- KMS: The source data is encrypted by using Key Management Service (KMS).
kmsKeyIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key.
This parameter is required only if you set the EncryptType parameter to KMS.
redundancyTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property redundancyType: The data redundancy type of the backup vault.
Valid values:
- LRS: standard locally redundant storage (LRS). Cloud Backup stores the copies of each object on multiple devices of different facilities in the same zone. This way, Cloud Backup ensures data durability and availability even if hardware failures occur.
- ZRS: standard zone-redundant storage (ZRS). Cloud Backup 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.
vaultStorageClassOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vaultStorageClass: The storage type of the backup vault.
Valid value: STANDARD, which indicates standard storage.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.hbr.ReplicationVault;
ReplicationVault.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrVaultId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VaultId: The ID of the vault. |
props | ReplicationVaultProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrVaultIdRequired
public java.lang.Object getAttrVaultId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VaultId: The ID of the vault.
propsRequired
public ReplicationVaultProps getProps();
- Type: ReplicationVaultProps