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 com.aliyun.ros.cdk.clickhouse.SynDb;
SynDb.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .ckPassword(java.lang.String)
    .ckPassword(IResolvable)
    .ckUserName(java.lang.String)
    .ckUserName(IResolvable)
    .dbClusterId(java.lang.String)
    .dbClusterId(IResolvable)
    .rdsId(java.lang.String)
    .rdsId(IResolvable)
    .rdsPassword(java.lang.String)
    .rdsPassword(IResolvable)
    .rdsUserName(java.lang.String)
    .rdsUserName(IResolvable)
    .skipUnsupported(java.lang.Boolean)
    .skipUnsupported(IResolvable)
    .synDbTables(IResolvable)
    .synDbTables(java.util.List<IResolvable)
    .synDbTables(SynDbTablesProperty>)
//  .clickhousePort(java.lang.Number)
//  .clickhousePort(IResolvable)
//  .limitUpper(java.lang.Number)
//  .limitUpper(IResolvable)
//  .rdsPort(java.lang.Number)
//  .rdsPort(IResolvable)
//  .rdsVpcId(java.lang.String)
//  .rdsVpcId(IResolvable)
//  .rdsVpcUrl(java.lang.String)
//  .rdsVpcUrl(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.
`ckPassword`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property ckPassword: The password of the database account.
`ckUserName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property ckUserName: The account of the clickhouse database.
`dbClusterId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property dbClusterId: Clickhouse cluster id.
`rdsId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property rdsId: The instance id of RDS.
`rdsPassword`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property rdsPassword: The password of the RDS database account.
`rdsUserName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property rdsUserName: The account of the RDS database.
`skipUnsupported`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property skipUnsupported: Skip unsupported table or not.
`synDbTables`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSynDbTablesProperty>`	Property synDbTables: The tables to syn.
`clickhousePort`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property clickhousePort: The port of clickhouse id.
`limitUpper`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property limitUpper: The maximum number of rows to sync per second.
`rdsPort`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property rdsPort: The port of rds.
`rdsVpcId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property rdsVpcId: The vpc of rds.
`rdsVpcUrl`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property rdsVpcUrl: Intranet address of ApsaraDB for RDS.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`ckPassword`^Required

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

Property ckPassword: The password of the database account.

`ckUserName`^Required

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

Property ckUserName: The account of the clickhouse database.

`dbClusterId`^Required

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

Property dbClusterId: Clickhouse cluster id.

`rdsId`^Required

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

Property rdsId: The instance id of RDS.

`rdsPassword`^Required

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

Property rdsPassword: The password of the RDS database account.

`rdsUserName`^Required

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

Property rdsUserName: The account of the RDS database.

`skipUnsupported`^Required

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

Property skipUnsupported: Skip unsupported table or not.

`synDbTables`^Required

Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSynDbTablesProperty>

Property synDbTables: The tables to syn.

`clickhousePort`^Optional

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

Property clickhousePort: The port of clickhouse id.

`limitUpper`^Optional

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

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

`rdsPort`^Optional

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

Property rdsPort: The port of rds.

`rdsVpcId`^Optional

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

Property rdsVpcId: The vpc of rds.

`rdsVpcUrl`^Optional

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

Property rdsVpcUrl: Intranet address of ApsaraDB for RDS.

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

session^Required

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

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

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

`addCount`

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

count^Required

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

`addDependency`

public void addDependency(Resource resource)

resource^Required

Type: com.aliyun.ros.cdk.core.Resource

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

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

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`isConstruct`

import com.aliyun.ros.cdk.clickhouse.SynDb;
SynDb.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`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.
`attrDbClusterId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute DbClusterId: The id of clickhouse.
`attrRdsId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute RdsId: The id of RDS.
`attrSynDbs`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute SynDbs: Sync Dbs.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

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

`attrDbClusterId`^Required

public IResolvable getAttrDbClusterId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbClusterId: The id of clickhouse.

`attrRdsId`^Required

public IResolvable getAttrRdsId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RdsId: The id of RDS.

`attrSynDbs`^Required

public IResolvable getAttrSynDbs();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SynDbs: Sync Dbs.

Structs

SynDb

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

ckPasswordRequired

ckUserNameRequired

dbClusterIdRequired

rdsIdRequired

rdsPasswordRequired

rdsUserNameRequired

skipUnsupportedRequired

synDbTablesRequired

clickhousePortOptional

limitUpperOptional

rdsPortOptional

rdsVpcIdOptional

rdsVpcUrlOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata