Skip to content

SynDb

This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::SynDb, which is used to create a synchronization task for an ApsaraDB for ClickHouse Community-compatible Edition cluster.

Initializers 

import ros_cdk_clickhouse
ros_cdk_clickhouse.SynDb(
  scope: Construct,
  id: str,
  ck_password: typing.Union[str, IResolvable],
  ck_user_name: typing.Union[str, IResolvable],
  db_cluster_id: typing.Union[str, IResolvable],
  rds_id: typing.Union[str, IResolvable],
  rds_password: typing.Union[str, IResolvable],
  rds_user_name: typing.Union[str, IResolvable],
  skip_unsupported: typing.Union[bool, IResolvable],
  syn_db_tables: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, SynDbTablesProperty]]],
  clickhouse_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  limit_upper: typing.Union[typing.Union[int, float], IResolvable] = None,
  rds_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  rds_vpc_id: typing.Union[str, IResolvable] = None,
  rds_vpc_url: 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.
ck_password typing.Union[str, ros_cdk_core.IResolvable] Property ckPassword: The password of the database account.
ck_user_name typing.Union[str, ros_cdk_core.IResolvable] Property ckUserName: The account of the clickhouse database.
db_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property dbClusterId: Clickhouse cluster id.
rds_id typing.Union[str, ros_cdk_core.IResolvable] Property rdsId: The instance id of RDS.
rds_password typing.Union[str, ros_cdk_core.IResolvable] Property rdsPassword: The password of the RDS database account.
rds_user_name typing.Union[str, ros_cdk_core.IResolvable] Property rdsUserName: The account of the RDS database.
skip_unsupported typing.Union[bool, ros_cdk_core.IResolvable] Property skipUnsupported: Skip unsupported table or not.
syn_db_tables typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SynDbTablesProperty]]] Property synDbTables: The tables to syn.
clickhouse_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property clickhousePort: The port of clickhouse id.
limit_upper typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property limitUpper: The maximum number of rows to sync per second.
rds_port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property rdsPort: The port of rds.
rds_vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property rdsVpcId: The vpc of rds.
rds_vpc_url typing.Union[str, ros_cdk_core.IResolvable] Property rdsVpcUrl: Intranet address of ApsaraDB for RDS.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ck_passwordRequired

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

Property ckPassword: The password of the database account.

ck_user_nameRequired

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

Property ckUserName: The account of the clickhouse database.

db_cluster_idRequired

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

Property dbClusterId: Clickhouse cluster id.

rds_idRequired

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

Property rdsId: The instance id of RDS.

rds_passwordRequired

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

Property rdsPassword: The password of the RDS database account.

rds_user_nameRequired

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

Property rdsUserName: The account of the RDS database.

skip_unsupportedRequired

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

Property skipUnsupported: Skip unsupported table or not.

syn_db_tablesRequired

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, SynDbTablesProperty]]]

Property synDbTables: The tables to syn.

clickhouse_portOptional

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

Property clickhousePort: The port of clickhouse id.

limit_upperOptional

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

Property limitUpper: The maximum number of rows to sync per second.

rds_portOptional

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

Property rdsPort: The port of rds.

rds_vpc_idOptional

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

Property rdsVpcId: The vpc of rds.

rds_vpc_urlOptional

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

Property rdsVpcUrl: Intranet address of ApsaraDB for RDS.

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_clickhouse
ros_cdk_clickhouse.SynDb.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_db_cluster_id ros_cdk_core.IResolvable Attribute DbClusterId: The id of clickhouse.
attr_rds_id ros_cdk_core.IResolvable Attribute RdsId: The id of RDS.
attr_syn_dbs ros_cdk_core.IResolvable Attribute SynDbs: Sync Dbs.

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_db_cluster_idRequired 

attr_db_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbClusterId: The id of clickhouse.

attr_rds_idRequired 

attr_rds_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RdsId: The id of RDS.

attr_syn_dbsRequired 

attr_syn_dbs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SynDbs: Sync Dbs.

Structs