Skip to content

DBInstanceCloneProps

Properties for defining a DBInstanceClone.

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

Initializer 

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

Properties

Name Type Description
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: Instance id.
payType string | @alicloud/ros-cdk-core.IResolvable Property payType: The charge type of created instance.
allocatePublicConnection boolean | @alicloud/ros-cdk-core.IResolvable Property allocatePublicConnection: If true, allocate public connection automate.
backupId string | @alicloud/ros-cdk-core.IResolvable Property backupId: The ID of the backup set that you want to use.
backupRetentionPeriod number | @alicloud/ros-cdk-core.IResolvable Property backupRetentionPeriod: The retention period of the data backup.
backupType string | @alicloud/ros-cdk-core.IResolvable Property backupType: The type of backup used by the new instance.
category string | @alicloud/ros-cdk-core.IResolvable Property category: The edition of the instance.
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.
dbInstanceClass string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceClass: Database instance type.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: Description of created database instance.
dbInstanceStorage number | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStorage: The storage capacity of the instance.
dbInstanceStorageType string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStorageType: The storage type of the instance.
dbMappings @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBMappingsProperty[] Property dbMappings: Database mappings to attach to db instance.
dbNames string | @alicloud/ros-cdk-core.IResolvable Property dbNames: The names of the databases that you want to create on the new 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.
instanceNetworkType string | @alicloud/ros-cdk-core.IResolvable Property instanceNetworkType: The network type of the new instance.
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.
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.
restoreTable string | @alicloud/ros-cdk-core.IResolvable Property restoreTable: Specifies whether to restore specific databases and tables.
restoreTime string | @alicloud/ros-cdk-core.IResolvable Property restoreTime: The point in time to which you want to restore the data of the original instance.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: The ID of the ECS security groups.
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.
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.
tableMeta @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TableMetaProperty[] Property tableMeta: The information about the databases and tables that you want to restore.
tags {[ key: string ]: any} Property tags: The tags of an instance.
timeoutInMinutes number | @alicloud/ros-cdk-core.IResolvable Property timeoutInMinutes: The timeout period for creating the clone instance resource.
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.

dbInstanceIdRequired 

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

Property dbInstanceId: Instance id.

payTypeRequired 

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

Property payType: The charge type of created instance.

allocatePublicConnectionOptional 

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

Property allocatePublicConnection: If true, allocate public connection automate.

backupIdOptional 

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

Property backupId: The ID of the backup set that you want to use.

You can call the DescribeBackups operation to query the most recent backup set list. Note You must specify at least one of the BackupId and RestoreTime parameters.

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.

backupTypeOptional 

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

Property backupType: The type of backup used by the new instance.

Valid values: - FullBackup: full backup - IncrementalBackup: incremental backup

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

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.

dbInstanceClassOptional 

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

dbInstanceDescriptionOptional 

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

Property dbInstanceDescription: Description of created database instance.

dbInstanceStorageOptional 

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.

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.

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.

dbNamesOptional 

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

Property dbNames: The names of the databases that you want to create on the new instance.

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.

instanceNetworkTypeOptional 

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

Property instanceNetworkType: The network type of the new instance.

Valid values: - VPC - Classic The default value is the network type of the original instance.

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.

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.

restoreTableOptional 

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

Property restoreTable: Specifies whether to restore specific databases and tables.

The value 1 specifies to restore specific databases and tables. If you do not want to restore specific databases or tables, you can choose not to specify this parameter.

restoreTimeOptional 

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

Property restoreTime: The point in time to which you want to restore the data of the original instance.

The point in time must fall within the specified log backup retention period. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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.

securityIpListOptional 

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.

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.

tableMetaOptional 

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

Property tableMeta: The information about the databases and tables that you want to restore.

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.

timeoutInMinutesOptional 

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

Property timeoutInMinutes: The timeout period for creating the clone instance resource.

Unit: Minute. Default: 120.

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.