DBInstance

• Implements: AlibabaCloud.SDK.ROS.CDK.Rds.datasource.IDBInstance

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Rds;
new DBInstance(Construct Scope, string Id, DBInstanceProps Props = null, bool EnableResourcePropertyConstraint = null);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

Id^Required

• Type: string

Props^Optional

• Type: DBInstanceProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Rds;
DBInstance.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrAccountMaxQuantity^Required

public object AttrAccountMaxQuantity { get; }

• Type: object

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

AttrAdvancedFeatures^Required

public object AttrAdvancedFeatures { get; }

• Type: object

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 object AttrAutoUpgradeMinorVersion { get; }

• Type: object

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 object AttrAvailabilityValue { get; }

• Type: object

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

AttrBabelfishConfig^Required

public object AttrBabelfishConfig { get; }

• Type: object

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

AttrCategory^Required

public object AttrCategory { get; }

• Type: object

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 object AttrCollation { get; }

• Type: object

Attribute Collation: The character set collation of the instance.

AttrConnectionMode^Required

public object AttrConnectionMode { get; }

• Type: object

Attribute ConnectionMode: The connection mode of the instance.

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

AttrConnectionString^Required

public object AttrConnectionString { get; }

• Type: object

Attribute ConnectionString: The internal endpoint of the instance.

AttrConsoleVersion^Required

public object AttrConsoleVersion { get; }

• Type: object

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

Valid values: 1: shared proxy 2: dedicated proxy

AttrCreationTime^Required

public object AttrCreationTime { get; }

• Type: object

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 object AttrCurrentKernelVersion { get; }

• Type: object

Attribute CurrentKernelVersion: The minor engine version of the instance.

AttrDbClusterNodes^Required

public object AttrDbClusterNodes { get; }

• Type: object

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

AttrDbInstanceClass^Required

public object AttrDbInstanceClass { get; }

• Type: object

Attribute DBInstanceClass: The instance type of the instance.

AttrDbInstanceClassType^Required

public object AttrDbInstanceClassType { get; }

• Type: object

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 object AttrDbInstanceCpu { get; }

• Type: object

Attribute DBInstanceCPU: The number of CPU cores.

AttrDbInstanceDescription^Required

public object AttrDbInstanceDescription { get; }

• Type: object

Attribute DBInstanceDescription: The description of the instance.

AttrDbInstanceDiskUsed^Required

public object AttrDbInstanceDiskUsed { get; }

• Type: object

Attribute DBInstanceDiskUsed: The disk usage of the instance.

AttrDbInstanceId^Required

public object AttrDbInstanceId { get; }

• Type: object

Attribute DBInstanceId: The instance ID.

AttrDbInstanceMemory^Required

public object AttrDbInstanceMemory { get; }

• Type: object

Attribute DBInstanceMemory: The memory capacity of the instance.

Unit: MB.

AttrDbInstanceNetType^Required

public object AttrDbInstanceNetType { get; }

• Type: object

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

Valid values: Internet: Internet Intranet: internal network

AttrDbInstanceStatus^Required

public object AttrDbInstanceStatus { get; }

• Type: object

Attribute DBInstanceStatus: The status of the instance.

AttrDbInstanceStorage^Required

public object AttrDbInstanceStorage { get; }

• Type: object

Attribute DBInstanceStorage: The storage capacity of the instance.

Unit: GB.

AttrDbInstanceStorageType^Required

public object AttrDbInstanceStorageType { get; }

• Type: object

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 object AttrDbInstanceType { get; }

• Type: object

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 object AttrDbMaxQuantity { get; }

• Type: object

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

AttrDedicatedHostGroupId^Required

public object AttrDedicatedHostGroupId { get; }

• Type: object

Attribute DedicatedHostGroupId: The ID of the dedicated cluster.

AttrDeletionProtection^Required

public object AttrDeletionProtection { get; }

• Type: object

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

Valid values: true false

AttrEngine^Required

public object AttrEngine { get; }

• Type: object

Attribute Engine: The database engine of the instance.

Valid values: MySQL PostgreSQL SQLServer MariaDB

AttrEngineVersion^Required

public object AttrEngineVersion { get; }

• Type: object

Attribute EngineVersion: The database engine version.

AttrExpireTime^Required

public object AttrExpireTime { get; }

