DBCluster

• Implements: IDBCluster

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

Initializers

import { DBCluster } from '@alicloud/ros-cdk-polardb'
new DBCluster(scope: Construct, id: string, props: DBClusterProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Required

• Type: DBClusterProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { DBCluster } from '@alicloud/ros-cdk-polardb'
DBCluster.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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.

ref^Required

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrArn^Required

public readonly attrArn: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attrClusterConnectionString^Required

public readonly attrClusterConnectionString: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ClusterConnectionString: The cluster connection string of the db cluster.

attrClusterEndpointId^Required

public readonly attrClusterEndpointId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ClusterEndpointId: The cluster endpoint ID of the db cluster.

attrColdStorageInstanceId^Required

public readonly attrColdStorageInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ColdStorageInstanceId: The ID of the cold storage instance.

attrCustomConnectionStrings^Required

public readonly attrCustomConnectionStrings: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CustomConnectionStrings: The custom connection strings of the db cluster.

attrCustomEndpointIds^Required

public readonly attrCustomEndpointIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CustomEndpointIds: The custom endpoint IDs of the db cluster.

attrDbClusterDescription^Required

public readonly attrDbClusterDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterDescription: The description of the db cluster.

attrDbClusterId^Required

public readonly attrDbClusterId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBClusterId: The ID of the ApsaraDB for POLARDB cluster.

attrDbNodeIds^Required

public readonly attrDbNodeIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBNodeIds: The ID list of cluster nodes.

attrOrderId^Required

public readonly attrOrderId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute OrderId: The Order ID.

attrPrimaryConnectionString^Required

public readonly attrPrimaryConnectionString: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryConnectionString: The primary connection string of the db cluster.

attrPrimaryConnectionStrings^Required

public readonly attrPrimaryConnectionStrings: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryConnectionStrings: The primary connection strings of the db cluster.

attrPrimaryEndpointId^Required

public readonly attrPrimaryEndpointId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryEndpointId: The primary endpoint ID of the db cluster.

attrPrimaryEndpointIds^Required

public readonly attrPrimaryEndpointIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PrimaryEndpointIds: The primary endpoint IDs of the db cluster.

props^Required

public readonly props: DBClusterProps;

• Type: DBClusterProps