DBInstanceProps

Properties for defining a DBInstance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-rds-dbinstance

Initializer

using AlibabaCloud.SDK.ROS.CDK.Rds;
new DBInstanceProps {
    object DbInstanceClass,
    object DbInstanceStorage,
    object Engine,
    object EngineVersion,
    object SecurityIpList,
    object AllocatePublicConnection = null,
    object ArchiveBackupKeepCount = null,
    object ArchiveBackupKeepPolicy = null,
    object ArchiveBackupRetentionPeriod = null,
    object AutoRenew = null,
    object BackUpCategory = null,
    object BackupPolicyMode = null,
    object BackupRetentionPeriod = null,
    object BurstingEnabled = null,
    object Category = null,
    object ColdDataEnabled = null,
    object CompressType = null,
    object ConnectionMode = null,
    object ConnectionStringPrefix = null,
    object ConnectionStringType = null,
    object DbInstanceDescription = null,
    object DbInstanceNetType = null,
    object DbInstanceStorageType = null,
    object DbIsIgnoreCase = null,
    object DbMappings = null,
    object DbParamGroupId = null,
    object DbTimeZone = null,
    object DedicatedHostGroupId = null,
    object EnableBackupLog = null,
    object EncryptionKey = null,
    object HighSpaceUsageProtection = null,
    object InstanceNetworkType = null,
    object IoAccelerationEnabled = null,
    object LocalLogRetentionHours = null,
    object LocalLogRetentionSpace = null,
    object LogBackupFrequency = null,
    object LogBackupLocalRetentionNumber = null,
    object LogBackupRetentionPeriod = null,
    object MaintainTime = null,
    object MasterUsername = null,
    object MasterUserPassword = null,
    object MasterUserType = null,
    object MultiAz = null,
    object PayType = null,
    object Period = null,
    object PeriodType = null,
    object Port = null,
    object PreferredBackupPeriod = null,
    object PreferredBackupTime = null,
    object PrivateIpAddress = null,
    object ReleasedKeepPolicy = null,
    object ResourceGroupId = null,
    object RoleArn = null,
    object SecurityGroupId = null,
    object ServerlessConfig = null,
    object SlaveZoneIds = null,
    object SqlCollectorStatus = null,
    object SslSetting = null,
    object StorageAutoScale = null,
    object StorageThreshold = null,
    object StorageUpperBound = null,
    System.Collections.Generic.IDictionary<string, object> Tags = null,
    object TargetDedicatedHostIdForLog = null,
    object TargetDedicatedHostIdForMaster = null,
    object TargetDedicatedHostIdForSlave = null,
    object VpcId = null,
    object VSwitchId = null,
    object ZoneId = null
};

Properties

