DBInstance

This class encapsulates and extends the ROS resource type DATASOURCE::RDS::DBInstance, which is used to query an ApsaraDB RDS instance.

Initializers

import com.aliyun.ros.cdk.rds.datasource.DBInstance;
DBInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .dbInstanceId(java.lang.String)
//  .dbInstanceId(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 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^Optional

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

Property dbInstanceId: The ID of the 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.rds.datasource.DBInstance;
DBInstance.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.
attrAccountMaxQuantity	com.aliyun.ros.cdk.core.IResolvable	Attribute AccountMaxQuantity: The maximum number of accounts that can be created on the instance.
attrAdvancedFeatures	com.aliyun.ros.cdk.core.IResolvable	Attribute AdvancedFeatures: The advanced features that are enabled for the instance.
attrAutoUpgradeMinorVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute AutoUpgradeMinorVersion: The method that is used to update the minor engine version of the instance.
attrAvailabilityValue	com.aliyun.ros.cdk.core.IResolvable	Attribute AvailabilityValue: The availability status of the instance in percentage.
attrBabelfishConfig	com.aliyun.ros.cdk.core.IResolvable	Attribute BabelfishConfig: The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.
attrCategory	com.aliyun.ros.cdk.core.IResolvable	Attribute Category: The RDS edition of the instance.
attrCollation	com.aliyun.ros.cdk.core.IResolvable	Attribute Collation: The character set collation of the instance.
attrConnectionMode	com.aliyun.ros.cdk.core.IResolvable	Attribute ConnectionMode: The connection mode of the instance.
attrConnectionString	com.aliyun.ros.cdk.core.IResolvable	Attribute ConnectionString: The internal endpoint of the instance.
attrConsoleVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute ConsoleVersion: The type of the proxy that is used by the instance.
attrCreationTime	com.aliyun.ros.cdk.core.IResolvable	Attribute CreationTime: The creation time.
attrCurrentKernelVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute CurrentKernelVersion: The minor engine version of the instance.
attrDbClusterNodes	com.aliyun.ros.cdk.core.IResolvable	Attribute DBClusterNodes: The information about the node in the cluster.
attrDbInstanceClass	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceClass: The instance type of the instance.
attrDbInstanceClassType	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceClassType: The instance family to which the instance belongs.
attrDbInstanceCpu	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceCPU: The number of CPU cores.
attrDbInstanceDescription	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceDescription: The description of the instance.
attrDbInstanceDiskUsed	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceDiskUsed: The disk usage of the instance.
attrDbInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceId: The instance ID.
attrDbInstanceMemory	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceMemory: The memory capacity of the instance.
attrDbInstanceNetType	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceNetType: The type of the network over which the instance is connected.
attrDbInstanceStatus	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceStatus: The status of the instance.
attrDbInstanceStorage	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceStorage: The storage capacity of the instance.
attrDbInstanceStorageType	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceStorageType: The storage type of the instance.
attrDbInstanceType	com.aliyun.ros.cdk.core.IResolvable	Attribute DBInstanceType: The type of the instance.
attrDbMaxQuantity	com.aliyun.ros.cdk.core.IResolvable	Attribute DBMaxQuantity: The maximum number of databases that can be created on the instance.
attrDedicatedHostGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute DedicatedHostGroupId: The ID of the dedicated cluster.
attrDeletionProtection	com.aliyun.ros.cdk.core.IResolvable	Attribute DeletionProtection: Indicates whether the release protection feature is enabled.
attrEngine	com.aliyun.ros.cdk.core.IResolvable	Attribute Engine: The database engine of the instance.
attrEngineVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute EngineVersion: The database engine version.
attrExpireTime	com.aliyun.ros.cdk.core.IResolvable	Attribute ExpireTime: The expiration time.
attrExtra	com.aliyun.ros.cdk.core.IResolvable	Attribute Extra: The extended information of the instance.
attrGeneralGroupName	com.aliyun.ros.cdk.core.IResolvable	Attribute GeneralGroupName: The name of the dedicated cluster to which the instance belongs.
attrGuardDbInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute GuardDBInstanceId: The ID of the disaster recovery instance that is attached to the instance.
attrIncrementSourceDbInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute IncrementSourceDBInstanceId: The ID of the instance from which incremental data comes.
attrInstanceNetworkType	com.aliyun.ros.cdk.core.IResolvable	Attribute InstanceNetworkType: The network type of the instance.
attrInstructionSetArch	com.aliyun.ros.cdk.core.IResolvable	Attribute InstructionSetArch: The architecture type of the instance.
attrIpType	com.aliyun.ros.cdk.core.IResolvable	Attribute IPType: The type of the IP address.
attrLatestKernelVersion	com.aliyun.ros.cdk.core.IResolvable	Attribute LatestKernelVersion: The latest minor engine version that is supported by the instance.
attrLockMode	com.aliyun.ros.cdk.core.IResolvable	Attribute LockMode: The lock mode of the instance.
attrLockReason	com.aliyun.ros.cdk.core.IResolvable	Attribute LockReason: The reason why the instance was locked.
attrMaintainTime	com.aliyun.ros.cdk.core.IResolvable	Attribute MaintainTime: The maintenance window of the instance.
attrMasterInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute MasterInstanceId: The ID of the primary instance.
attrMasterZone	com.aliyun.ros.cdk.core.IResolvable	Attribute MasterZone: The zone ID of the primary instance.
attrMaxConnections	com.aliyun.ros.cdk.core.IResolvable	Attribute MaxConnections: The maximum number of concurrent connections.
attrMaxIombps	com.aliyun.ros.cdk.core.IResolvable	Attribute MaxIOMBPS: The maximum I/O throughput.
attrMaxIops	com.aliyun.ros.cdk.core.IResolvable	Attribute MaxIOPS: The maximum number of I/O requests per second.
attrPayType	com.aliyun.ros.cdk.core.IResolvable	Attribute PayType: The billing method of the instance.
attrPgBouncerEnabled	com.aliyun.ros.cdk.core.IResolvable	Attribute PGBouncerEnabled: Indicates whether PgBouncer is enabled.
attrPort	com.aliyun.ros.cdk.core.IResolvable	Attribute Port: The port that is used to connect to the instance over an internal network.
attrProxyType	com.aliyun.ros.cdk.core.IResolvable	Attribute ProxyType: The type of the proxy that is supported by the instance.
attrReadOnlyDbInstanceIds	com.aliyun.ros.cdk.core.IResolvable	Attribute ReadOnlyDBInstanceIds: The IDs of the read-only instances that are attached to the primary instance.
attrReadonlyInstanceSqlDelayedTime	com.aliyun.ros.cdk.core.IResolvable	Attribute ReadonlyInstanceSQLDelayedTime: The latency at which the system replicates data to read-only instances.
attrResourceGroupId	com.aliyun.ros.cdk.core.IResolvable	Attribute ResourceGroupId: The resource group ID.
attrSecurityIpList	com.aliyun.ros.cdk.core.IResolvable	Attribute SecurityIPList: The IP addresses in the IP address whitelist.
attrSecurityIpMode	com.aliyun.ros.cdk.core.IResolvable	Attribute SecurityIPMode: The whitelist mode of the instance.
attrServerlessConfig	com.aliyun.ros.cdk.core.IResolvable	Attribute ServerlessConfig: The settings of the serverless instance.
attrSlaveZones	com.aliyun.ros.cdk.core.IResolvable	Attribute SlaveZones: The information about the zone of the secondary instance.
attrSuperPermissionMode	com.aliyun.ros.cdk.core.IResolvable	Attribute SuperPermissionMode: Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account.
attrTempDbInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute TempDBInstanceId: The ID of the temporary instance that is attached to the instance.
attrTimeZone	com.aliyun.ros.cdk.core.IResolvable	Attribute TimeZone: The time zone of the instance.
attrTips	com.aliyun.ros.cdk.core.IResolvable	Attribute Tips: The information about the exception that is detected on the instance.
attrTipsLevel	com.aliyun.ros.cdk.core.IResolvable	Attribute TipsLevel: The severity level of the exception that is detected on the instance.
attrVpcCloudInstanceId	com.aliyun.ros.cdk.core.IResolvable	Attribute VpcCloudInstanceId: The VPC ID.
attrVpcId	com.aliyun.ros.cdk.core.IResolvable	Attribute VpcId: The virtual private cloud (VPC) ID of the instance.
attrVSwitchId	com.aliyun.ros.cdk.core.IResolvable	Attribute VSwitchId: The vSwitch ID.
attrZoneId	com.aliyun.ros.cdk.core.IResolvable	Attribute ZoneId: The zone ID.

