DBInstance

• Implements: github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds.datasource.IDBInstance

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

Initializers

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds/datasource"
datasource.NewDBInstance(scope Construct, id *string, props DBInstanceProps, enableResourcePropertyConstraint *bool) DBInstance

scope^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct

id^Required

• Type: *string

props^Optional

• Type: DBInstanceProps

enableResourcePropertyConstraint^Optional

• Type: *bool

Methods

ToString

func ToString() *string

Returns a string representation of this construct.

Synthesize

func Synthesize(session ISynthesisSession)

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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession

The synthesis session.

AddCondition

func AddCondition(condition RosCondition)

condition^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition

AddCount

func AddCount(count interface{})

count^Required

• Type: interface{}

AddDependency

func AddDependency(resource Resource)

resource^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource

AddResourceDesc

func AddResourceDesc(desc *string)

desc^Required

• Type: *string

ApplyRemovalPolicy

func ApplyRemovalPolicy(policy RemovalPolicy)

policy^Required

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy

FetchCondition

func FetchCondition() RosCondition

FetchDependency

func FetchDependency() *[]*string

FetchResourceDesc

func FetchResourceDesc() *string

GetAtt

func GetAtt(name *string) IResolvable

name^Required

• Type: *string

SetMetadata

func SetMetadata(key *string, value interface{})

key^Required

• Type: *string

value^Required

• Type: interface{}

Static Functions

IsConstruct

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds/datasource"
datasource.DBInstance_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

x^Required

• Type: interface{}

Properties

Node^Required

func Node() ConstructNode

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode

The construct tree node associated with this construct.

Env^Required

func Env() IResourceEnvironment

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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

func Ref() *string

• Type: *string

Stack^Required

func Stack() Stack

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack

The stack in which this resource is defined.

Resource^Optional

func Resource() RosResource

• Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource

AttrAccountMaxQuantity^Required

func AttrAccountMaxQuantity() interface{}

• Type: interface{}

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

AttrAdvancedFeatures^Required

func AttrAdvancedFeatures() interface{}

• Type: interface{}

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

func AttrAutoUpgradeMinorVersion() interface{}

• Type: interface{}

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

func AttrAvailabilityValue() interface{}

• Type: interface{}

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

AttrBabelfishConfig^Required

func AttrBabelfishConfig() interface{}

• Type: interface{}

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

AttrCategory^Required

func AttrCategory() interface{}

• Type: interface{}

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

func AttrCollation() interface{}

• Type: interface{}

Attribute Collation: The character set collation of the instance.

AttrConnectionMode^Required

func AttrConnectionMode() interface{}

• Type: interface{}

Attribute ConnectionMode: The connection mode of the instance.

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

AttrConnectionString^Required

func AttrConnectionString() interface{}

• Type: interface{}

Attribute ConnectionString: The internal endpoint of the instance.

AttrConsoleVersion^Required

func AttrConsoleVersion() interface{}

• Type: interface{}

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

Valid values: 1: shared proxy 2: dedicated proxy

AttrCreationTime^Required

func AttrCreationTime() interface{}

• Type: interface{}

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

func AttrCurrentKernelVersion() interface{}

• Type: interface{}

Attribute CurrentKernelVersion: The minor engine version of the instance.

AttrDbClusterNodes^Required

func AttrDbClusterNodes() interface{}

• Type: interface{}

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

AttrDbInstanceClass^Required

func AttrDbInstanceClass() interface{}

• Type: interface{}

Attribute DBInstanceClass: The instance type of the instance.

AttrDbInstanceClassType^Required

func AttrDbInstanceClassType() interface{}

• Type: interface{}

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

func AttrDbInstanceCpu() interface{}

• Type: interface{}

Attribute DBInstanceCPU: The number of CPU cores.

AttrDbInstanceDescription^Required

func AttrDbInstanceDescription() interface{}

• Type: interface{}

Attribute DBInstanceDescription: The description of the instance.

AttrDbInstanceDiskUsed^Required

func AttrDbInstanceDiskUsed() interface{}

• Type: interface{}

Attribute DBInstanceDiskUsed: The disk usage of the instance.

AttrDbInstanceId^Required

func AttrDbInstanceId() interface{}

• Type: interface{}

Attribute DBInstanceId: The instance ID.

AttrDbInstanceMemory^Required

func AttrDbInstanceMemory() interface{}

• Type: interface{}

Attribute DBInstanceMemory: The memory capacity of the instance.

Unit: MB.

AttrDbInstanceNetType^Required

func AttrDbInstanceNetType() interface{}

• Type: interface{}

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

Valid values: Internet: Internet Intranet: internal network

AttrDbInstanceStatus^Required

func AttrDbInstanceStatus() interface{}

• Type: interface{}

Attribute DBInstanceStatus: The status of the instance.

AttrDbInstanceStorage^Required

func AttrDbInstanceStorage() interface{}

• Type: interface{}

Attribute DBInstanceStorage: The storage capacity of the instance.

Unit: GB.

AttrDbInstanceStorageType^Required

func AttrDbInstanceStorageType() interface{}

• Type: interface{}

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

func AttrDbInstanceType() interface{}

• Type: interface{}

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

func AttrDbMaxQuantity() interface{}

• Type: interface{}

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

