DBInstance

• Implements: @alicloud/ros-cdk-rds.datasource.IDBInstance

This class encapsulates and extends the ROS resource type DATASOURCE::RDS::DBInstance.

Initializers

import { datasource } from '@alicloud/ros-cdk-rds'
new datasource.DBInstance(scope: Construct, id: string, props?: DBInstanceProps, enableResourcePropertyConstraint?: boolean)

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

id^Required

• Type: string

props^Optional

• Type: DBInstanceProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

import { datasource } from '@alicloud/ros-cdk-rds'
datasource.DBInstance.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

attrAccountMaxQuantity^Required

public readonly attrAccountMaxQuantity: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrAdvancedFeatures^Required

public readonly attrAdvancedFeatures: string | IResolvable;

• Type: string | @alicloud/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 readonly attrAutoUpgradeMinorVersion: string | IResolvable;

• Type: string | @alicloud/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 readonly attrAvailabilityValue: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrBabelfishConfig^Required

public readonly attrBabelfishConfig: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrCategory^Required

public readonly attrCategory: string | IResolvable;

• Type: string | @alicloud/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 readonly attrCollation: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Collation: The character set collation of the instance.

attrConnectionMode^Required

public readonly attrConnectionMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConnectionMode: The connection mode of the instance.

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

attrConnectionString^Required

public readonly attrConnectionString: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ConnectionString: The internal endpoint of the instance.

attrConsoleVersion^Required

public readonly attrConsoleVersion: string | IResolvable;

• Type: string | @alicloud/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 readonly attrCreationTime: string | IResolvable;

• Type: string | @alicloud/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 readonly attrCurrentKernelVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute CurrentKernelVersion: The minor engine version of the instance.

attrDbClusterNodes^Required

public readonly attrDbClusterNodes: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrDbInstanceClass^Required

public readonly attrDbInstanceClass: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceClass: The instance type of the instance.

attrDbInstanceClassType^Required

public readonly attrDbInstanceClassType: string | IResolvable;

• Type: string | @alicloud/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 readonly attrDbInstanceCpu: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceCPU: The number of CPU cores.

attrDbInstanceDescription^Required

public readonly attrDbInstanceDescription: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceDescription: The description of the instance.

attrDbInstanceDiskUsed^Required

public readonly attrDbInstanceDiskUsed: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceDiskUsed: The disk usage of the instance.

attrDbInstanceId^Required

public readonly attrDbInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceId: The instance ID.

attrDbInstanceMemory^Required

public readonly attrDbInstanceMemory: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceMemory: The memory capacity of the instance.

Unit: MB.

attrDbInstanceNetType^Required

public readonly attrDbInstanceNetType: string | IResolvable;

• Type: string | @alicloud/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 readonly attrDbInstanceStatus: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceStatus: The status of the instance.

attrDbInstanceStorage^Required

public readonly attrDbInstanceStorage: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceStorage: The storage capacity of the instance.

Unit: GB.

attrDbInstanceStorageType^Required

public readonly attrDbInstanceStorageType: string | IResolvable;

• Type: string | @alicloud/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 readonly attrDbInstanceType: string | IResolvable;

• Type: string | @alicloud/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 readonly attrDbMaxQuantity: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrDedicatedHostGroupId^Required

public readonly attrDedicatedHostGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DedicatedHostGroupId: The ID of the dedicated cluster.

attrDeletionProtection^Required

public readonly attrDeletionProtection: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: true false

attrEngine^Required

public readonly attrEngine: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Engine: The database engine of the instance.

Valid values: MySQL PostgreSQL SQLServer MariaDB

attrEngineVersion^Required

public readonly attrEngineVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute EngineVersion: The database engine version.

attrExpireTime^Required

public readonly attrExpireTime: string | IResolvable;

• Type: string | @alicloud/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 readonly attrExtra: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Extra: The extended information of the instance.

attrGeneralGroupName^Required

public readonly attrGeneralGroupName: string | IResolvable;

• Type: string | @alicloud/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 readonly attrGuardDbInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrIncrementSourceDbInstanceId^Required

public readonly attrIncrementSourceDbInstanceId: string | IResolvable;

• Type: string | @alicloud/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 readonly attrInstanceNetworkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InstanceNetworkType: The network type of the instance.

Valid values: Classic VPC

attrInstructionSetArch^Required

public readonly attrInstructionSetArch: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InstructionSetArch: The architecture type of the instance.

Valid values: x86 arm

attrIpType^Required

public readonly attrIpType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute IPType: The type of the IP address.

Only IPv4 addresses are supported.

attrLatestKernelVersion^Required

public readonly attrLatestKernelVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrLockMode^Required

public readonly attrLockMode: string | IResolvable;

• Type: string | @alicloud/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 readonly attrLockReason: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute LockReason: The reason why the instance was locked.

attrMaintainTime^Required

public readonly attrMaintainTime: string | IResolvable;

• Type: string | @alicloud/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 readonly attrMasterInstanceId: string | IResolvable;

• Type: string | @alicloud/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 readonly attrMasterZone: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MasterZone: The zone ID of the primary instance.

attrMaxConnections^Required

public readonly attrMaxConnections: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MaxConnections: The maximum number of concurrent connections.

attrMaxIombps^Required

public readonly attrMaxIombps: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute MaxIOMBPS: The maximum I/O throughput.

Unit: MB/s.

attrMaxIops^Required

public readonly attrMaxIops: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrPayType^Required

public readonly attrPayType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PayType: The billing method of the instance.

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

attrPgBouncerEnabled^Required

public readonly attrPgBouncerEnabled: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute PGBouncerEnabled: Indicates whether PgBouncer is enabled.

attrPort^Required

public readonly attrPort: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrProxyType^Required

public readonly attrProxyType: string | IResolvable;

• Type: string | @alicloud/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 readonly attrReadOnlyDbInstanceIds: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrReadonlyInstanceSqlDelayedTime^Required

public readonly attrReadonlyInstanceSqlDelayedTime: string | IResolvable;

• Type: string | @alicloud/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 readonly attrResourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The resource group ID.

attrSecurityIpList^Required

public readonly attrSecurityIpList: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrSecurityIpMode^Required

public readonly attrSecurityIpMode: string | IResolvable;

• Type: string | @alicloud/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 readonly attrServerlessConfig: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ServerlessConfig: The settings of the serverless instance.

attrSlaveZones^Required

public readonly attrSlaveZones: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrSuperPermissionMode^Required

public readonly attrSuperPermissionMode: string | IResolvable;

• Type: string | @alicloud/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 readonly attrTempDbInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrTimeZone^Required

public readonly attrTimeZone: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TimeZone: The time zone of the instance.

attrTips^Required

public readonly attrTips: string | IResolvable;

• Type: string | @alicloud/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 readonly attrTipsLevel: string | IResolvable;

• Type: string | @alicloud/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 readonly attrVpcCloudInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VpcCloudInstanceId: The VPC ID.

attrVpcId^Required

public readonly attrVpcId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

attrVSwitchId^Required

public readonly attrVSwitchId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: The vSwitch ID.

attrZoneId^Required

public readonly attrZoneId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The zone ID.

props^Required

public readonly props: DBInstanceProps;

• Type: DBInstanceProps