Name	Type	Description
`DbInstanceClass`	`object`	Property dbInstanceClass: Database instance type.
`DbInstanceStorage`	`object`	Property dbInstanceStorage: The storage capacity of the instance.
`Engine`	`object`	Property engine: Database instance engine type.
`EngineVersion`	`object`	Property engineVersion: Database instance version of the relative engine type.
`SecurityIpList`	`object`	Property securityIpList: Security ip to access the database instance, combine with comma, 0.0.0.0\/0 means no limitation.
`AllocatePublicConnection`	`object`	Property allocatePublicConnection: If true, allocate public connection automate.
`ArchiveBackupKeepCount`	`object`	Property archiveBackupKeepCount: The number of archived backups that can be retained.
`ArchiveBackupKeepPolicy`	`object`	Property archiveBackupKeepPolicy: The period for which to retain archived backups.
`ArchiveBackupRetentionPeriod`	`object`	Property archiveBackupRetentionPeriod: The number of days for which to retain archived backups.
`AutoRenew`	`object`	Property autoRenew: Specifies whether to enable auto-renewal.
`BackUpCategory`	`object`	Property backUpCategory: Specifies whether to enable the second-level backup function.
`BackupPolicyMode`	`object`	Property backupPolicyMode: Backup type, DataBackupPolicy: data backup LogBackupPolicy: log backup.
`BackupRetentionPeriod`	`object`	Property backupRetentionPeriod: The retention period of the data backup.
`BurstingEnabled`	`object`	Property burstingEnabled: Whether to enable bursting.
`Category`	`object`	Property category: The edition of the instance.
`ColdDataEnabled`	`object`	Property coldDataEnabled: Whether to enable cold data storage.
`CompressType`	`object`	Property compressType: The format used to compress backups.
`ConnectionMode`	`object`	Property connectionMode: Connection Mode for database instance,support 'Standard' and 'Safe' mode.
`ConnectionStringPrefix`	`object`	Property connectionStringPrefix: The prefix of the endpoint.
`ConnectionStringType`	`object`	Property connectionStringType: The endpoint type of the instance, allow values: Inner, Public.
`DbInstanceDescription`	`object`	Property dbInstanceDescription: Description of created database instance.
`DbInstanceNetType`	`object`	Property dbInstanceNetType: Database instance net type, default is Intranet.Internet for public access, Intranet for private access.
`DbInstanceStorageType`	`object`	Property dbInstanceStorageType: The storage type of the instance.
`DbIsIgnoreCase`	`object`	Property dbIsIgnoreCase: Specifies whether table names are case-sensitive.
`DbMappings`	`object`	Property dbMappings: Database mappings to attach to db instance.
`DbParamGroupId`	`object`	Property dbParamGroupId: The ID of the parameter template used by the instance.
`DbTimeZone`	`object`	Property dbTimeZone: The UTC time zone of the instance.
`DedicatedHostGroupId`	`object`	Property dedicatedHostGroupId: The ID of the host group to which the instance belongs if you create an instance in a host group.
`EnableBackupLog`	`object`	Property enableBackupLog: Specifies whether to enable the log backup function.
`EncryptionKey`	`object`	Property encryptionKey: The ID of the encryption key that is used to encrypt data on SSDs in the region.
`HighSpaceUsageProtection`	`object`	Property highSpaceUsageProtection: Specifies whether to forcibly delete log backup files when the space usage of the instance exceeds 80% or the remaining space is less than 5 GB.
`InstanceNetworkType`	`object`	Property instanceNetworkType: Instance network type, VPC or Classic.
`IoAccelerationEnabled`	`object`	Property ioAccelerationEnabled: Whether to enable IO Acceleration, 1 for enable 0 for disable.
`LocalLogRetentionHours`	`object`	Property localLogRetentionHours: The number of hours for which to retain log backup files on the instance.
`LocalLogRetentionSpace`	`object`	Property localLogRetentionSpace: The maximum percentage of space that is allowed to store log backup files on the instance.
`LogBackupFrequency`	`object`	Property logBackupFrequency: The frequency at which to back up logs.
`LogBackupLocalRetentionNumber`	`object`	Property logBackupLocalRetentionNumber: The number of log backup files that can be retained on the instance.
`LogBackupRetentionPeriod`	`object`	Property logBackupRetentionPeriod: The number of days for which to retain log backup files.
`MaintainTime`	`object`	Property maintainTime: The period during which the maintenance performs.
`MasterUsername`	`object`	Property masterUsername: The master user name for the database instance.
`MasterUserPassword`	`object`	Property masterUserPassword: The master password for the database instance.
`MasterUserType`	`object`	Property masterUserType: Privilege type of account.
`MultiAz`	`object`	Property multiAz: Specifies if the database instance is a multiple Availability Zone deployment.
`PayType`	`object`	Property payType: The charge type of created instance.
`Period`	`object`	Property period: The subscription duration.
`PeriodType`	`object`	Property periodType: Charge period for created instances.
`Port`	`object`	Property port: The port of the database service.
`PreferredBackupPeriod`	`object`	Property preferredBackupPeriod: The backup period.
`PreferredBackupTime`	`object`	Property preferredBackupTime: The time when the backup task is performed.
`PrivateIpAddress`	`object`	Property privateIpAddress: The private ip for created instance.
`ReleasedKeepPolicy`	`object`	Property releasedKeepPolicy: The policy used to retain archived backups if the instance is released.
`ResourceGroupId`	`object`	Property resourceGroupId: Resource group id.
`RoleArn`	`object`	Property roleArn: The Alibaba Cloud Resource Name (ARN) provided to the service account of the instance by your Alibaba Cloud account to connect to KMS.
`SecurityGroupId`	`object`	Property securityGroupId: The ID of the ECS security groups.
`ServerlessConfig`	`object`	Property serverlessConfig: The config of RDS serverless instance.
`SlaveZoneIds`	`object`	Property slaveZoneIds: List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance.
`SqlCollectorStatus`	`object`	Property sqlCollectorStatus: Specifies whether to enable or disable the SQL Explorer (SQL audit) feature.
`SslSetting`	`object`	Property sslSetting: Secure Sockets Layer (SSL) link setting of the instance.
`StorageAutoScale`	`object`	Property storageAutoScale: Storage space automatic expansion switch, only supported by MySQL and PostgreSQL.
`StorageThreshold`	`object`	Property storageThreshold: Storage space automatic expansion trigger threshold (percentage).
`StorageUpperBound`	`object`	Property storageUpperBound: The total storage space upper limit for automatic storage space expansion, that is, automatic expansion will not cause the total storage space of the instance to exceed this value.
`Tags`	`System.Collections.Generic.IDictionary`	Property tags: The tags of an instance.
`TargetDedicatedHostIdForLog`	`object`	Property targetDedicatedHostIdForLog: The ID of the host to which the instance belongs if you create a log instance in a host group.
`TargetDedicatedHostIdForMaster`	`object`	Property targetDedicatedHostIdForMaster: The ID of the host to which the instance belongs if you create a primary instance in a host group.
`TargetDedicatedHostIdForSlave`	`object`	Property targetDedicatedHostIdForSlave: The ID of the host to which the instance belongs if you create a secondary instance in a host group.
`VpcId`	`object`	Property vpcId: The VPC id of created database instance.
`VSwitchId`	`object`	Property vSwitchId: The vSwitch id of created instance.
`ZoneId`	`object`	Property zoneId: selected zone to create database instance.