• Type: object

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 object AttrExtra { get; }

• Type: object

Attribute Extra: The extended information of the instance.

AttrGeneralGroupName^Required

public object AttrGeneralGroupName { get; }

• Type: object

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 object AttrGuardDbInstanceId { get; }

• Type: object

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

AttrIncrementSourceDbInstanceId^Required

public object AttrIncrementSourceDbInstanceId { get; }

• Type: object

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 object AttrInstanceNetworkType { get; }

• Type: object

Attribute InstanceNetworkType: The network type of the instance.

Valid values: Classic VPC

AttrInstructionSetArch^Required

public object AttrInstructionSetArch { get; }

• Type: object

Attribute InstructionSetArch: The architecture type of the instance.

Valid values: x86 arm

AttrIpType^Required

public object AttrIpType { get; }

• Type: object

Attribute IPType: The type of the IP address.

Only IPv4 addresses are supported.

AttrLatestKernelVersion^Required

public object AttrLatestKernelVersion { get; }

• Type: object

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

AttrLockMode^Required

public object AttrLockMode { get; }

• Type: object

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 object AttrLockReason { get; }

• Type: object

Attribute LockReason: The reason why the instance was locked.

AttrMaintainTime^Required

public object AttrMaintainTime { get; }

• Type: object

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 object AttrMasterInstanceId { get; }

• Type: object

Attribute MasterInstanceId: The ID of the primary instance.

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

AttrMasterZone^Required

public object AttrMasterZone { get; }

• Type: object

Attribute MasterZone: The zone ID of the primary instance.

AttrMaxConnections^Required

public object AttrMaxConnections { get; }

• Type: object

Attribute MaxConnections: The maximum number of concurrent connections.

AttrMaxIombps^Required

public object AttrMaxIombps { get; }

• Type: object

Attribute MaxIOMBPS: The maximum I/O throughput.

Unit: MB/s.

AttrMaxIops^Required

public object AttrMaxIops { get; }

• Type: object

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

AttrPayType^Required

public object AttrPayType { get; }

• Type: object

Attribute PayType: The billing method of the instance.

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

AttrPgBouncerEnabled^Required

public object AttrPgBouncerEnabled { get; }

• Type: object

Attribute PGBouncerEnabled: Indicates whether PgBouncer is enabled.

AttrPort^Required

public object AttrPort { get; }

• Type: object

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

AttrProxyType^Required

public object AttrProxyType { get; }

• Type: object

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 object AttrReadOnlyDbInstanceIds { get; }

• Type: object

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

AttrReadonlyInstanceSqlDelayedTime^Required

public object AttrReadonlyInstanceSqlDelayedTime { get; }

• Type: object

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 object AttrResourceGroupId { get; }

• Type: object

Attribute ResourceGroupId: The resource group ID.

AttrSecurityIpList^Required

public object AttrSecurityIpList { get; }

• Type: object

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

AttrSecurityIpMode^Required

public object AttrSecurityIpMode { get; }

• Type: object

Attribute SecurityIPMode: The whitelist mode of the instance.

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

AttrServerlessConfig^Required

public object AttrServerlessConfig { get; }

• Type: object

Attribute ServerlessConfig: The settings of the serverless instance.

AttrSlaveZones^Required

public object AttrSlaveZones { get; }

• Type: object

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

AttrSuperPermissionMode^Required

public object AttrSuperPermissionMode { get; }

• Type: object

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 object AttrTempDbInstanceId { get; }

• Type: object

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

AttrTimeZone^Required

public object AttrTimeZone { get; }

• Type: object

Attribute TimeZone: The time zone of the instance.

AttrTips^Required

public object AttrTips { get; }

• Type: object

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 object AttrTipsLevel { get; }

• Type: object

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 object AttrVpcCloudInstanceId { get; }

• Type: object

Attribute VpcCloudInstanceId: The VPC ID.

AttrVpcId^Required

public object AttrVpcId { get; }

• Type: object

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

AttrVSwitchId^Required

public object AttrVSwitchId { get; }

• Type: object

Attribute VSwitchId: The vSwitch ID.

AttrZoneId^Required

public object AttrZoneId { get; }

• Type: object

Attribute ZoneId: The zone ID.

Props^Required

public DBInstanceProps Props { get; }

• Type: DBInstanceProps