Skip to content

DBClusters

This class encapsulates and extends the ROS resource type DATASOURCE::POLARDB::DBClusters, which is used to query the details of PolarDB clusters.

Initializers 

import com.aliyun.ros.cdk.polardb.datasource.DBClusters;
DBClusters.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .dbClusterId(java.lang.String)
//  .dbClusterId(IResolvable)
//  .dbType(java.lang.String)
//  .dbType(IResolvable)
//  .dbVersion(java.lang.String)
//  .dbVersion(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .expired(java.lang.String)
//  .expired(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(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: The ID of the cluster.
dbType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbType: The database engine that the cluster runs.
dbVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbVersion: The version of the database engine that the cluster runs.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the cluster.
expired java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property expired: Indicates whether the cluster has expired.
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.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbClusterIdOptional

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

Property dbClusterId: The ID of the cluster.

dbTypeOptional

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

Property dbType: The database engine that the cluster runs.

dbVersionOptional

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

Property dbVersion: The version of the database engine that the cluster runs.

The range of the MySQL version number is as follows: *** 5.6 * * * *** 5.7 * * * *** 8.0 * * * The value range of PostgreSQL version number is as follows: *** 11 * * * *** 14 * * * The Oracle version number is 11.

descriptionOptional

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

Property description: The description of the cluster.

expiredOptional

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

Property expired: Indicates whether the cluster has expired.

Valid values: true false

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.

resourceGroupIdOptional

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

Property resourceGroupId: The ID of the resource group.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.polardb.datasource.DBClusters;
DBClusters.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrDbClusterIds com.aliyun.ros.cdk.core.IResolvable Attribute DbClusterIds: The ID of the cluster.
attrDbClusters com.aliyun.ros.cdk.core.IResolvable Attribute DBClusters: The list of db clusters.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

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

attrDbClusterIdsRequired 

public IResolvable getAttrDbClusterIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbClusterIds: The ID of the cluster.

attrDbClustersRequired 

public IResolvable getAttrDbClusters();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DBClusters: The list of db clusters.