Skip to content

DBCluster

This class encapsulates and extends the ROS resource type ALIYUN::ClickHouse::DBCluster.

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkclickhouse"
alicloudroscdkclickhouse.NewDBCluster(scope Construct, id *string, props DBClusterProps, enableResourcePropertyConstraint *bool) DBCluster
Name Type Description
scope github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct No description.
id *string No description.
props DBClusterProps No description.
enableResourcePropertyConstraint *bool No description.

scopeRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

idRequired

  • Type: *string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: *bool

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

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.


AddCondition

func AddCondition(condition RosCondition)

conditionRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

countRequired

  • Type: interface{}

AddDependency

func AddDependency(resource Resource)

resourceRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc

func AddResourceDesc(desc *string)

descRequired

  • Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policyRequired

  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

nameRequired

  • Type: *string

SetMetadata

func SetMetadata(key *string, value interface{})

keyRequired

  • Type: *string

valueRequired

  • Type: interface{}

Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkclickhouse"
alicloudroscdkclickhouse.DBCluster_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

xRequired

  • Type: interface{}

Properties

Name Type Description
Node github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode The construct tree node associated with this construct.
Env github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment The environment this resource belongs to.
Ref *string No description.
Stack github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack The stack in which this resource is defined.
Resource github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource No description.
AttrAliUid interface{} Attribute AliUid: AliUid.
AttrBid interface{} Attribute Bid: BusinessID.
AttrCategory interface{} Attribute Category: The edition of the cluster.
AttrCommodityCode interface{} Attribute CommodityCode: Product Code.
AttrConnectionString interface{} Attribute ConnectionString: ConnectionString.
AttrDbClusterDescription interface{} Attribute DBClusterDescription: The description of the cluster.
AttrDbClusterId interface{} Attribute DBClusterId: The id of DBCluster.
AttrDbClusterNetworkType interface{} Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.
AttrDbClusterType interface{} Attribute DBClusterType: The specification of the cluster.
AttrDbClusterVersion interface{} Attribute DBClusterVersion: Version, value: 19.15.2.2.
AttrDbNodeClass interface{} Attribute DBNodeClass: DBNodeClass.
AttrDbNodeCount interface{} Attribute DBNodeCount: The number of nodes.
AttrDbNodeStorage interface{} Attribute DBNodeStorage: The storage capacity of a single node.
AttrDbNodeStorageType interface{} Attribute DbNodeStorageType: Instance node storage type.
AttrEncryptionKey interface{} Attribute EncryptionKey: KMS key ID.
AttrEncryptionType interface{} Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.
AttrEngine interface{} Attribute Engine: Engine.
AttrEngineVersion interface{} Attribute EngineVersion: EngineVersion.
AttrIsExpired interface{} Attribute IsExpired: IsExpired.
AttrLockMode interface{} Attribute LockMode: LockMode.
AttrLockReason interface{} Attribute LockReason: Reason for lock.
AttrPaymentType interface{} Attribute PaymentType: PayType.
AttrPeriod interface{} Attribute Period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.
AttrPort interface{} Attribute Port: Connection port.
AttrPublicConnectionString interface{} Attribute PublicConnectionString: Internet connection address.
AttrPublicPort interface{} Attribute PublicPort: PublicPort.
AttrStorageType interface{} Attribute StorageType: StorageType.
AttrVpcCloudInstanceId interface{} Attribute VpcCloudInstanceId: VpcCloudInstanceId.
AttrVpcId interface{} Attribute VpcId: VpcId.
AttrVSwitchId interface{} Attribute VSwitchId: VSwitchId.
AttrZoneId interface{} Attribute ZoneId: ZoneId.
Props DBClusterProps No description.

NodeRequired

func Node() ConstructNode
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.


EnvRequired

func Env() IResourceEnvironment
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func Ref() *string
  • Type: *string

StackRequired

func Stack() Stack
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.


ResourceOptional

func Resource() RosResource
  • Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrAliUidRequired

func AttrAliUid() interface{}
  • Type: interface{}

Attribute AliUid: AliUid.


AttrBidRequired

func AttrBid() interface{}
  • Type: interface{}

Attribute Bid: BusinessID.


AttrCategoryRequired

func AttrCategory() interface{}
  • Type: interface{}

Attribute Category: The edition of the cluster.


AttrCommodityCodeRequired

func AttrCommodityCode() interface{}
  • Type: interface{}

