DBCluster
- Implements: com.aliyun.ros.cdk.clickhouse.datasource.IDBCluster
This class encapsulates and extends the ROS resource type DATASOURCE::ClickHouse::DBCluster.
Initializers
import com.aliyun.ros.cdk.clickhouse.datasource.DBCluster;
DBCluster.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.dbClusterId(java.lang.String)
.dbClusterId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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. |
dbClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dbClusterId: Instance ID. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
dbClusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbClusterId: Instance ID.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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.datasource.DBCluster;
DBCluster.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. |
attrAliUid | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AliUid: Alibaba Cloud account. |
attrBid | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Bid: The ID of the business process flow. |
attrCategory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Category: Copy configuration, value description:. |
attrCommodityCode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CommodityCode: Buy Product Code. |
attrConnectionString | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConnectionString: Connection string. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDbClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DBClusterId: Instance ID. |
attrDbClusterIpArrayName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DBClusterIPArrayName: The name of the whitelist group to be modified. |
attrDbClusterName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DBClusterName: The cluster description information. |
attrDbClusterNetworkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbClusterNetworkType: Network type. |
attrDbClusterType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DBClusterType: Instance type. |
attrDbNodeClass | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbNodeClass: Set the node type. |
attrDbNodeCount | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:. |
attrDbNodeStorage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbNodeStorage: Single-node storage space. |
attrEncryptionKey | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EncryptionKey: Key management service KMS key ID. |
attrEncryptionType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty. |
attrEngine | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Engine: Engine. |
attrEngineVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EngineVersion: The engine version. |
attrExpireTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExpireTime: The expiration time. |
attrIsExpired | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IsExpired: If the instance has expired. |
attrLockMode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LockMode: The lock mode. |
attrLockReason | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LockReason: Lock reason. |
attrMaintainTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z. |
attrPaymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: The paymen type of the resource. |
attrPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Port: Connection port. |
attrPublicConnectionString | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicConnectionString: A public IP address for the connection. |
attrPublicIpAddr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicIpAddr: Public IP address. |
attrPublicPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicPort: Public network port. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrScaleOutStatus | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ScaleOutStatus: Scale state. |
attrSecurityIps | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecurityIps: The whitelist supports the following two formats:. |
attrStorageType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk. |
attrSupportBackup | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SupportBackup: Support fallback scheme. |
attrSupportHttpsPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SupportHttpsPort: The system supports http port number. |
attrSupportMysqlPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SupportMysqlPort: Supports Mysql, and those of the ports. |
attrSupportOss | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it. |
attrVpcCloudInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: VPC ID. |
attrVpcIpAddr | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcIpAddr: VPC IP address. |
attrVSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VSwitchId: Switch ID. |
attrZoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneId: On behalf of the zone resource attribute field. |
props | DBClusterProps | 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
attrAliUidRequired
public java.lang.Object getAttrAliUid();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AliUid: Alibaba Cloud account.
attrBidRequired
public java.lang.Object getAttrBid();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Bid: The ID of the business process flow.
attrCategoryRequired
public java.lang.Object getAttrCategory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Category: Copy configuration, value description:.
attrCommodityCodeRequired
public java.lang.Object getAttrCommodityCode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CommodityCode: Buy Product Code.
attrConnectionStringRequired
public java.lang.Object getAttrConnectionString();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConnectionString: Connection string.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDbClusterIdRequired
public java.lang.Object getAttrDbClusterId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DBClusterId: Instance ID.
attrDbClusterIpArrayNameRequired
public java.lang.Object getAttrDbClusterIpArrayName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DBClusterIPArrayName: The name of the whitelist group to be modified.
attrDbClusterNameRequired
public java.lang.Object getAttrDbClusterName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DBClusterName: The cluster description information.
attrDbClusterNetworkTypeRequired
public java.lang.Object getAttrDbClusterNetworkType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbClusterNetworkType: Network type.
Currently, only VPC is supported.
attrDbClusterTypeRequired
public java.lang.Object getAttrDbClusterType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DBClusterType: Instance type.
attrDbNodeClassRequired
public java.lang.Object getAttrDbNodeClass();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbNodeClass: Set the node type.
attrDbNodeCountRequired
public java.lang.Object getAttrDbNodeCount();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbNodeCount: Value range: S-Series: 1 to 48 C Series: 1-24 units:.
attrDbNodeStorageRequired
public java.lang.Object getAttrDbNodeStorage();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbNodeStorage: Single-node storage space.
Value range: 100 GB to 32000GB.
attrEncryptionKeyRequired
public java.lang.Object getAttrEncryptionKey();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EncryptionKey: Key management service KMS key ID.
attrEncryptionTypeRequired
public java.lang.Object getAttrEncryptionType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EncryptionType: Currently only supports ECS disk encryption, with a value of CloudDisk, not encrypted when empty.
attrEngineRequired
public java.lang.Object getAttrEngine();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Engine: Engine.
attrEngineVersionRequired
public java.lang.Object getAttrEngineVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EngineVersion: The engine version.
attrExpireTimeRequired
public java.lang.Object getAttrExpireTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExpireTime: The expiration time.
attrIsExpiredRequired
public java.lang.Object getAttrIsExpired();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IsExpired: If the instance has expired.
attrLockModeRequired
public java.lang.Object getAttrLockMode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LockMode: The lock mode.
attrLockReasonRequired
public java.lang.Object getAttrLockReason();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LockReason: Lock reason.
attrMaintainTimeRequired
public java.lang.Object getAttrMaintainTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute MaintainTime: Examples of the maintenance window, in the format of hh:mmZ-hh:mm Z.
attrPaymentTypeRequired
public java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: The paymen type of the resource.
attrPortRequired
public java.lang.Object getAttrPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Port: Connection port.
attrPublicConnectionStringRequired
public java.lang.Object getAttrPublicConnectionString();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicConnectionString: A public IP address for the connection.
attrPublicIpAddrRequired
public java.lang.Object getAttrPublicIpAddr();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicIpAddr: Public IP address.
attrPublicPortRequired
public java.lang.Object getAttrPublicPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicPort: Public network port.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrScaleOutStatusRequired
public java.lang.Object getAttrScaleOutStatus();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ScaleOutStatus: Scale state.
attrSecurityIpsRequired
public java.lang.Object getAttrSecurityIps();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecurityIps: The whitelist supports the following two formats:.
attrStorageTypeRequired
public java.lang.Object getAttrStorageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute StorageType: Storage type CloudSSD:SSD cloud disk CloudEfficiency: Ultra cloud disk.
attrSupportBackupRequired
public java.lang.Object getAttrSupportBackup();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SupportBackup: Support fallback scheme.
attrSupportHttpsPortRequired
public java.lang.Object getAttrSupportHttpsPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SupportHttpsPort: The system supports http port number.
attrSupportMysqlPortRequired
public java.lang.Object getAttrSupportMysqlPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SupportMysqlPort: Supports Mysql, and those of the ports.
attrSupportOssRequired
public java.lang.Object getAttrSupportOss();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SupportOss: Whether hot and cold stratification is supported, 0 means not, and 1st generation table supports it.
attrVpcCloudInstanceIdRequired
public java.lang.Object getAttrVpcCloudInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcCloudInstanceId: Virtual Private Cloud (VPC cloud instance ID.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: VPC ID.
attrVpcIpAddrRequired
public java.lang.Object getAttrVpcIpAddr();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcIpAddr: VPC IP address.
attrVSwitchIdRequired
public java.lang.Object getAttrVSwitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchId: Switch ID.
attrZoneIdRequired
public java.lang.Object getAttrZoneId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneId: On behalf of the zone resource attribute field.
propsRequired
public DBClusterProps getProps();
- Type: DBClusterProps