Database

• Implements: com.aliyun.ros.cdk.dms.datasource.IDatabase

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

Initializers

import com.aliyun.ros.cdk.dms.datasource.Database;
Database.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .host(java.lang.String)
    .host(IResolvable)
    .port(java.lang.Number)
    .port(IResolvable)
    .schemaName(java.lang.String)
    .schemaName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .sid(java.lang.String)
//  .sid(IResolvable)
//  .tid(java.lang.Number)
//  .tid(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

host^Required

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

Property host: Database connection address.

port^Required

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

Property port: Database connection port.

schemaName^Required

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

Property schemaName: Database schema name.

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.

sid^Optional

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

Property sid: Database SID.

tid^Optional

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

Property tid: The tenant ID.

Methods

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

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)

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

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

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

attrCatalogName^Required

public java.lang.Object getAttrCatalogName();

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

Attribute CatalogName: Database catalog name.

attrDatabaseId^Required

public java.lang.Object getAttrDatabaseId();

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

Attribute DatabaseId: Database ID.

attrDbaId^Required

public java.lang.Object getAttrDbaId();

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

Attribute DbaId: Database administrator ID.

attrDbaName^Required

public java.lang.Object getAttrDbaName();

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

Attribute DbaName: Database administrator name.

attrDbType^Required

public java.lang.Object getAttrDbType();

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

Attribute DbType: Database type.

attrEncoding^Required

public java.lang.Object getAttrEncoding();

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

Attribute Encoding: Database encoding.

attrEnvType^Required

public java.lang.Object getAttrEnvType();

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

Attribute EnvType: Database environment type.

attrHost^Required

public java.lang.Object getAttrHost();

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

Attribute Host: Database connection address.

attrInstanceAlias^Required

public java.lang.Object getAttrInstanceAlias();

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

Attribute InstanceAlias: Database instance alias.

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

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

Attribute InstanceId: Database instance ID.

attrOwnerIdList^Required

public java.lang.Object getAttrOwnerIdList();

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

Attribute OwnerIdList: Database owner ID list.

attrOwnerNameList^Required

public java.lang.Object getAttrOwnerNameList();

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

Attribute OwnerNameList: Database owner name list.

attrPort^Required

public java.lang.Object getAttrPort();

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

Attribute Port: Database connection port.

attrSchemaName^Required

public java.lang.Object getAttrSchemaName();

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

Attribute SchemaName: Database schema name.

attrSearchName^Required

public java.lang.Object getAttrSearchName();

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

Attribute SearchName: Database search name.

attrSid^Required

public java.lang.Object getAttrSid();

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

Attribute Sid: Database SID.

attrState^Required

public java.lang.Object getAttrState();

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

Attribute State: Database state.

props^Required

public DatabaseProps getProps();

• Type: DatabaseProps