Database
- Implements: IDatabase
This class encapsulates and extends the ROS resource type ALIYUN::GPDB::Database.
Initializers
import com.aliyun.ros.cdk.gpdb.Database;
Database.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.databaseName(java.lang.String)
.databaseName(IResolvable)
.dbInstanceId(java.lang.String)
.dbInstanceId(IResolvable)
.owner(java.lang.String)
.owner(IResolvable)
// .characterSetName(java.lang.String)
// .characterSetName(IResolvable)
// .collate(java.lang.String)
// .collate(IResolvable)
// .ctype(java.lang.String)
// .ctype(IResolvable)
// .description(java.lang.String)
// .description(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. |
databaseName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property databaseName: Database Name. |
dbInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dbInstanceId: Instance ID. |
owner | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property owner: Data Sheet owner. |
characterSetName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property characterSetName: Character set, default value is UTF8. |
collate | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property collate: Database locale parameters, specifying string comparison\/collation. |
ctype | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ctype: Database locale parameters, specifying character classification\/case conversion rules. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: Database Description. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
databaseNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property databaseName: Database Name.
dbInstanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbInstanceId: Instance ID.
ownerRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property owner: Data Sheet owner.
characterSetNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property characterSetName: Character set, default value is UTF8.
collateOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property collate: Database locale parameters, specifying string comparison\/collation.
ctypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ctype: Database locale parameters, specifying character classification\/case conversion rules.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: Database Description.
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.gpdb.Database;
Database.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. |
attrAccessPrivilege | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AccessPrivilege: Permission Control Information. |
attrCharacterSetName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CharacterSetName: Character set, default value is UTF8. |
attrCollate | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Collate: Database locale parameters, specifying string comparison/collation. |
attrConnLimit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConnLimit: Maximum connection limit,-1 means unrestricted. |
attrCtype | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Ctype: Database locale parameters, specifying character classification/case conversion rules. |
attrDatabaseName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DatabaseName: Database Name. |
attrDbInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DBInstanceId: Instance ID. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: Database Description. |
attrOwner | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Owner: Data Sheet owner. |
attrSize | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Size: Database size. |
attrTableSpace | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute TableSpace: Database table space. |
props | DatabaseProps | 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
attrAccessPrivilegeRequired
public java.lang.Object getAttrAccessPrivilege();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AccessPrivilege: Permission Control Information.
attrCharacterSetNameRequired
public java.lang.Object getAttrCharacterSetName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CharacterSetName: Character set, default value is UTF8.
attrCollateRequired
public java.lang.Object getAttrCollate();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Collate: Database locale parameters, specifying string comparison/collation.
attrConnLimitRequired
public java.lang.Object getAttrConnLimit();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConnLimit: Maximum connection limit,-1 means unrestricted.
attrCtypeRequired
public java.lang.Object getAttrCtype();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Ctype: Database locale parameters, specifying character classification/case conversion rules.
attrDatabaseNameRequired
public java.lang.Object getAttrDatabaseName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DatabaseName: Database Name.
attrDbInstanceIdRequired
public java.lang.Object getAttrDbInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DBInstanceId: Instance ID.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: Database Description.
attrOwnerRequired
public java.lang.Object getAttrOwner();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Owner: Data Sheet owner.
attrSizeRequired
public java.lang.Object getAttrSize();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Size: Database size.
attrTableSpaceRequired
public java.lang.Object getAttrTableSpace();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute TableSpace: Database table space.
propsRequired
public DatabaseProps getProps();
- Type: DatabaseProps