`DbInstanceClass`^Required

public object DbInstanceClass { get; set; }

Type: object

Property dbInstanceClass: Database instance type.

Refer the RDS database instance type reference, such as 'rds.mys2.large', 'rds.mss1.large', 'rds.pg.s1.small' etc

`DbInstanceStorage`^Required

public object DbInstanceStorage { get; set; }

Type: object

Property dbInstanceStorage: The storage capacity of the instance.

Unit: GB. The storage capacity increases in increments of 5 GB. You can call the DescribeAvailableResource operation to query the storage capacity range that is supported for a specified instance type in a region.

`Engine`^Required

public object Engine { get; set; }

Type: object

Property engine: Database instance engine type.

Support MySQL/SQLServer/PostgreSQL/PPAS/MariaDB now.

`EngineVersion`^Required

public object EngineVersion { get; set; }

Type: object

Property engineVersion: Database instance version of the relative engine type.

Support: Valid values when you set the Engine parameter to MySQL: 5.5, 5.6, 5.7, and 8.0 Valid values when you set the Engine parameter to SQL Server: 2008r2, 08r2_ent_ha, 2012, 2012_ent_ha, 2012_std_ha, 2012_web, 2014_std_ha, 2016_ent_ha, 2016_std_ha, 2016_web, 2017_std_ha, 2017_ent, 2019_std_ha, and 2019_ent Valid values when you set the Engine parameter to PostgreSQL: 10.0, 11.0, 12.0, 13.0, and 14.0 Valid values when you set the Engine parameter to MariaDB: 10.3

`SecurityIpList`^Required

public object SecurityIpList { get; set; }

Type: object

Property securityIpList: Security ip to access the database instance, combine with comma, 0.0.0.0\/0 means no limitation.

`AllocatePublicConnection`^Optional

public object AllocatePublicConnection { get; set; }

Type: object

Property allocatePublicConnection: If true, allocate public connection automate.

`ArchiveBackupKeepCount`^Optional

public object ArchiveBackupKeepCount { get; set; }

Type: object

Property archiveBackupKeepCount: The number of archived backups that can be retained.

Default value: 1. Valid values: The value of this parameter ranges from 1 to 31 when the ArchiveBackupKeepPolicy parameter is set to ByMonth. The value of this parameter ranges from 1 to 7 when the ArchiveBackupKeepPolicy parameter is set to ByWeek. Note You do not need to specify this parameter when the ArchiveBackupKeepPolicy parameter is set to KeepAll.

`ArchiveBackupKeepPolicy`^Optional

public object ArchiveBackupKeepPolicy { get; set; }

Type: object

Property archiveBackupKeepPolicy: The period for which to retain archived backups.

The number of archived backups that can be retained within the specified period is determined by the ArchiveBackupKeepCount parameter. Default value: 0. Valid values: ByMonth ByWeek KeepAll

