SynDb
- Implements: ISynDb
This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::SynDb.
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.List | 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. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
ckPasswordRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ckPassword: The password of the database account.
ckUserNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ckUserName: The account of the clickhouse database.
dbClusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbClusterId: Clickhouse cluster id.
rdsIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property rdsId: The instance id of RDS.
rdsPasswordRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property rdsPassword: The password of the RDS database account.
rdsUserNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property rdsUserName: The account of the RDS database.
skipUnsupportedRequired
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property skipUnsupported: Skip unsupported table or not.
synDbTablesRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
SynDbTablesProperty>
Property synDbTables: The tables to syn.
clickhousePortOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property clickhousePort: The port of clickhouse id.
limitUpperOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property limitUpper: The maximum number of rows to sync per second.
rdsPortOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property rdsPort: The port of rds.
rdsVpcIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property rdsVpcId: The vpc of rds.
rdsVpcUrlOptional
- 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. |
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.clickhouse.SynDb;
SynDb.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. |
attrDbClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbClusterId: The id of clickhouse. |
attrRdsId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute RdsId: The id of RDS. |
attrSynDbs | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SynDbs: Sync Dbs. |
props | SynDbProps | 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
attrDbClusterIdRequired
public java.lang.Object getAttrDbClusterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbClusterId: The id of clickhouse.
attrRdsIdRequired
public java.lang.Object getAttrRdsId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute RdsId: The id of RDS.
attrSynDbsRequired
public java.lang.Object getAttrSynDbs();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SynDbs: Sync Dbs.
propsRequired
public SynDbProps getProps();
- Type: SynDbProps