---

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

---

attrAccountMaxQuantity^Required

public IResolvable getAttrAccountMaxQuantity();

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

Attribute AccountMaxQuantity: The maximum number of accounts that can be created on the instance.

---

attrAdvancedFeatures^Required

public IResolvable getAttrAdvancedFeatures();

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

Attribute AdvancedFeatures: The advanced features that are enabled for the instance.

If multiple advanced features are enabled, the advanced features are separated by commas (,). This parameter is available only to instances that run SQL Server. Valid values: LinkedServer DistributeTransaction

---

attrAutoUpgradeMinorVersion^Required

public IResolvable getAttrAutoUpgradeMinorVersion();

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

Attribute AutoUpgradeMinorVersion: The method that is used to update the minor engine version of the instance.

Valid values: Auto: automatic update. Manual: manual update. The minor engine version of the instance is forcefully updated only when the in-use minor engine version is phased out.

---

attrAvailabilityValue^Required

public IResolvable getAttrAvailabilityValue();

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

Attribute AvailabilityValue: The availability status of the instance in percentage.

---

attrBabelfishConfig^Required

public IResolvable getAttrBabelfishConfig();

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

Attribute BabelfishConfig: The configuration of the Babelfish feature for the ApsaraDB RDS for PostgreSQL instance.