`ArchiveBackupRetentionPeriod`^Optional

public object ArchiveBackupRetentionPeriod { get; set; }

Type: object

Property archiveBackupRetentionPeriod: The number of days for which to retain archived backups.

The default value 0 specifies not to enable the backup archiving function. Valid values: 30 to 1095.

`AutoRenew`^Optional

public object AutoRenew { get; set; }

Type: object

Property autoRenew: Specifies whether to enable auto-renewal.

Valid values: true and false. Note :Monthly subscription: The auto-renewal cycle is one month. Annual subscription: The auto-renewal cycle is one year.

`BackUpCategory`^Optional

public object BackUpCategory { get; set; }

Type: object

Property backUpCategory: Specifies whether to enable the second-level backup function.

This function allows a backup to be completed within seconds. Valid values: Flash: specifies to enable the second-level backup function. Standard: specifies to disable the second-level backup function.

`BackupPolicyMode`^Optional

public object BackupPolicyMode { get; set; }

Type: object

Property backupPolicyMode: Backup type, DataBackupPolicy: data backup LogBackupPolicy: log backup.

`BackupRetentionPeriod`^Optional

public object BackupRetentionPeriod { get; set; }

Type: object

Property backupRetentionPeriod: The retention period of the data backup.

Value range: 7 to 730. The default value is the original value. Note When the BackupPolicyMode parameter is set to LogBackupPolicy, this parameter is required.

`BurstingEnabled`^Optional

public object BurstingEnabled { get; set; }

Type: object

Property burstingEnabled: Whether to enable bursting.

`Category`^Optional

public object Category { get; set; }

Type: object

Property category: The edition of the instance.

Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition cluster: RDS Cluster Edition AlwaysOn: RDS Cluster Edition for SQL Server Finance: RDS Enterprise Edition serverless_basic: RDS Serverless Basic Edition

`ColdDataEnabled`^Optional

public object ColdDataEnabled { get; set; }

Type: object

Property coldDataEnabled: Whether to enable cold data storage.

`CompressType`^Optional

public object CompressType { get; set; }

Type: object

Property compressType: The format used to compress backups.

Valid values: 1: The zlib tool is used to compress backups into .tar.gz files. 4: The QuickLZ tool is used to compress backups into .xb.gz files. This compression format is supported only when the instance runs MySQL 5.6 or 5.7. It can be used to restore individual databases and tables. 8: The QuickLZ tool is used to compress backups into .xb.gz files. This compression format is supported only when the instance runs MySQL 8.0. It cannot be used to restore individual databases or tables.

`ConnectionMode`^Optional

public object ConnectionMode { get; set; }

Type: object

Property connectionMode: Connection Mode for database instance,support 'Standard' and 'Safe' mode.

Default is RDS system assigns.

`ConnectionStringPrefix`^Optional

public object ConnectionStringPrefix { get; set; }

Type: object

Property connectionStringPrefix: The prefix of the endpoint.

Only the prefix of the CurrentConnectionString parameter value can be modified. The prefix must be 8 to 64 characters in length and can contain letters, digits, and hyphens (-).

`ConnectionStringType`^Optional

public object ConnectionStringType { get; set; }

Type: object

Property connectionStringType: The endpoint type of the instance, allow values: Inner, Public.

`DbInstanceDescription`^Optional

public object DbInstanceDescription { get; set; }

Type: object

Property dbInstanceDescription: Description of created database instance.

`DbInstanceNetType`^Optional

public object DbInstanceNetType { get; set; }

Type: object

Property dbInstanceNetType: Database instance net type, default is Intranet.Internet for public access, Intranet for private access.

`DbInstanceStorageType`^Optional

public object DbInstanceStorageType { get; set; }

Type: object

Property dbInstanceStorageType: The storage type of the instance.

Valid values: local_ssd: specifies to use local SSDs. This is the recommended storage type. cloud_ssd: specifies to use standard SSDs. cloud_essd: enhanced SSD of performance level (PL)1. cloud_essd2: enhanced SSD of PL2. cloud_essd3: enhanced SSD of PL3.

`DbIsIgnoreCase`^Optional

public object DbIsIgnoreCase { get; set; }

Type: object

Property dbIsIgnoreCase: Specifies whether table names are case-sensitive.

Valid values: 1: Table names are not case-sensitive. This is the default value. 0: Table names are case-sensitive.