AttrDedicatedHostGroupId^Required

func AttrDedicatedHostGroupId() interface{}

• Type: interface{}

Attribute DedicatedHostGroupId: The ID of the dedicated cluster.

AttrDeletionProtection^Required

func AttrDeletionProtection() interface{}

• Type: interface{}

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

Valid values: true false

AttrEngine^Required

func AttrEngine() interface{}

• Type: interface{}

Attribute Engine: The database engine of the instance.

Valid values: MySQL PostgreSQL SQLServer MariaDB

AttrEngineVersion^Required

func AttrEngineVersion() interface{}

• Type: interface{}

Attribute EngineVersion: The database engine version.

AttrExpireTime^Required

func AttrExpireTime() interface{}

• Type: interface{}

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

func AttrExtra() interface{}

• Type: interface{}

Attribute Extra: The extended information of the instance.

AttrGeneralGroupName^Required

func AttrGeneralGroupName() interface{}

• Type: interface{}

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

func AttrGuardDbInstanceId() interface{}

• Type: interface{}

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

AttrIncrementSourceDbInstanceId^Required

func AttrIncrementSourceDbInstanceId() interface{}

• Type: interface{}

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

func AttrInstanceNetworkType() interface{}

• Type: interface{}

Attribute InstanceNetworkType: The network type of the instance.

Valid values: Classic VPC

AttrInstructionSetArch^Required

func AttrInstructionSetArch() interface{}

• Type: interface{}

Attribute InstructionSetArch: The architecture type of the instance.

Valid values: x86 arm

AttrIpType^Required

func AttrIpType() interface{}

• Type: interface{}

Attribute IPType: The type of the IP address.

Only IPv4 addresses are supported.

AttrLatestKernelVersion^Required

func AttrLatestKernelVersion() interface{}

• Type: interface{}

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

AttrLockMode^Required

func AttrLockMode() interface{}

• Type: interface{}

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

func AttrLockReason() interface{}

• Type: interface{}

Attribute LockReason: The reason why the instance was locked.

AttrMaintainTime^Required

func AttrMaintainTime() interface{}

• Type: interface{}

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

func AttrMasterInstanceId() interface{}

• Type: interface{}

Attribute MasterInstanceId: The ID of the primary instance.

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

AttrMasterZone^Required

func AttrMasterZone() interface{}

• Type: interface{}

Attribute MasterZone: The zone ID of the primary instance.

AttrMaxConnections^Required

func AttrMaxConnections() interface{}

• Type: interface{}

Attribute MaxConnections: The maximum number of concurrent connections.

AttrMaxIombps^Required

func AttrMaxIombps() interface{}

• Type: interface{}

Attribute MaxIOMBPS: The maximum I/O throughput.

Unit: MB/s.

AttrMaxIops^Required

func AttrMaxIops() interface{}

• Type: interface{}

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

AttrPayType^Required

func AttrPayType() interface{}

• Type: interface{}

Attribute PayType: The billing method of the instance.

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

AttrPgBouncerEnabled^Required

func AttrPgBouncerEnabled() interface{}

• Type: interface{}

Attribute PGBouncerEnabled: Indicates whether PgBouncer is enabled.

AttrPort^Required

func AttrPort() interface{}

• Type: interface{}

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

AttrProxyType^Required

func AttrProxyType() interface{}

• Type: interface{}

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

func AttrReadOnlyDbInstanceIds() interface{}

• Type: interface{}

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

AttrReadonlyInstanceSqlDelayedTime^Required

func AttrReadonlyInstanceSqlDelayedTime() interface{}

• Type: interface{}

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

func AttrResourceGroupId() interface{}

• Type: interface{}

Attribute ResourceGroupId: The resource group ID.

AttrSecurityIpList^Required

func AttrSecurityIpList() interface{}

• Type: interface{}

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

AttrSecurityIpMode^Required

func AttrSecurityIpMode() interface{}

• Type: interface{}

Attribute SecurityIPMode: The whitelist mode of the instance.

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

AttrServerlessConfig^Required

func AttrServerlessConfig() interface{}

• Type: interface{}

Attribute ServerlessConfig: The settings of the serverless instance.

AttrSlaveZones^Required

func AttrSlaveZones() interface{}

• Type: interface{}

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

AttrSuperPermissionMode^Required

func AttrSuperPermissionMode() interface{}

• Type: interface{}

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

func AttrTempDbInstanceId() interface{}

• Type: interface{}

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

AttrTimeZone^Required

func AttrTimeZone() interface{}

• Type: interface{}

Attribute TimeZone: The time zone of the instance.

AttrTips^Required

func AttrTips() interface{}

• Type: interface{}

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

func AttrTipsLevel() interface{}

• Type: interface{}

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

func AttrVpcCloudInstanceId() interface{}

• Type: interface{}

Attribute VpcCloudInstanceId: The VPC ID.

AttrVpcId^Required

func AttrVpcId() interface{}

• Type: interface{}

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

AttrVSwitchId^Required

func AttrVSwitchId() interface{}

• Type: interface{}

Attribute VSwitchId: The vSwitch ID.

AttrZoneId^Required

func AttrZoneId() interface{}

• Type: interface{}

Attribute ZoneId: The zone ID.

Props^Required

func Props() DBInstanceProps

• Type: DBInstanceProps