---

attrCategory^Required

public IResolvable getAttrCategory();

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

Attribute Category: The RDS edition of the instance.

Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition cluster: RDS Cluster Edition for ApsaraDB RDS for MySQL AlwaysOn: RDS Cluster Edition for ApsaraDB RDS for SQL Server Finance: RDS Enterprise Edition Serverless_basic: RDS Basic Edition for serverless instances

---

attrCollation^Required

public IResolvable getAttrCollation();

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

Attribute Collation: The character set collation of the instance.

---

attrConnectionMode^Required

public IResolvable getAttrConnectionMode();

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

Attribute ConnectionMode: The connection mode of the instance.

Valid values: Standard: standard mode Safe: database proxy mode

---

attrConnectionString^Required

public IResolvable getAttrConnectionString();

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

Attribute ConnectionString: The internal endpoint of the instance.

---

attrConsoleVersion^Required

public IResolvable getAttrConsoleVersion();

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

Attribute ConsoleVersion: The type of the proxy that is used by the instance.

Valid values: 1: shared proxy 2: dedicated proxy

---

attrCreationTime^Required

public IResolvable getAttrCreationTime();

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

Attribute CreationTime: The creation time.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

---

attrCurrentKernelVersion^Required

public IResolvable getAttrCurrentKernelVersion();

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

Attribute CurrentKernelVersion: The minor engine version of the instance.

---

attrDbClusterNodes^Required

public IResolvable getAttrDbClusterNodes();

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

Attribute DBClusterNodes: The information about the node in the cluster.

---

attrDbInstanceClass^Required

public IResolvable getAttrDbInstanceClass();

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

Attribute DBInstanceClass: The instance type of the instance.

---

attrDbInstanceClassType^Required

public IResolvable getAttrDbInstanceClassType();

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

Attribute DBInstanceClassType: The instance family to which the instance belongs.

Valid values: s: shared instance family x: general-purpose instance family d: dedicated instance family h: dedicated host instance family

---

attrDbInstanceCpu^Required

public IResolvable getAttrDbInstanceCpu();

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

Attribute DBInstanceCPU: The number of CPU cores.

---

attrDbInstanceDescription^Required

public IResolvable getAttrDbInstanceDescription();

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

Attribute DBInstanceDescription: The description of the instance.

---

attrDbInstanceDiskUsed^Required

public IResolvable getAttrDbInstanceDiskUsed();

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

Attribute DBInstanceDiskUsed: The disk usage of the instance.

---

attrDbInstanceId^Required

public IResolvable getAttrDbInstanceId();

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

Attribute DBInstanceId: The instance ID.

---

attrDbInstanceMemory^Required

public IResolvable getAttrDbInstanceMemory();

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

Attribute DBInstanceMemory: The memory capacity of the instance.

Unit: MB.

---

attrDbInstanceNetType^Required

public IResolvable getAttrDbInstanceNetType();

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

Attribute DBInstanceNetType: The type of the network over which the instance is connected.

Valid values: Internet: Internet Intranet: internal network

---

attrDbInstanceStatus^Required

public IResolvable getAttrDbInstanceStatus();

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

