Skip to content

DBInstanceProps

Properties for defining a DBInstance.

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

Initializer 

import { DBInstanceProps } from '@alicloud/ros-cdk-rds'
const dBInstanceProps: DBInstanceProps = { ... }

Properties

Name Type Description
dbInstanceClass string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceClass: Database instance type.
dbInstanceStorage number | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStorage: The storage capacity of the instance.
engine string | @alicloud/ros-cdk-core.IResolvable Property engine: Database instance engine type.
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: Database instance version of the relative engine type.
securityIpList string | @alicloud/ros-cdk-core.IResolvable Property securityIpList: Security ip to access the database instance, combine with comma, 0.0.0.0\/0 means no limitation.
allocatePublicConnection boolean | @alicloud/ros-cdk-core.IResolvable Property allocatePublicConnection: If true, allocate public connection automate.
archiveBackupKeepCount number | @alicloud/ros-cdk-core.IResolvable Property archiveBackupKeepCount: The number of archived backups that can be retained.
archiveBackupKeepPolicy string | @alicloud/ros-cdk-core.IResolvable Property archiveBackupKeepPolicy: The period for which to retain archived backups.
archiveBackupRetentionPeriod number | @alicloud/ros-cdk-core.IResolvable Property archiveBackupRetentionPeriod: The number of days for which to retain archived backups.
autoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Specifies whether to enable auto-renewal.
backUpCategory string | @alicloud/ros-cdk-core.IResolvable Property backUpCategory: Specifies whether to enable the second-level backup function.
backupPolicyMode string | @alicloud/ros-cdk-core.IResolvable Property backupPolicyMode: Backup type, DataBackupPolicy: data backup LogBackupPolicy: log backup.
backupRetentionPeriod number | @alicloud/ros-cdk-core.IResolvable Property backupRetentionPeriod: The retention period of the data backup.
burstingEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property burstingEnabled: Whether to enable bursting.
category string | @alicloud/ros-cdk-core.IResolvable Property category: The edition of the instance.
coldDataEnabled boolean | @alicloud/ros-cdk-core.IResolvable Property coldDataEnabled: Whether to enable cold data storage.
compressType number | @alicloud/ros-cdk-core.IResolvable Property compressType: The format used to compress backups.
connectionMode string | @alicloud/ros-cdk-core.IResolvable Property connectionMode: Connection Mode for database instance,support 'Standard' and 'Safe' mode.
connectionStringPrefix string | @alicloud/ros-cdk-core.IResolvable Property connectionStringPrefix: The prefix of the endpoint.
connectionStringType string | @alicloud/ros-cdk-core.IResolvable Property connectionStringType: The endpoint type of the instance, allow values: Inner, Public.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: Description of created database instance.
dbInstanceNetType string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceNetType: Database instance net type, default is Intranet.Internet for public access, Intranet for private access.
dbInstanceStorageType string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStorageType: The storage type of the instance.
dbIsIgnoreCase number | @alicloud/ros-cdk-core.IResolvable Property dbIsIgnoreCase: Specifies whether table names are case-sensitive.
dbMappings @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBMappingsProperty[] Property dbMappings: Database mappings to attach to db instance.
dbParamGroupId string | @alicloud/ros-cdk-core.IResolvable Property dbParamGroupId: The ID of the parameter template used by the instance.
dbTimeZone string | @alicloud/ros-cdk-core.IResolvable Property dbTimeZone: The UTC time zone of the instance.
dedicatedHostGroupId string | @alicloud/ros-cdk-core.IResolvable Property dedicatedHostGroupId: The ID of the host group to which the instance belongs if you create an instance in a host group.
enableBackupLog boolean | @alicloud/ros-cdk-core.IResolvable Property enableBackupLog: Specifies whether to enable the log backup function.
encryptionKey string | @alicloud/ros-cdk-core.IResolvable Property encryptionKey: The ID of the encryption key that is used to encrypt data on SSDs in the region.
highSpaceUsageProtection string | @alicloud/ros-cdk-core.IResolvable 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 string | @alicloud/ros-cdk-core.IResolvable Property instanceNetworkType: Instance network type, VPC or Classic.
ioAccelerationEnabled string | @alicloud/ros-cdk-core.IResolvable Property ioAccelerationEnabled: Whether to enable IO Acceleration, 1 for enable 0 for disable.
localLogRetentionHours number | @alicloud/ros-cdk-core.IResolvable Property localLogRetentionHours: The number of hours for which to retain log backup files on the instance.
localLogRetentionSpace number | @alicloud/ros-cdk-core.IResolvable Property localLogRetentionSpace: The maximum percentage of space that is allowed to store log backup files on the instance.
logBackupFrequency string | @alicloud/ros-cdk-core.IResolvable Property logBackupFrequency: The frequency at which to back up logs.
logBackupLocalRetentionNumber number | @alicloud/ros-cdk-core.IResolvable Property logBackupLocalRetentionNumber: The number of log backup files that can be retained on the instance.
logBackupRetentionPeriod number | @alicloud/ros-cdk-core.IResolvable Property logBackupRetentionPeriod: The number of days for which to retain log backup files.
maintainTime string | @alicloud/ros-cdk-core.IResolvable Property maintainTime: The period during which the maintenance performs.
masterUsername string | @alicloud/ros-cdk-core.IResolvable Property masterUsername: The master user name for the database instance.
masterUserPassword string | @alicloud/ros-cdk-core.IResolvable Property masterUserPassword: The master password for the database instance.
masterUserType string | @alicloud/ros-cdk-core.IResolvable Property masterUserType: Privilege type of account.
multiAz boolean | @alicloud/ros-cdk-core.IResolvable Property multiAz: Specifies if the database instance is a multiple Availability Zone deployment.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The charge type of created instance.
period number | @alicloud/ros-cdk-core.IResolvable Property period: The subscription duration.
periodType string | @alicloud/ros-cdk-core.IResolvable Property periodType: Charge period for created instances.
port number | @alicloud/ros-cdk-core.IResolvable Property port: The port of the database service.
preferredBackupPeriod @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property preferredBackupPeriod: The backup period.
preferredBackupTime string | @alicloud/ros-cdk-core.IResolvable Property preferredBackupTime: The time when the backup task is performed.
privateIpAddress string | @alicloud/ros-cdk-core.IResolvable Property privateIpAddress: The private ip for created instance.
releasedKeepPolicy string | @alicloud/ros-cdk-core.IResolvable Property releasedKeepPolicy: The policy used to retain archived backups if the instance is released.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: Resource group id.
roleArn string | @alicloud/ros-cdk-core.IResolvable 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 string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The ID of the ECS security groups.
serverlessConfig @alicloud/ros-cdk-core.IResolvable | ServerlessConfigProperty Property serverlessConfig: The config of RDS serverless instance.
slaveZoneIds @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property slaveZoneIds: List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance.
sqlCollectorStatus string | @alicloud/ros-cdk-core.IResolvable Property sqlCollectorStatus: Specifies whether to enable or disable the SQL Explorer (SQL audit) feature.
sslSetting string | @alicloud/ros-cdk-core.IResolvable Property sslSetting: Secure Sockets Layer (SSL) link setting of the instance.
storageAutoScale string | @alicloud/ros-cdk-core.IResolvable Property storageAutoScale: Storage space automatic expansion switch, only supported by MySQL and PostgreSQL.
storageThreshold number | @alicloud/ros-cdk-core.IResolvable Property storageThreshold: Storage space automatic expansion trigger threshold (percentage).
storageUpperBound number | @alicloud/ros-cdk-core.IResolvable 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 {[ key: string ]: any} Property tags: The tags of an instance.
targetDedicatedHostIdForLog string | @alicloud/ros-cdk-core.IResolvable Property targetDedicatedHostIdForLog: The ID of the host to which the instance belongs if you create a log instance in a host group.
targetDedicatedHostIdForMaster string | @alicloud/ros-cdk-core.IResolvable Property targetDedicatedHostIdForMaster: The ID of the host to which the instance belongs if you create a primary instance in a host group.
targetDedicatedHostIdForSlave string | @alicloud/ros-cdk-core.IResolvable Property targetDedicatedHostIdForSlave: The ID of the host to which the instance belongs if you create a secondary instance in a host group.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC id of created database instance.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch id of created instance.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: selected zone to create database instance.

