Skip to content

DBInstanceCloneProps

Properties for defining a DBInstanceClone.

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

Initializer 

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkrds"
&alicloudroscdkrds.DBInstanceCloneProps {
    DbInstanceId: interface{},
    PayType: interface{},
    AllocatePublicConnection: interface{},
    BackupId: interface{},
    BackupRetentionPeriod: interface{},
    BackupType: interface{},
    Category: interface{},
    ConnectionStringPrefix: interface{},
    ConnectionStringType: interface{},
    DbInstanceClass: interface{},
    DbInstanceDescription: interface{},
    DbInstanceStorage: interface{},
    DbInstanceStorageType: interface{},
    DbMappings: interface{},
    DbNames: interface{},
    DedicatedHostGroupId: interface{},
    InstanceNetworkType: interface{},
    MaintainTime: interface{},
    MasterUsername: interface{},
    MasterUserPassword: interface{},
    MasterUserType: interface{},
    Period: interface{},
    PeriodType: interface{},
    Port: interface{},
    PreferredBackupPeriod: interface{},
    PreferredBackupTime: interface{},
    PrivateIpAddress: interface{},
    RestoreTable: interface{},
    RestoreTime: interface{},
    SecurityGroupId: interface{},
    SecurityIpList: interface{},
    SlaveZoneIds: interface{},
    SqlCollectorStatus: interface{},
    SslSetting: interface{},
    TableMeta: interface{},
    Tags: *map[string]interface{},
    TimeoutInMinutes: interface{},
    VpcId: interface{},
    VSwitchId: interface{},
    ZoneId: interface{},
}

Properties

Name Type Description
DbInstanceId interface{} Property dbInstanceId: Instance id.
PayType interface{} Property payType: The charge type of created instance.
AllocatePublicConnection interface{} Property allocatePublicConnection: If true, allocate public connection automate.
BackupId interface{} Property backupId: The ID of the backup set that you want to use.
BackupRetentionPeriod interface{} Property backupRetentionPeriod: The retention period of the data backup.
BackupType interface{} Property backupType: The type of backup used by the new instance.
Category interface{} Property category: The edition of the instance.
ConnectionStringPrefix interface{} Property connectionStringPrefix: The prefix of the endpoint.
ConnectionStringType interface{} Property connectionStringType: The endpoint type of the instance, allow values: Inner, Public.
DbInstanceClass interface{} Property dbInstanceClass: Database instance type.
DbInstanceDescription interface{} Property dbInstanceDescription: Description of created database instance.
DbInstanceStorage interface{} Property dbInstanceStorage: The storage capacity of the instance.
DbInstanceStorageType interface{} Property dbInstanceStorageType: The storage type of the instance.
DbMappings interface{} Property dbMappings: Database mappings to attach to db instance.
DbNames interface{} Property dbNames: The names of the databases that you want to create on the new instance.
DedicatedHostGroupId interface{} Property dedicatedHostGroupId: The ID of the host group to which the instance belongs if you create an instance in a host group.
InstanceNetworkType interface{} Property instanceNetworkType: The network type of the new instance.
MaintainTime interface{} Property maintainTime: The period during which the maintenance performs.
MasterUsername interface{} Property masterUsername: The master user name for the database instance.
MasterUserPassword interface{} Property masterUserPassword: The master password for the database instance.
MasterUserType interface{} Property masterUserType: Privilege type of account.
Period interface{} Property period: The subscription duration.
PeriodType interface{} Property periodType: Charge period for created instances.
Port interface{} Property port: The port of the database service.
PreferredBackupPeriod interface{} Property preferredBackupPeriod: The backup period.
PreferredBackupTime interface{} Property preferredBackupTime: The time when the backup task is performed.
PrivateIpAddress interface{} Property privateIpAddress: The private ip for created instance.
RestoreTable interface{} Property restoreTable: Specifies whether to restore specific databases and tables.
RestoreTime interface{} Property restoreTime: The point in time to which you want to restore the data of the original instance.
SecurityGroupId interface{} Property securityGroupId: The ID of the ECS security groups.
SecurityIpList interface{} Property securityIpList: Security ip to access the database instance, combine with comma, 0.0.0.0\/0 means no limitation.
SlaveZoneIds interface{} Property slaveZoneIds: List of slave zone ids can specify slave zone ids when creating the high-availability or enterprise edition instance.
SqlCollectorStatus interface{} Property sqlCollectorStatus: Specifies whether to enable or disable the SQL Explorer (SQL audit) feature.
SslSetting interface{} Property sslSetting: Secure Sockets Layer (SSL) link setting of the instance.
TableMeta interface{} Property tableMeta: The information about the databases and tables that you want to restore.
Tags *map[string]interface{} Property tags: The tags of an instance.
TimeoutInMinutes interface{} Property timeoutInMinutes: The timeout period for creating the clone instance resource.
VpcId interface{} Property vpcId: The VPC id of created database instance.
VSwitchId interface{} Property vSwitchId: The vSwitch id of created instance.
ZoneId interface{} Property zoneId: selected zone to create database instance.