`DbMappings`^Optional

public object DbMappings { get; set; }

Type: object

Property dbMappings: Database mappings to attach to db instance.

`DbParamGroupId`^Optional

public object DbParamGroupId { get; set; }

Type: object

Property dbParamGroupId: The ID of the parameter template used by the instance.

`DbTimeZone`^Optional

public object DbTimeZone { get; set; }

Type: object

Property dbTimeZone: The UTC time zone of the instance.

Valid values: -12:00 to +12:00. The time zone must be an integer value such as +08:00. Values such as +08:30 are not allowed.

`DedicatedHostGroupId`^Optional

public object DedicatedHostGroupId { get; set; }

Type: object

Property dedicatedHostGroupId: The ID of the host group to which the instance belongs if you create an instance in a host group.

`EnableBackupLog`^Optional

public object EnableBackupLog { get; set; }

Type: object

Property enableBackupLog: Specifies whether to enable the log backup function.

Valid values: True: specifies to enable the log backup function. False: specifies to disable the log backup function. Note You must specify this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.

`EncryptionKey`^Optional

public object EncryptionKey { get; set; }

Type: object

Property encryptionKey: The ID of the encryption key that is used to encrypt data on SSDs in the region.

You can view the encryption key ID in the Key Management Service (KMS) console. You can also create an encryption key.

`HighSpaceUsageProtection`^Optional

public object HighSpaceUsageProtection { get; set; }

Type: object

Property highSpaceUsageProtection: Specifies whether to forcibly delete log backup files when the space usage of the instance exceeds 80% or the remaining space is less than 5 GB.

Valid values: Enable and Disable. You can retain the default value. Note You must specify this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.

`InstanceNetworkType`^Optional

public object InstanceNetworkType { get; set; }

Type: object

Property instanceNetworkType: Instance network type, VPC or Classic.

`IoAccelerationEnabled`^Optional

public object IoAccelerationEnabled { get; set; }

Type: object

Property ioAccelerationEnabled: Whether to enable IO Acceleration, 1 for enable 0 for disable.

`LocalLogRetentionHours`^Optional

public object LocalLogRetentionHours { get; set; }

Type: object

Property localLogRetentionHours: The number of hours for which to retain log backup files on the instance.

Valid values: 0 to 168. The value 0 specifies not to retain log backup files on the instance. You can retain the default value. Note You must specify this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.

`LocalLogRetentionSpace`^Optional

public object LocalLogRetentionSpace { get; set; }

Type: object

Property localLogRetentionSpace: The maximum percentage of space that is allowed to store log backup files on the instance.

If the space usage for log backup files exceeds this percentage, the system deletes earlier log backup files until the space usage falls below this percentage. Valid values:0 to 50. You can retain the default value. Note You must specify this parameter when the BackupPolicyMode parameter is set to LogBackupPolicy.

`LogBackupFrequency`^Optional

public object LogBackupFrequency { get; set; }

Type: object

Property logBackupFrequency: The frequency at which to back up logs.

Valid values: The value LogInterval specifies to back up logs every 30 minutes. The default value of this parameter is the same as the data backup frequency. Note The value LogInterval is supported only when the instance runs SQL Server.

`LogBackupLocalRetentionNumber`^Optional

public object LogBackupLocalRetentionNumber { get; set; }

Type: object

Property logBackupLocalRetentionNumber: The number of log backup files that can be retained on the instance.

Default value: 60. Valid values: 6 to 100.

`LogBackupRetentionPeriod`^Optional

public object LogBackupRetentionPeriod { get; set; }

Type: object

Property logBackupRetentionPeriod: The number of days for which to retain log backup files.

Valid values: 7 to 730. The log backup retention period cannot be longer than the data backup retention period.Note If you enable the log backup function, you can specify the log backup retention period. This applies only when the instance runs MySQL, PostgreSQL, or PPAS.

`MaintainTime`^Optional

public object MaintainTime { get; set; }

Type: object

Property maintainTime: The period during which the maintenance performs.

The format is HH:mmZ-HH:mmZ.

`MasterUsername`^Optional

public object MasterUsername { get; set; }

Type: object

Property masterUsername: The master user name for the database instance.

`MasterUserPassword`^Optional

public object MasterUserPassword { get; set; }

Type: object

Property masterUserPassword: The master password for the database instance.

`MasterUserType`^Optional

public object MasterUserType { get; set; }

