Skip to content

DbVault

This class encapsulates and extends the ROS resource type ALIYUN::HBR::DbVault, which is used to create a mirror vault.

Initializers

import ros_cdk_hbr
ros_cdk_hbr.DbVault(
  scope: Construct,
  id: str,
  retention_days: typing.Union[typing.Union[int, float], IResolvable],
  vault_name: typing.Union[str, IResolvable],
  vault_region_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
retention_days typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property retentionDays: Data retention days of the vault.
vault_name typing.Union[str, ros_cdk_core.IResolvable] Property vaultName: Display name of the vault.
vault_region_id typing.Union[str, ros_cdk_core.IResolvable] Property vaultRegionId: The region ID to create the vault.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of the vault.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

retention_daysRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property retentionDays: Data retention days of the vault.

Data will be deleted when it's older than this time.


vault_nameRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultName: Display name of the vault.


vault_region_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultRegionId: The region ID to create the vault.


descriptionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: Description of the vault.


tagsOptional

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.


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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • 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.DbVault.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
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_description ros_cdk_core.IResolvable Attribute Description: Description of the vault.
attr_retention_days ros_cdk_core.IResolvable Attribute RetentionDays: Data retention days of the vault.
attr_vault_id ros_cdk_core.IResolvable Attribute VaultId: Vault ID.
attr_vault_name ros_cdk_core.IResolvable Attribute VaultName: Display name of the vault.
attr_vault_region_id ros_cdk_core.IResolvable Attribute VaultRegionId: The region ID to create the vault.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


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_descriptionRequired

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: Description of the vault.


attr_retention_daysRequired

attr_retention_days: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RetentionDays: Data retention days of the vault.

Data will be deleted when it's older than this time.


attr_vault_idRequired

attr_vault_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VaultId: Vault ID.


attr_vault_nameRequired

attr_vault_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VaultName: Display name of the vault.


attr_vault_region_idRequired

attr_vault_region_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VaultRegionId: The region ID to create the vault.