Skip to content

DBInstanceCloneProps

Properties for defining a DBInstanceClone.

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

Initializer 

import com.aliyun.ros.cdk.rds.DBInstanceCloneProps;
DBInstanceCloneProps.builder()
    .dbInstanceId(java.lang.String)
    .dbInstanceId(IResolvable)
    .payType(java.lang.String)
    .payType(IResolvable)
//  .allocatePublicConnection(java.lang.Boolean)
//  .allocatePublicConnection(IResolvable)
//  .backupId(java.lang.String)
//  .backupId(IResolvable)
//  .backupRetentionPeriod(java.lang.Number)
//  .backupRetentionPeriod(IResolvable)
//  .backupType(java.lang.String)
//  .backupType(IResolvable)
//  .category(java.lang.String)
//  .category(IResolvable)
//  .connectionStringPrefix(java.lang.String)
//  .connectionStringPrefix(IResolvable)
//  .connectionStringType(java.lang.String)
//  .connectionStringType(IResolvable)
//  .dbInstanceClass(java.lang.String)
//  .dbInstanceClass(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceStorage(java.lang.Number)
//  .dbInstanceStorage(IResolvable)
//  .dbInstanceStorageType(java.lang.String)
//  .dbInstanceStorageType(IResolvable)
//  .dbMappings(IResolvable)
//  .dbMappings(java.util.List<IResolvable)
//  .dbMappings(DBMappingsProperty>)
//  .dbNames(java.lang.String)
//  .dbNames(IResolvable)
//  .dedicatedHostGroupId(java.lang.String)
//  .dedicatedHostGroupId(IResolvable)
//  .instanceNetworkType(java.lang.String)
//  .instanceNetworkType(IResolvable)
//  .maintainTime(java.lang.String)
//  .maintainTime(IResolvable)
//  .masterUsername(java.lang.String)
//  .masterUsername(IResolvable)
//  .masterUserPassword(java.lang.String)
//  .masterUserPassword(IResolvable)
//  .masterUserType(java.lang.String)
//  .masterUserType(IResolvable)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodType(java.lang.String)
//  .periodType(IResolvable)
//  .port(java.lang.Number)
//  .port(IResolvable)
//  .preferredBackupPeriod(IResolvable)
//  .preferredBackupPeriod(java.util.List<java.lang.String)
//  .preferredBackupPeriod(IResolvable>)
//  .preferredBackupTime(java.lang.String)
//  .preferredBackupTime(IResolvable)
//  .privateIpAddress(java.lang.String)
//  .privateIpAddress(IResolvable)
//  .restoreTable(java.lang.String)
//  .restoreTable(IResolvable)
//  .restoreTime(java.lang.String)
//  .restoreTime(IResolvable)
//  .securityGroupId(java.lang.String)
//  .securityGroupId(IResolvable)
//  .securityIpList(java.lang.String)
//  .securityIpList(IResolvable)
//  .slaveZoneIds(IResolvable)
//  .slaveZoneIds(java.util.List<java.lang.String)
//  .slaveZoneIds(IResolvable>)
//  .sqlCollectorStatus(java.lang.String)
//  .sqlCollectorStatus(IResolvable)
//  .sslSetting(java.lang.String)
//  .sslSetting(IResolvable)
//  .tableMeta(IResolvable)
//  .tableMeta(java.util.List<IResolvable)
//  .tableMeta(TableMetaProperty>)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .timeoutInMinutes(java.lang.Number)
//  .timeoutInMinutes(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();

Properties