Type: object

Property masterUserType: Privilege type of account.

Normal: Common privilege. Super: High privilege. Sysadmin: Super privileges (SA) (only supported by SQL Server) The default value is Normal.

`MultiAz`^Optional

public object MultiAz { get; set; }

Type: object

Property multiAz: Specifies if the database instance is a multiple Availability Zone deployment.

`PayType`^Optional

public object PayType { get; set; }

Type: object

Property payType: The charge type of created instance.

`Period`^Optional

public object Period { get; set; }

Type: object

Property period: The subscription duration.

Valid values: When PeriodType is Month, it could be from 1 to 12, 24, 36, 48, 60. When PeriodType is Year, it could be from 1 to 5.

`PeriodType`^Optional

public object PeriodType { get; set; }

Type: object

Property periodType: Charge period for created instances.

`Port`^Optional

public object Port { get; set; }

Type: object

Property port: The port of the database service.

`PreferredBackupPeriod`^Optional

public object PreferredBackupPeriod { get; set; }

Type: object

Property preferredBackupPeriod: The backup period.

Separate multiple values with commas (,). The default value is the original value. Valid values:Monday Tuesday Wednesday Thursday Friday Saturday Sunday Note When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter is required.

`PreferredBackupTime`^Optional

public object PreferredBackupTime { get; set; }

Type: object

Property preferredBackupTime: The time when the backup task is performed.

Format: yyyy-MM-ddZ-HH:mm:ssZ.Note When the BackupPolicyMode parameter is set to DataBackupPolicy, this parameter is required.

`PrivateIpAddress`^Optional

public object PrivateIpAddress { get; set; }

Type: object

Property privateIpAddress: The private ip for created instance.

`ReleasedKeepPolicy`^Optional

public object ReleasedKeepPolicy { get; set; }

Type: object

Property releasedKeepPolicy: The policy used to retain archived backups if the instance is released.

Default value: None. Valid values: Lastest: Only the last archived backup is retained. All: All of the archived backups are retained.

`ResourceGroupId`^Optional

public object ResourceGroupId { get; set; }

Type: object

Property resourceGroupId: Resource group id.

`RoleArn`^Optional

public object RoleArn { get; set; }

Type: object

Property roleArn: The Alibaba Cloud Resource Name (ARN) provided to the service account of the instance by your Alibaba Cloud account to connect to KMS.

You can copy the ARN from the RAM console.

`SecurityGroupId`^Optional

public object SecurityGroupId { get; set; }

Type: object

Property securityGroupId: The ID of the ECS security groups.

Each RDS instance can be associated with up to three ECS security groups. You must separate them with commas (,). To delete an ECS Security group, leave this parameter empty.

`ServerlessConfig`^Optional

public object ServerlessConfig { get; set; }

Type: object

Property serverlessConfig: The config of RDS serverless instance.

This is required when creating serverless instance.

`SlaveZoneIds`^Optional

public object SlaveZoneIds { get; set; }

Type: object

Property slaveZoneIds: List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance.

Meanwhile, VSwitchId needs to pass in the corresponding vswitch id to the slave zone by order. For example, ZoneId = "zone-a" and SlaveZoneIds = ["zone-c", "zone-b"], then the VSwitchId must be "vsw-zone-a,vsw-zone-c,vsw-zone-b".

`SqlCollectorStatus`^Optional

public object SqlCollectorStatus { get; set; }

Type: object

Property sqlCollectorStatus: Specifies whether to enable or disable the SQL Explorer (SQL audit) feature.

Valid values:Enable | Disabled.

`SslSetting`^Optional

public object SslSetting { get; set; }

Type: object

Property sslSetting: Secure Sockets Layer (SSL) link setting of the instance.

Valid values: Disabled: Disable SSL EnabledForPublicConnection: Public connection address will be protected by the SSL certificate. It requires AllocatePublicConnection is true. EnabledForInnerConnection: Private connection address will be protected by the SSL certificate. Default value is Disabled.

`StorageAutoScale`^Optional

public object StorageAutoScale { get; set; }

Type: object

Property storageAutoScale: Storage space automatic expansion switch, only supported by MySQL and PostgreSQL.

`StorageThreshold`^Optional

public object StorageThreshold { get; set; }

Type: object

Property storageThreshold: Storage space automatic expansion trigger threshold (percentage).

`StorageUpperBound`^Optional