dbInstanceClassRequired 

public readonly dbInstanceClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

dbInstanceStorageRequired 

public readonly dbInstanceStorage: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

engineRequired 

public readonly engine: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property engine: Database instance engine type.

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

engineVersionRequired 

public readonly engineVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

securityIpListRequired 

public readonly securityIpList: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

allocatePublicConnectionOptional 

public readonly allocatePublicConnection: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property allocatePublicConnection: If true, allocate public connection automate.

archiveBackupKeepCountOptional 

public readonly archiveBackupKeepCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

archiveBackupKeepPolicyOptional 

public readonly archiveBackupKeepPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

archiveBackupRetentionPeriodOptional 

public readonly archiveBackupRetentionPeriod: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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.

backUpCategoryOptional 

public readonly backUpCategory: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

backupPolicyModeOptional 

public readonly backupPolicyMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

backupRetentionPeriodOptional 

public readonly backupRetentionPeriod: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

burstingEnabledOptional 

public readonly burstingEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property burstingEnabled: Whether to enable bursting.

categoryOptional 

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

coldDataEnabledOptional 

public readonly coldDataEnabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property coldDataEnabled: Whether to enable cold data storage.

compressTypeOptional 

public readonly compressType: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

connectionModeOptional 

public readonly connectionMode: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Default is RDS system assigns.

