Database

This class encapsulates and extends the ROS resource type DATASOURCE::PolarDBX::Database.

Initializers

import com.aliyun.ros.cdk.polardbx.datasource.Database;
Database.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .polarDbxDatabaseName(java.lang.String)
    .polarDbxDatabaseName(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.
dbInstanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property dbInstanceId: The ID of the PolarDB-X 2.0 instance.
polarDbxDatabaseName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property polarDbxDatabaseName: The name of the PolarDB-X 2.0 instance.
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.

---

scope^Required

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

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

dbInstanceId^Required

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

Property dbInstanceId: The ID of the PolarDB-X 2.0 instance.

---

polarDbxDatabaseName^Required

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

Property polarDbxDatabaseName: The name of the PolarDB-X 2.0 instance.

---

refreshOptions^Optional

• 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.
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.

session^Required

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

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

---

addCount

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

count^Required

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

---

addDependency

public void addDependency(Resource resource)

resource^Required

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

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

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

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.polardbx.datasource.Database;
Database.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• 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.
attrAccounts	com.aliyun.ros.cdk.core.IResolvable	Attribute Accounts: The list of accounts that can be used to access the database.
attrCharacterSetName	com.aliyun.ros.cdk.core.IResolvable	Attribute CharacterSetName: The character set that is supported by the database.
attrDatabaseDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute DatabaseDescription: The description of the database.
attrDbInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceId: The ID of the PolarDB-X 2.0 instance.
attrPolarDbxDatabaseName	com.aliyun.ros.cdk.core.IResolvable	Attribute PolarDBXDatabaseName: The name of the PolarDB-X instance.

---

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

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

---

attrAccounts^Required

public IResolvable getAttrAccounts();

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

Attribute Accounts: The list of accounts that can be used to access the database.

---

attrCharacterSetName^Required

public IResolvable getAttrCharacterSetName();

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

Attribute CharacterSetName: The character set that is supported by the database.

---

attrDatabaseDescription^Required

public IResolvable getAttrDatabaseDescription();

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

Attribute DatabaseDescription: The description of the database.

---

attrDbInstanceId^Required

public IResolvable getAttrDbInstanceId();

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

Attribute DBInstanceId: The ID of the PolarDB-X 2.0 instance.

---

attrPolarDbxDatabaseName^Required

public IResolvable getAttrPolarDbxDatabaseName();

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

Attribute PolarDBXDatabaseName: The name of the PolarDB-X instance.

---