Attribute DBInstanceStatus: The status of the instance.

---

attrDbInstanceStorage^Required

public IResolvable getAttrDbInstanceStorage();

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

Attribute DBInstanceStorage: The storage capacity of the instance.

Unit: GB.

---

attrDbInstanceStorageType^Required

public IResolvable getAttrDbInstanceStorageType();

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

Attribute DBInstanceStorageType: The storage type of the instance.

Valid values: local_ssd and ephemeral_ssd: local SSD cloud_ssd: standard SSD cloud_essd: enhanced SSD (ESSD)

---

attrDbInstanceType^Required

public IResolvable getAttrDbInstanceType();

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

Attribute DBInstanceType: The type of the instance.

Valid values: Primary: primary instance Readonly: read-only instance Guard: disaster recovery instance Temp: temporary instance

---

attrDbMaxQuantity^Required

public IResolvable getAttrDbMaxQuantity();

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

Attribute DBMaxQuantity: The maximum number of databases that can be created on the instance.

---

attrDedicatedHostGroupId^Required

public IResolvable getAttrDedicatedHostGroupId();

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

Attribute DedicatedHostGroupId: The ID of the dedicated cluster.

---

attrDeletionProtection^Required

public IResolvable getAttrDeletionProtection();

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

Attribute DeletionProtection: Indicates whether the release protection feature is enabled.

Valid values: true false

---

attrEngine^Required

public IResolvable getAttrEngine();

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

Attribute Engine: The database engine of the instance.

Valid values: MySQL PostgreSQL SQLServer MariaDB

---

attrEngineVersion^Required

public IResolvable getAttrEngineVersion();

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

Attribute EngineVersion: The database engine version.

---

attrExpireTime^Required

public IResolvable getAttrExpireTime();

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

Attribute ExpireTime: The expiration time.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Note: Pay-as-you-go instances never expire.

---

attrExtra^Required

public IResolvable getAttrExtra();

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

Attribute Extra: The extended information of the instance.

---

attrGeneralGroupName^Required

public IResolvable getAttrGeneralGroupName();

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

Attribute GeneralGroupName: The name of the dedicated cluster to which the instance belongs.

This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.

---

attrGuardDbInstanceId^Required

public IResolvable getAttrGuardDbInstanceId();

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

Attribute GuardDBInstanceId: The ID of the disaster recovery instance that is attached to the instance.

---

attrIncrementSourceDbInstanceId^Required

public IResolvable getAttrIncrementSourceDbInstanceId();

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

Attribute IncrementSourceDBInstanceId: The ID of the instance from which incremental data comes.

The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.

---

attrInstanceNetworkType^Required

public IResolvable getAttrInstanceNetworkType();

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

Attribute InstanceNetworkType: The network type of the instance.

Valid values: Classic VPC

---

attrInstructionSetArch^Required

public IResolvable getAttrInstructionSetArch();

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

Attribute InstructionSetArch: The architecture type of the instance.

Valid values: x86 arm

---

attrIpType^Required

public IResolvable getAttrIpType();

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

Attribute IPType: The type of the IP address.

Only IPv4 addresses are supported.

---

attrLatestKernelVersion^Required

public IResolvable getAttrLatestKernelVersion();

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

Attribute LatestKernelVersion: The latest minor engine version that is supported by the instance.

---

attrLockMode^Required

public IResolvable getAttrLockMode();

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

Attribute LockMode: The lock mode of the instance.

Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked due to instance restoration. LockByDiskQuota: The instance is automatically locked due to exhausted storage space. LockReadInstanceByDiskQuota: The instance is a read-only instance and is automatically locked due to exhausted storage.

---

attrLockReason^Required

public IResolvable getAttrLockReason();

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

Attribute LockReason: The reason why the instance was locked.

---

attrMaintainTime^Required

public IResolvable getAttrMaintainTime();

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

Attribute MaintainTime: The maintenance window of the instance.

The time is displayed in UTC. Take note that the maintenance window displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.

---

attrMasterInstanceId^Required

public IResolvable getAttrMasterInstanceId();

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

Attribute MasterInstanceId: The ID of the primary instance.

Note: If this parameter is not returned, the instance is the primary instance.

---

attrMasterZone^Required

public IResolvable getAttrMasterZone();

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

Attribute MasterZone: The zone ID of the primary instance.

---

attrMaxConnections^Required

