ReplicationVault
- Implements: IReplicationVault
This class encapsulates and extends the ROS resource type ALIYUN::HBR::ReplicationVault.
Initializers
import ros_cdk_hbr
ros_cdk_hbr.ReplicationVault(
scope: Construct,
id: str,
replication_source_region_id: typing.Union[str, IResolvable],
replication_source_vault_id: typing.Union[str, IResolvable],
vault_name: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
encrypt_type: typing.Union[str, IResolvable] = None,
kms_key_id: typing.Union[str, IResolvable] = None,
redundancy_type: typing.Union[str, IResolvable] = None,
vault_storage_class: typing.Union[str, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
replication_source_region_id | typing.Union[str, ros_cdk_core.IResolvable] | Property replicationSourceRegionId: The region ID of the source vault for replication. |
replication_source_vault_id | typing.Union[str, ros_cdk_core.IResolvable] | Property replicationSourceVaultId: The ID of the source vault for replication. |
vault_name | typing.Union[str, ros_cdk_core.IResolvable] | Property vaultName: The name of the vault. |
description | typing.Union[str, ros_cdk_core.IResolvable] | Property description: The description of the vault. |
encrypt_type | typing.Union[str, ros_cdk_core.IResolvable] | Property encryptType: The method that is used to encrypt the source data. |
kms_key_id | typing.Union[str, ros_cdk_core.IResolvable] | Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key. |
redundancy_type | typing.Union[str, ros_cdk_core.IResolvable] | Property redundancyType: The data redundancy type of the backup vault. |
vault_storage_class | typing.Union[str, ros_cdk_core.IResolvable] | Property vaultStorageClass: The storage type of the backup vault. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
replication_source_region_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property replicationSourceRegionId: The region ID of the source vault for replication.
replication_source_vault_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property replicationSourceVaultId: The ID of the source vault for replication.
vault_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vaultName: The name of the vault.
descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the vault.
encrypt_typeOptional
- Type: typing.Union[str, 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).
kms_key_idOptional
- Type: typing.Union[str, 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.
redundancy_typeOptional
- Type: typing.Union[str, 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.
vault_storage_classOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vaultStorageClass: The storage type of the backup vault.
Valid value: STANDARD, which indicates standard storage.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
to_string
def to_string() -> str
Returns a string representation of this construct.
synthesize
def synthesize(
session: ISynthesisSession
) -> None
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: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_hbr
ros_cdk_hbr.ReplicationVault.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_vault_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute VaultId: The ID of the vault. |
props | ReplicationVaultProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: 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
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_vault_idRequired
attr_vault_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute VaultId: The ID of the vault.
propsRequired
props: ReplicationVaultProps
- Type: ReplicationVaultProps