public object StorageUpperBound { get; set; }

Type: object

Property storageUpperBound: The total storage space upper limit for automatic storage space expansion, that is, automatic expansion will not cause the total storage space of the instance to exceed this value.

`Tags`^Optional

public System.Collections.Generic.IDictionary<string, object> Tags { get; set; }

Type: System.Collections.Generic.IDictionary

Property tags: The tags of an instance.

You should input the information of the tag with the format of the Key-Value, such as {"key1":"value1","key2":"value2", ... "key5":"value5"}. At most 20 tags can be specified. Key It can be up to 64 characters in length. Cannot begin with aliyun. Cannot begin with http:// or https://. Cannot be a null string. Value It can be up to 128 characters in length. Cannot begin with aliyun. Cannot begin with http:// or https://. Can be a null string.

`TargetDedicatedHostIdForLog`^Optional

public object TargetDedicatedHostIdForLog { get; set; }

Type: object

Property targetDedicatedHostIdForLog: The ID of the host to which the instance belongs if you create a log instance in a host group.

`TargetDedicatedHostIdForMaster`^Optional

public object TargetDedicatedHostIdForMaster { get; set; }

Type: object

Property targetDedicatedHostIdForMaster: The ID of the host to which the instance belongs if you create a primary instance in a host group.

`TargetDedicatedHostIdForSlave`^Optional

public object TargetDedicatedHostIdForSlave { get; set; }

Type: object

Property targetDedicatedHostIdForSlave: The ID of the host to which the instance belongs if you create a secondary instance in a host group.

`VpcId`^Optional

public object VpcId { get; set; }

Type: object

Property vpcId: The VPC id of created database instance.

For VPC network, the property is required.

`VSwitchId`^Optional

public object VSwitchId { get; set; }

Type: object

Property vSwitchId: The vSwitch id of created instance.

For VPC network, the property is required.

`ZoneId`^Optional

public object ZoneId { get; set; }

Type: object

Property zoneId: selected zone to create database instance.

You cannot set the ZoneId parameter if the MultiAZ parameter is set to true.

DBInstanceProps

Initializer

Properties

DbInstanceClassRequired

DbInstanceStorageRequired

EngineRequired

EngineVersionRequired

SecurityIpListRequired

AllocatePublicConnectionOptional

ArchiveBackupKeepCountOptional

ArchiveBackupKeepPolicyOptional

ArchiveBackupRetentionPeriodOptional

AutoRenewOptional

BackUpCategoryOptional

BackupPolicyModeOptional

BackupRetentionPeriodOptional

BurstingEnabledOptional

CategoryOptional

ColdDataEnabledOptional

CompressTypeOptional

ConnectionModeOptional

ConnectionStringPrefixOptional

ConnectionStringTypeOptional

DbInstanceDescriptionOptional

DbInstanceNetTypeOptional

DbInstanceStorageTypeOptional

DbIsIgnoreCaseOptional

DbMappingsOptional

DbParamGroupIdOptional

DbTimeZoneOptional

DedicatedHostGroupIdOptional

EnableBackupLogOptional

EncryptionKeyOptional

HighSpaceUsageProtectionOptional

InstanceNetworkTypeOptional

IoAccelerationEnabledOptional

LocalLogRetentionHoursOptional

LocalLogRetentionSpaceOptional

LogBackupFrequencyOptional

LogBackupLocalRetentionNumberOptional

LogBackupRetentionPeriodOptional

MaintainTimeOptional

MasterUsernameOptional

MasterUserPasswordOptional

MasterUserTypeOptional

MultiAzOptional

PayTypeOptional

PeriodOptional

PeriodTypeOptional

PortOptional

PreferredBackupPeriodOptional

PreferredBackupTimeOptional

PrivateIpAddressOptional

ReleasedKeepPolicyOptional

ResourceGroupIdOptional

RoleArnOptional

SecurityGroupIdOptional

ServerlessConfigOptional

SlaveZoneIdsOptional

SqlCollectorStatusOptional

SslSettingOptional

StorageAutoScaleOptional

StorageThresholdOptional

StorageUpperBoundOptional

TagsOptional

TargetDedicatedHostIdForLogOptional

TargetDedicatedHostIdForMasterOptional

TargetDedicatedHostIdForSlaveOptional

VpcIdOptional

VSwitchIdOptional

ZoneIdOptional