DBInstance

• Implements: IDBInstance

This class encapsulates and extends the ROS resource type ALIYUN::SELECTDB::DBInstance, which is used to create an ApsaraDB for SelectDB instance.

Initializers

import com.aliyun.ros.cdk.selectdb.DBInstance;
DBInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .cacheSize(java.lang.Number)
    .cacheSize(IResolvable)
    .chargeType(java.lang.String)
    .chargeType(IResolvable)
    .dbInstanceClass(java.lang.String)
    .dbInstanceClass(IResolvable)
    .engineVersion(java.lang.String)
    .engineVersion(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchId(java.lang.String)
    .vSwitchId(IResolvable)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .accountPassword(java.lang.String)
//  .accountPassword(IResolvable)
//  .connectionString(java.lang.String)
//  .connectionString(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .engine(java.lang.String)
//  .engine(IResolvable)
//  .period(java.lang.String)
//  .period(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .securityIpList(IResolvable)
//  .securityIpList(java.util.List<java.lang.String)
//  .securityIpList(IResolvable>)
//  .tags(java.util.List<TagsProperty>)
//  .usedTime(java.lang.Number)
//  .usedTime(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

cacheSize^Required

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

Property cacheSize: Reserve cache size.

chargeType^Required

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

Property chargeType: The paid type of instance.Value: Postpaid: Postpaid (pay per quantity). Prepaid: Prepaid (year and monthly).

dbInstanceClass^Required

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

Property dbInstanceClass: The class of the DB instance.

Call DescribeAllDBInstanceClass API to check the latest class list

engineVersion^Required

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

Property engineVersion: The database version.

The default value is 4.1. Valid values:

• 4.0
• 4.1

vpcId^Required

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

Property vpcId: VPC id.

vSwitchId^Required

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

Property vSwitchId: Switch ID.

zoneId^Required

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

Property zoneId: Availability Zone ID.

accountPassword^Optional

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

Property accountPassword: The password of the instance login account, the current account name of selectdb can only be admin.

connectionString^Optional

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

Property connectionString: Database connection address.

dbInstanceDescription^Optional

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

Property dbInstanceDescription: Example Notes Information.

engine^Optional

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

Property engine: Database type, default value is selectdb.

period^Optional

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

Property period: Specify the prepaid cluster as annual or monthly type.Value description: Year: Year-end type. Month: Month type. Note This parameter takes effect and is required only if ChargeType is Prepaid.

resourceGroupId^Optional

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

Property resourceGroupId: Resource Group ID.

securityIpList^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property securityIpList: The default IP whitelist of the instance.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: The list of tags in the form of key\/value pairs.

You can define a maximum of 20 tags.

usedTime^Optional

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

Property usedTime: The subscription duration of the subscription instance.

Valid values:

• If Period is set to Year, valid values are 1, 2, 3, 4, and 5.
• If Period is set to Month, valid values are integers from 1 to 12.

This parameter is required and takes effect only when ChargeType is set to Prepaid.

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.selectdb.DBInstance;
DBInstance.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

attrDbInstanceId^Required

public java.lang.Object getAttrDbInstanceId();

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

Attribute DBInstanceId: Instance ID.

attrVpcConnectionString^Required

public java.lang.Object getAttrVpcConnectionString();

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

Attribute VpcConnectionString: The VPC connection string of the selectdb instance.

props^Required

public DBInstanceProps getProps();

• Type: DBInstanceProps