Name Type Description
dbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceId: Instance id.
payType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payType: The charge type of created instance.
allocatePublicConnection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property allocatePublicConnection: If true, allocate public connection automate.
backupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupId: The ID of the backup set that you want to use.
backupRetentionPeriod java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property backupRetentionPeriod: The retention period of the data backup.
backupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupType: The type of backup used by the new instance.
category java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property category: The edition of the instance.
connectionStringPrefix java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionStringPrefix: The prefix of the endpoint.
connectionStringType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property connectionStringType: The endpoint type of the instance, allow values: Inner, Public.
dbInstanceClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceClass: Database instance type.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceDescription: Description of created database instance.
dbInstanceStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStorage: The storage capacity of the instance.
dbInstanceStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStorageType: The storage type of the instance.
dbMappings com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBMappingsProperty> Property dbMappings: Database mappings to attach to db instance.
dbNames java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNames: The names of the databases that you want to create on the new instance.
dedicatedHostGroupId java.lang.String OR com.aliyun.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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceNetworkType: The network type of the new instance.
maintainTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property maintainTime: The period during which the maintenance performs.
masterUsername java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property masterUsername: The master user name for the database instance.
masterUserPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property masterUserPassword: The master password for the database instance.
masterUserType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property masterUserType: Privilege type of account.
period java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property period: The subscription duration.
periodType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property periodType: Charge period for created instances.
port java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property port: The port of the database service.
preferredBackupPeriod com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property preferredBackupPeriod: The backup period.
preferredBackupTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property preferredBackupTime: The time when the backup task is performed.
privateIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property privateIpAddress: The private ip for created instance.
restoreTable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreTable: Specifies whether to restore specific databases and tables.
restoreTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreTime: The point in time to which you want to restore the data of the original instance.
securityGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property securityGroupId: The ID of the ECS security groups.
securityIpList java.lang.String OR com.aliyun.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 com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property slaveZoneIds: List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance.
sqlCollectorStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sqlCollectorStatus: Specifies whether to enable or disable the SQL Explorer (SQL audit) feature.
sslSetting java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sslSetting: Secure Sockets Layer (SSL) link setting of the instance.
tableMeta com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTableMetaProperty> Property tableMeta: The information about the databases and tables that you want to restore.
tags java.util.Map Property tags: The tags of an instance.
timeoutInMinutes java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property timeoutInMinutes: The timeout period for creating the clone instance resource.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC id of created database instance.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vSwitch id of created instance.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: selected zone to create database instance.

dbInstanceIdRequired 

public java.lang.Object getDbInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceId: Instance id.

payTypeRequired 

public java.lang.Object getPayType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property payType: The charge type of created instance.

allocatePublicConnectionOptional 

public java.lang.Object getAllocatePublicConnection();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property allocatePublicConnection: If true, allocate public connection automate.

backupIdOptional 

public java.lang.Object getBackupId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getBackupRetentionPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getBackupType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getCategory();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getConnectionStringPrefix();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getConnectionStringType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

dbInstanceClassOptional 

public java.lang.Object getDbInstanceClass();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbInstanceDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceDescription: Description of created database instance.

dbInstanceStorageOptional 

public java.lang.Object getDbInstanceStorage();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getDbInstanceStorageType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbMappings();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBMappingsProperty>

Property dbMappings: Database mappings to attach to db instance.

dbNamesOptional 

public java.lang.Object getDbNames();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

dedicatedHostGroupIdOptional 

public java.lang.Object getDedicatedHostGroupId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getInstanceNetworkType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getMaintainTime();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property maintainTime: The period during which the maintenance performs.

The format is HH:mmZ-HH:mmZ.

masterUsernameOptional 

public java.lang.Object getMasterUsername();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

masterUserPasswordOptional 

public java.lang.Object getMasterUserPassword();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property masterUserPassword: The master password for the database instance.

masterUserTypeOptional 

public java.lang.Object getMasterUserType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPeriod();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPeriodType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodType: Charge period for created instances.

portOptional 

public java.lang.Object getPort();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property port: The port of the database service.

preferredBackupPeriodOptional 

public java.lang.Object getPreferredBackupPeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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 java.lang.Object getPreferredBackupTime();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPrivateIpAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property privateIpAddress: The private ip for created instance.

restoreTableOptional 

public java.lang.Object getRestoreTable();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getRestoreTime();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityGroupId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSecurityIpList();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSlaveZoneIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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 java.lang.Object getSqlCollectorStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:Enable | Disabled.

sslSettingOptional 

public java.lang.Object getSslSetting();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getTableMeta();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTableMetaProperty>

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

tagsOptional 

public java.util.Map<java.lang.String, java.lang.Object> getTags();
  • Type: java.util.Map

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 java.lang.Object getTimeoutInMinutes();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Unit: Minute. Default: 120.

vpcIdOptional 

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC id of created database instance.

For VPC network, the property is required.

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vSwitch id of created instance.

For VPC network, the property is required.

zoneIdOptional 

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.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.