public IResolvable getAttrMaxConnections();

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

Attribute MaxConnections: The maximum number of concurrent connections.

---

attrMaxIombps^Required

public IResolvable getAttrMaxIombps();

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

Attribute MaxIOMBPS: The maximum I/O throughput.

Unit: MB/s.

---

attrMaxIops^Required

public IResolvable getAttrMaxIops();

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

Attribute MaxIOPS: The maximum number of I/O requests per second.

---

attrPayType^Required

public IResolvable getAttrPayType();

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

Attribute PayType: The billing method of the instance.

Valid values: Postpaid: pay-as-you-go Prepaid: subscription

---

attrPgBouncerEnabled^Required

public IResolvable getAttrPgBouncerEnabled();

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

Attribute PGBouncerEnabled: Indicates whether PgBouncer is enabled.

---

attrPort^Required

public IResolvable getAttrPort();

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

Attribute Port: The port that is used to connect to the instance over an internal network.

---

attrProxyType^Required

public IResolvable getAttrProxyType();

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

Attribute ProxyType: The type of the proxy that is supported by the instance.

Valid values: 0: The instance does not support database proxies. 1: The instance supports shared proxies, with which the instance runs in multi-tenant mode. 2: The instance supports dedicated proxies, with which the instance runs in single-tenant mode.

---

attrReadOnlyDbInstanceIds^Required

public IResolvable getAttrReadOnlyDbInstanceIds();

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

Attribute ReadOnlyDBInstanceIds: The IDs of the read-only instances that are attached to the primary instance.

---

attrReadonlyInstanceSqlDelayedTime^Required

public IResolvable getAttrReadonlyInstanceSqlDelayedTime();

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

Attribute ReadonlyInstanceSQLDelayedTime: The latency at which the system replicates data to read-only instances.

The system replicates data from the primary instance to the read-only instances at the latency that is specified by the ReadonlyInstanceSQLDelayedTime parameter. Unit: seconds.

---

attrResourceGroupId^Required

public IResolvable getAttrResourceGroupId();

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

Attribute ResourceGroupId: The resource group ID.

---

attrSecurityIpList^Required

public IResolvable getAttrSecurityIpList();

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

Attribute SecurityIPList: The IP addresses in the IP address whitelist.

---

attrSecurityIpMode^Required

public IResolvable getAttrSecurityIpMode();

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

Attribute SecurityIPMode: The whitelist mode of the instance.

Valid values: normal: standard whitelist mode safety: enhanced whitelist mode

---

attrServerlessConfig^Required

public IResolvable getAttrServerlessConfig();

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

Attribute ServerlessConfig: The settings of the serverless instance.

---

attrSlaveZones^Required

public IResolvable getAttrSlaveZones();

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

Attribute SlaveZones: The information about the zone of the secondary instance.

---

attrSuperPermissionMode^Required

public IResolvable getAttrSuperPermissionMode();

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

Attribute SuperPermissionMode: Indicates whether the instance supports superuser accounts, such as the system administrator (SA) account, the Active Directory (AD) account, and the host account.

Enable Disabled

---

attrTempDbInstanceId^Required

public IResolvable getAttrTempDbInstanceId();

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

Attribute TempDBInstanceId: The ID of the temporary instance that is attached to the instance.

---

attrTimeZone^Required

public IResolvable getAttrTimeZone();

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

Attribute TimeZone: The time zone of the instance.

---

attrTips^Required

public IResolvable getAttrTips();

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

Attribute Tips: The information about the exception that is detected on the instance.

This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.

---

attrTipsLevel^Required

public IResolvable getAttrTipsLevel();

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

Attribute TipsLevel: The severity level of the exception that is detected on the instance.

This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values: 1: The instance is normal. 2: The specifications of the read-only instances do not match the specifications of the primary instance. You must adjust the specifications of these instances based on your business requirements.

---

attrVpcCloudInstanceId^Required

public IResolvable getAttrVpcCloudInstanceId();

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

Attribute VpcCloudInstanceId: The VPC ID.

---

attrVpcId^Required

public IResolvable getAttrVpcId();

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

Attribute VpcId: The virtual private cloud (VPC) ID of the instance.

---

attrVSwitchId^Required

public IResolvable getAttrVSwitchId();

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

Attribute VSwitchId: The vSwitch ID.

---

attrZoneId^Required

public IResolvable getAttrZoneId();

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

Attribute ZoneId: The zone ID.

---