Attribute CommodityCode: Product Code.


AttrConnectionStringRequired

func AttrConnectionString() interface{}
  • Type: interface{}

Attribute ConnectionString: ConnectionString.


AttrDbClusterDescriptionRequired

func AttrDbClusterDescription() interface{}
  • Type: interface{}

Attribute DBClusterDescription: The description of the cluster.


AttrDbClusterIdRequired

func AttrDbClusterId() interface{}
  • Type: interface{}

Attribute DBClusterId: The id of DBCluster.


AttrDbClusterNetworkTypeRequired

func AttrDbClusterNetworkType() interface{}
  • Type: interface{}

Attribute DBClusterNetworkType: Network type of the cluster instance, value: VPC.


AttrDbClusterTypeRequired

func AttrDbClusterType() interface{}
  • Type: interface{}

Attribute DBClusterType: The specification of the cluster.


AttrDbClusterVersionRequired

func AttrDbClusterVersion() interface{}
  • Type: interface{}

Attribute DBClusterVersion: Version, value: 19.15.2.2.


AttrDbNodeClassRequired

func AttrDbNodeClass() interface{}
  • Type: interface{}

Attribute DBNodeClass: DBNodeClass.


AttrDbNodeCountRequired

func AttrDbNodeCount() interface{}
  • Type: interface{}

Attribute DBNodeCount: The number of nodes.


AttrDbNodeStorageRequired

func AttrDbNodeStorage() interface{}
  • Type: interface{}

Attribute DBNodeStorage: The storage capacity of a single node.


AttrDbNodeStorageTypeRequired

func AttrDbNodeStorageType() interface{}
  • Type: interface{}

Attribute DbNodeStorageType: Instance node storage type.

Valid values: cloud_essd, cloud_efficiency.


AttrEncryptionKeyRequired

func AttrEncryptionKey() interface{}
  • Type: interface{}

Attribute EncryptionKey: KMS key ID.


AttrEncryptionTypeRequired

func AttrEncryptionType() interface{}
  • Type: interface{}

Attribute EncryptionType: Kms key type, only cloud disk encryption is supported and the value is CloudDisk.


AttrEngineRequired

func AttrEngine() interface{}
  • Type: interface{}

Attribute Engine: Engine.


AttrEngineVersionRequired

func AttrEngineVersion() interface{}
  • Type: interface{}

Attribute EngineVersion: EngineVersion.


AttrIsExpiredRequired

func AttrIsExpired() interface{}
  • Type: interface{}

Attribute IsExpired: IsExpired.


AttrLockModeRequired

func AttrLockMode() interface{}
  • Type: interface{}

Attribute LockMode: LockMode.


AttrLockReasonRequired

func AttrLockReason() interface{}
  • Type: interface{}

Attribute LockReason: Reason for lock.


AttrPaymentTypeRequired

func AttrPaymentType() interface{}
  • Type: interface{}

Attribute PaymentType: PayType.


AttrPeriodRequired

func AttrPeriod() interface{}
  • Type: interface{}

Attribute Period: Prepaid time period.If the payment type is Prepaid, this parameter is mandatory. Specify the prepaid cluster as a yearly or monthly type. Valid values: Year, Month.


AttrPortRequired

func AttrPort() interface{}
  • Type: interface{}

Attribute Port: Connection port.


AttrPublicConnectionStringRequired

func AttrPublicConnectionString() interface{}
  • Type: interface{}

Attribute PublicConnectionString: Internet connection address.


AttrPublicPortRequired

func AttrPublicPort() interface{}
  • Type: interface{}

Attribute PublicPort: PublicPort.


AttrStorageTypeRequired

func AttrStorageType() interface{}
  • Type: interface{}

Attribute StorageType: StorageType.


AttrVpcCloudInstanceIdRequired

func AttrVpcCloudInstanceId() interface{}
  • Type: interface{}

Attribute VpcCloudInstanceId: VpcCloudInstanceId.


AttrVpcIdRequired

func AttrVpcId() interface{}
  • Type: interface{}

Attribute VpcId: VpcId.


AttrVSwitchIdRequired

func AttrVSwitchId() interface{}
  • Type: interface{}

Attribute VSwitchId: VSwitchId.


AttrZoneIdRequired

func AttrZoneId() interface{}
  • Type: interface{}

Attribute ZoneId: ZoneId.


PropsRequired

func Props() DBClusterProps