DbInstanceIdRequired 

DbInstanceId interface{}
  • Type: interface{}

Property dbInstanceId: Instance id.

PayTypeRequired 

PayType interface{}
  • Type: interface{}

Property payType: The charge type of created instance.

AllocatePublicConnectionOptional 

AllocatePublicConnection interface{}
  • Type: interface{}

Property allocatePublicConnection: If true, allocate public connection automate.

BackupIdOptional 

BackupId interface{}
  • Type: interface{}

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 

BackupRetentionPeriod interface{}
  • Type: interface{}

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 

BackupType interface{}
  • Type: interface{}

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

Valid values:

  • FullBackup: full backup
  • IncrementalBackup: incremental backup

CategoryOptional 

Category interface{}
  • Type: interface{}

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 

ConnectionStringPrefix interface{}
  • Type: interface{}

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 

ConnectionStringType interface{}
  • Type: interface{}

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

DbInstanceClassOptional 

DbInstanceClass interface{}
  • Type: interface{}

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 

DbInstanceDescription interface{}
  • Type: interface{}

Property dbInstanceDescription: Description of created database instance.

DbInstanceStorageOptional 

DbInstanceStorage interface{}
  • Type: interface{}

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 

DbInstanceStorageType interface{}
  • Type: interface{}

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 

DbMappings interface{}
  • Type: interface{}

Property dbMappings: Database mappings to attach to db instance.

DbNamesOptional 

DbNames interface{}
  • Type: interface{}

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

DedicatedHostGroupIdOptional 

DedicatedHostGroupId interface{}
  • Type: interface{}

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

InstanceNetworkTypeOptional 

InstanceNetworkType interface{}
  • Type: interface{}

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 

MaintainTime interface{}
  • Type: interface{}

Property maintainTime: The period during which the maintenance performs.

The format is HH:mmZ-HH:mmZ.

MasterUsernameOptional 

MasterUsername interface{}
  • Type: interface{}

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

MasterUserPasswordOptional 

MasterUserPassword interface{}
  • Type: interface{}

Property masterUserPassword: The master password for the database instance.

MasterUserTypeOptional 

MasterUserType interface{}
  • Type: interface{}

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 

Period interface{}
  • Type: interface{}

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 

PeriodType interface{}
  • Type: interface{}

Property periodType: Charge period for created instances.

PortOptional 

Port interface{}
  • Type: interface{}

Property port: The port of the database service.

PreferredBackupPeriodOptional 

PreferredBackupPeriod interface{}
  • Type: interface{}

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 

PreferredBackupTime interface{}
  • Type: interface{}

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 

PrivateIpAddress interface{}
  • Type: interface{}

Property privateIpAddress: The private ip for created instance.

RestoreTableOptional 

RestoreTable interface{}
  • Type: interface{}

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 

RestoreTime interface{}
  • Type: interface{}

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 

SecurityGroupId interface{}
  • Type: interface{}

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 

SecurityIpList interface{}
  • Type: interface{}

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

SlaveZoneIdsOptional 

SlaveZoneIds interface{}
  • Type: interface{}

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 

SqlCollectorStatus interface{}
  • Type: interface{}

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

Valid values:Enable | Disabled.

SslSettingOptional 

SslSetting interface{}
  • Type: interface{}

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 

TableMeta interface{}
  • Type: interface{}

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

TagsOptional 

Tags *map[string]interface{}
  • Type: *map[string]interface{}

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 

TimeoutInMinutes interface{}
  • Type: interface{}

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

Unit: Minute. Default: 120.

VpcIdOptional 

VpcId interface{}
  • Type: interface{}

Property vpcId: The VPC id of created database instance.

For VPC network, the property is required.

VSwitchIdOptional 

VSwitchId interface{}
  • Type: interface{}

Property vSwitchId: The vSwitch id of created instance.

For VPC network, the property is required.

ZoneIdOptional 

ZoneId interface{}
  • Type: interface{}

Property zoneId: selected zone to create database instance.

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