Skip to content

DBInstanceCloneProps

Properties for defining a DBInstanceClone.

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

Initializer 

using AlibabaCloud.SDK.ROS.CDK.Rds;
new DBInstanceCloneProps {
    object DbInstanceId,
    object PayType,
    object AllocatePublicConnection = null,
    object BackupId = null,
    object BackupRetentionPeriod = null,
    object BackupType = null,
    object Category = null,
    object ConnectionStringPrefix = null,
    object ConnectionStringType = null,
    object DbInstanceClass = null,
    object DbInstanceDescription = null,
    object DbInstanceStorage = null,
    object DbInstanceStorageType = null,
    object DbMappings = null,
    object DbNames = null,
    object DedicatedHostGroupId = null,
    object InstanceNetworkType = null,
    object MaintainTime = null,
    object MasterUsername = null,
    object MasterUserPassword = null,
    object MasterUserType = null,
    object Period = null,
    object PeriodType = null,
    object Port = null,
    object PreferredBackupPeriod = null,
    object PreferredBackupTime = null,
    object PrivateIpAddress = null,
    object RestoreTable = null,
    object RestoreTime = null,
    object SecurityGroupId = null,
    object SecurityIpList = null,
    object SlaveZoneIds = null,
    object SqlCollectorStatus = null,
    object SslSetting = null,
    object TableMeta = null,
    System.Collections.Generic.IDictionary<string, object> Tags = null,
    object TimeoutInMinutes = null,
    object VpcId = null,
    object VSwitchId = null,
    object ZoneId = null
};

Properties

Name Type Description
DbInstanceId object Property dbInstanceId: Instance id.
PayType object Property payType: The charge type of created instance.
AllocatePublicConnection object Property allocatePublicConnection: If true, allocate public connection automate.
BackupId object Property backupId: The ID of the backup set that you want to use.
BackupRetentionPeriod object Property backupRetentionPeriod: The retention period of the data backup.
BackupType object Property backupType: The type of backup used by the new instance.
Category object Property category: The edition of the instance.
ConnectionStringPrefix object Property connectionStringPrefix: The prefix of the endpoint.
ConnectionStringType object Property connectionStringType: The endpoint type of the instance, allow values: Inner, Public.
DbInstanceClass object Property dbInstanceClass: Database instance type.
DbInstanceDescription object Property dbInstanceDescription: Description of created database instance.
DbInstanceStorage object Property dbInstanceStorage: The storage capacity of the instance.
DbInstanceStorageType object Property dbInstanceStorageType: The storage type of the instance.
DbMappings object Property dbMappings: Database mappings to attach to db instance.
DbNames object Property dbNames: The names of the databases that you want to create on the new 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.
InstanceNetworkType object Property instanceNetworkType: The network type of the new instance.
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.
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.
RestoreTable object Property restoreTable: Specifies whether to restore specific databases and tables.
RestoreTime object Property restoreTime: The point in time to which you want to restore the data of the original instance.
SecurityGroupId object Property securityGroupId: The ID of the ECS security groups.
SecurityIpList object Property securityIpList: Security ip to access the database instance, combine with comma, 0.0.0.0\/0 means no limitation.
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.
TableMeta object Property tableMeta: The information about the databases and tables that you want to restore.
Tags System.Collections.Generic.IDictionary Property tags: The tags of an instance.
TimeoutInMinutes object Property timeoutInMinutes: The timeout period for creating the clone instance resource.
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.

DbInstanceIdRequired 

public object DbInstanceId { get; set; }
  • Type: object

Property dbInstanceId: Instance id.

PayTypeRequired 

public object PayType { get; set; }
  • Type: object

Property payType: The charge type of created instance.

AllocatePublicConnectionOptional 

public object AllocatePublicConnection { get; set; }
  • Type: object

Property allocatePublicConnection: If true, allocate public connection automate.

BackupIdOptional 

public object BackupId { get; set; }
  • Type: object

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

BackupTypeOptional 

public object BackupType { get; set; }
  • Type: object

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

Valid values:

  • FullBackup: full backup
  • IncrementalBackup: incremental backup

CategoryOptional 

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

ConnectionStringPrefixOptional 

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

ConnectionStringTypeOptional 

public object ConnectionStringType { get; set; }
  • Type: object

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

DbInstanceClassOptional 

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

DbInstanceDescriptionOptional 

public object DbInstanceDescription { get; set; }
  • Type: object

Property dbInstanceDescription: Description of created database instance.

DbInstanceStorageOptional 

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.

DbInstanceStorageTypeOptional 

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.

DbMappingsOptional 

public object DbMappings { get; set; }
  • Type: object

Property dbMappings: Database mappings to attach to db instance.

DbNamesOptional 

public object DbNames { get; set; }
  • Type: object

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

DedicatedHostGroupIdOptional 

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.

InstanceNetworkTypeOptional 

public object InstanceNetworkType { get; set; }
  • Type: object

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 object MaintainTime { get; set; }
  • Type: object

Property maintainTime: The period during which the maintenance performs.

The format is HH:mmZ-HH:mmZ.

MasterUsernameOptional 

public object MasterUsername { get; set; }
  • Type: object

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

MasterUserPasswordOptional 

public object MasterUserPassword { get; set; }
  • Type: object

Property masterUserPassword: The master password for the database instance.

MasterUserTypeOptional 

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.

PeriodOptional 

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.

PeriodTypeOptional 

public object PeriodType { get; set; }
  • Type: object

Property periodType: Charge period for created instances.

PortOptional 

public object Port { get; set; }
  • Type: object

Property port: The port of the database service.

PreferredBackupPeriodOptional 

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.

PreferredBackupTimeOptional 

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.

PrivateIpAddressOptional 

public object PrivateIpAddress { get; set; }
  • Type: object

Property privateIpAddress: The private ip for created instance.

RestoreTableOptional 

public object RestoreTable { get; set; }
  • Type: object

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 object RestoreTime { get; set; }
  • Type: object

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

SecurityIpListOptional 

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.

SlaveZoneIdsOptional 

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

SqlCollectorStatusOptional 

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.

SslSettingOptional 

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.

TableMetaOptional 

public object TableMeta { get; set; }
  • Type: object

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

TagsOptional 

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.

TimeoutInMinutesOptional 

public object TimeoutInMinutes { get; set; }
  • Type: object

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

Unit: Minute. Default: 120.

VpcIdOptional 

public object VpcId { get; set; }
  • Type: object

Property vpcId: The VPC id of created database instance.

For VPC network, the property is required.

VSwitchIdOptional 

public object VSwitchId { get; set; }
  • Type: object

Property vSwitchId: The vSwitch id of created instance.

For VPC network, the property is required.

ZoneIdOptional 

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.