connectionStringPrefixOptional 

public readonly connectionStringPrefix: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 (-).

connectionStringTypeOptional 

public readonly connectionStringType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

dbInstanceDescriptionOptional 

public readonly dbInstanceDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: Description of created database instance.

dbInstanceNetTypeOptional 

public readonly dbInstanceNetType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

dbInstanceStorageTypeOptional 

public readonly dbInstanceStorageType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

dbIsIgnoreCaseOptional 

public readonly dbIsIgnoreCase: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

dbMappingsOptional 

public readonly dbMappings: IResolvable | IResolvable | DBMappingsProperty[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBMappingsProperty[]

Property dbMappings: Database mappings to attach to db instance.

dbParamGroupIdOptional 

public readonly dbParamGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

dbTimeZoneOptional 

public readonly dbTimeZone: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

dedicatedHostGroupIdOptional 

public readonly dedicatedHostGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

enableBackupLogOptional 

public readonly enableBackupLog: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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.

encryptionKeyOptional 

public readonly encryptionKey: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

highSpaceUsageProtectionOptional 

public readonly highSpaceUsageProtection: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

instanceNetworkTypeOptional 

public readonly instanceNetworkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceNetworkType: Instance network type, VPC or Classic.

ioAccelerationEnabledOptional 

public readonly ioAccelerationEnabled: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

localLogRetentionHoursOptional 

public readonly localLogRetentionHours: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

localLogRetentionSpaceOptional 

public readonly localLogRetentionSpace: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

logBackupFrequencyOptional 

public readonly logBackupFrequency: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

logBackupLocalRetentionNumberOptional 

public readonly logBackupLocalRetentionNumber: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

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

logBackupRetentionPeriodOptional 

public readonly logBackupRetentionPeriod: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

maintainTimeOptional 

public readonly maintainTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property maintainTime: The period during which the maintenance performs.

The format is HH:mmZ-HH:mmZ.

masterUsernameOptional 

public readonly masterUsername: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

masterUserPasswordOptional 

public readonly masterUserPassword: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property masterUserPassword: The master password for the database instance.

masterUserTypeOptional 

public readonly masterUserType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

multiAzOptional 

public readonly multiAz: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

payTypeOptional 

public readonly payType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property payType: The charge type of created instance.

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

periodTypeOptional 

public readonly periodType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property periodType: Charge period for created instances.

portOptional 

public readonly port: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property port: The port of the database service.

preferredBackupPeriodOptional 

public readonly preferredBackupPeriod: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

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.

preferredBackupTimeOptional 

public readonly preferredBackupTime: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

privateIpAddressOptional 

public readonly privateIpAddress: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property privateIpAddress: The private ip for created instance.

releasedKeepPolicyOptional 

public readonly releasedKeepPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: Resource group id.

roleArnOptional 

public readonly roleArn: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

securityGroupIdOptional 

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

serverlessConfigOptional 

public readonly serverlessConfig: IResolvable | ServerlessConfigProperty;

Property serverlessConfig: The config of RDS serverless instance.

This is required when creating serverless instance.

slaveZoneIdsOptional 

public readonly slaveZoneIds: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

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".

sqlCollectorStatusOptional 

public readonly sqlCollectorStatus: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values:Enable | Disabled.

sslSettingOptional 

public readonly sslSetting: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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.

storageAutoScaleOptional 

public readonly storageAutoScale: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

storageThresholdOptional 

public readonly storageThreshold: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

storageUpperBoundOptional 

public readonly storageUpperBound: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

tagsOptional 

public readonly tags: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

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.

targetDedicatedHostIdForLogOptional 

public readonly targetDedicatedHostIdForLog: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

targetDedicatedHostIdForMasterOptional 

public readonly targetDedicatedHostIdForMaster: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

targetDedicatedHostIdForSlaveOptional 

public readonly targetDedicatedHostIdForSlave: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The VPC id of created database instance.

For VPC network, the property is required.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch id of created instance.

For VPC network, the property is required.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property zoneId: selected zone to create database instance.

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