Skip to content

Instance2Props

Properties for defining a Instance2.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dms-instance2

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdms"
&alicloudroscdkdms.Instance2Props {
    DatabasePassword: interface{},
    DatabaseUser: interface{},
    DbaId: interface{},
    EnableSellTrust: interface{},
    EnvType: interface{},
    ExportTimeout: interface{},
    Host: interface{},
    InstanceAlias: interface{},
    InstanceSource: interface{},
    InstanceType: interface{},
    NetworkType: interface{},
    Port: interface{},
    QueryTimeout: interface{},
    SafeRule: interface{},
    DataLinkName: interface{},
    DdlOnline: interface{},
    EcsInstanceId: interface{},
    EcsRegion: interface{},
    EnableSellCommon: interface{},
    EnableSellSitd: interface{},
    EnableSellStable: interface{},
    Sid: interface{},
    SkipTest: interface{},
    TemplateId: interface{},
    TemplateType: interface{},
    Tid: interface{},
    UseDsql: interface{},
    UseSsl: interface{},
    VpcId: interface{},
}

Properties

Name Type Description
DatabasePassword interface{} Property databasePassword: The logon password of the database instance.
DatabaseUser interface{} Property databaseUser: The logon username of the database instance.
DbaId interface{} Property dbaId: The user ID of the instance DBA role.
EnableSellTrust interface{} Property enableSellTrust: Whether the instance needs to enable secure hosting.
EnvType interface{} Property envType: The type of the environment to which the database instance belongs.
ExportTimeout interface{} Property exportTimeout: The timeout period for exporting the database instance.
Host interface{} Property host: The endpoint of the database instance.
InstanceAlias interface{} Property instanceAlias: The alias of the database instance.
InstanceSource interface{} Property instanceSource: The source of the database instance.
InstanceType interface{} Property instanceType: The type of the database instance.
NetworkType interface{} Property networkType: The network type of the database instance.
Port interface{} Property port: The connection port of the database instance.
QueryTimeout interface{} Property queryTimeout: The timeout period for querying the database instance.
SafeRule interface{} Property safeRule: The security rule of the database instance.
DataLinkName interface{} Property dataLinkName: The name of the data link for cross-database query.
DdlOnline interface{} Property ddlOnline: [Important] Specifies whether to enable the online data description language (DDL) service.
EcsInstanceId interface{} Property ecsInstanceId: The ID of the ECS instance to which the database instance belongs.
EcsRegion interface{} Property ecsRegion: The region where the database instance resides.
EnableSellCommon interface{} Property enableSellCommon: Whether the instance needs to enable the security collaboration function.
EnableSellSitd interface{} Property enableSellSitd: Y: enables the sensitive data protection feature NULL or other: disables the sensitive data protection feature.
EnableSellStable interface{} Property enableSellStable: Whether the instance needs to enable the stable change function.
Sid interface{} Property sid: The system ID (SID) of the database instance.
SkipTest interface{} Property skipTest: Whether the instance ignores the test connectivity.
TemplateId interface{} Property templateId: The ID of the classification template.
TemplateType interface{} Property templateType: The type of the classification template.
Tid interface{} Property tid: The ID of the tenant.
UseDsql interface{} Property useDsql: Specifies whether to enable cross-database query for the database instance.
UseSsl interface{} Property useSsl: Select whether to enable SSL connection.
VpcId interface{} Property vpcId: The ID of the VPC to which the database instance belongs.

DatabasePasswordRequired

DatabasePassword interface{}
  • Type: interface{}

Property databasePassword: The logon password of the database instance.


DatabaseUserRequired

DatabaseUser interface{}
  • Type: interface{}

Property databaseUser: The logon username of the database instance.


DbaIdRequired

DbaId interface{}
  • Type: interface{}

Property dbaId: The user ID of the instance DBA role.

You can call the ListUsers or GetInstance operation to obtain the value of this parameter.


EnableSellTrustRequired

EnableSellTrust interface{}
  • Type: interface{}

Property enableSellTrust: Whether the instance needs to enable secure hosting.

  • Y: Enable secure hosting mode.
  • NULL or other: Do not enable secure hosting mode.

EnvTypeRequired

EnvType interface{}
  • Type: interface{}

Property envType: The type of the environment to which the database instance belongs.

Valid values: product: the production environment. dev: the test environment.


ExportTimeoutRequired

ExportTimeout interface{}
  • Type: interface{}

Property exportTimeout: The timeout period for exporting the database instance.

Unit: seconds.


HostRequired

Host interface{}
  • Type: interface{}

Property host: The endpoint of the database instance.


InstanceAliasRequired

InstanceAlias interface{}
  • Type: interface{}

Property instanceAlias: The alias of the database instance.

The alias helps you quickly find the required instance.


InstanceSourceRequired

InstanceSource interface{}
  • Type: interface{}

Property instanceSource: The source of the database instance.

Valid values: PUBLIC_OWN: an on-premises database built on the public network. RDS: an ApsaraDB for RDS (RDS) instance. ECS_OWN: an on-premises database built on an Elastic Compute Service (ECS) instance. VPC_IDC: an on-premises database built in an Internet data center (IDC) in Virtual Private Cloud (VPC).


InstanceTypeRequired

InstanceType interface{}
  • Type: interface{}

Property instanceType: The type of the database instance.

Valid values: MySQL, SQLServer, PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis


NetworkTypeRequired

NetworkType interface{}
  • Type: interface{}

Property networkType: The network type of the database instance.

Valid values: CLASSIC VPC


PortRequired

Port interface{}
  • Type: interface{}

Property port: The connection port of the database instance.


QueryTimeoutRequired

QueryTimeout interface{}
  • Type: interface{}

Property queryTimeout: The timeout period for querying the database instance.

Unit: seconds.


SafeRuleRequired

SafeRule interface{}
  • Type: interface{}

Property safeRule: The security rule of the database instance.

Enter the name of the security rule for your enterprise. Note To query a specified security rule, log on to the DMS Enterprise console and choose System Management > Security Rules. The security rule appears in the security rule list.


DataLinkNameOptional

DataLinkName interface{}
  • Type: interface{}

Property dataLinkName: The name of the data link for cross-database query.


DdlOnlineOptional

DdlOnline interface{}
  • Type: interface{}

Property ddlOnline: [Important] Specifies whether to enable the online data description language (DDL) service.

Currently, this service is available only for the MySQL and PolarDB databases. 0: The service is disabled. 1: The native online DDL service prevails. 2: Data change without table locking provided by DMS prevails.


EcsInstanceIdOptional

EcsInstanceId interface{}
  • Type: interface{}

Property ecsInstanceId: The ID of the ECS instance to which the database instance belongs.

Note You must specify this parameter if the InstanceSource parameter is set to ECS_OWN.


EcsRegionOptional

EcsRegion interface{}
  • Type: interface{}

Property ecsRegion: The region where the database instance resides.

Note You must specify this parameter if the InstanceSource parameter is set to ECS_OWN or VPC_IDC.


EnableSellCommonOptional

EnableSellCommon interface{}
  • Type: interface{}

Property enableSellCommon: Whether the instance needs to enable the security collaboration function.

  • Y: Enable.
  • NULL or other: Not enable.

EnableSellSitdOptional

EnableSellSitd interface{}
  • Type: interface{}

Property enableSellSitd: Y: enables the sensitive data protection feature NULL or other: disables the sensitive data protection feature.


EnableSellStableOptional

EnableSellStable interface{}
  • Type: interface{}

Property enableSellStable: Whether the instance needs to enable the stable change function.

  • Y: Enable.
  • NULL or other: Do not enable.

SidOptional

Sid interface{}
  • Type: interface{}

Property sid: The system ID (SID) of the database instance.

Note You must specify this parameter if the InstanceType parameter is set to PostgreSQL or Oracle.


SkipTestOptional

SkipTest interface{}
  • Type: interface{}

Property skipTest: Whether the instance ignores the test connectivity.

The values are as follows:

  • true: ignore
  • false: do not ignore

TemplateIdOptional

TemplateId interface{}
  • Type: interface{}

Property templateId: The ID of the classification template.

You can call the ListClassificationTemplates operation to query the template ID.


TemplateTypeOptional

TemplateType interface{}
  • Type: interface{}

Property templateType: The type of the classification template.

You can call the ListClassificationTemplates operation to query the template type.


TidOptional

Tid interface{}
  • Type: interface{}

Property tid: The ID of the tenant.

Note To query the ID, log on to the DMS Enterprise console and choose System Management

Instance Management or System Management > User Management. The ID of the tenant appears in the Service Specification section.


UseDsqlOptional

UseDsql interface{}
  • Type: interface{}

Property useDsql: Specifies whether to enable cross-database query for the database instance.

Valid values: 0: disabled 1: enabled


UseSslOptional

UseSsl interface{}
  • Type: interface{}

Property useSsl: Select whether to enable SSL connection.

When enabled, DMS will connect to the database via SSL. The premise of using this parameter is that the database has enabled SSL connection. Currently, the following options are supported:

  • 0: Default value (DMS and database service automatically negotiate whether to enable it) The system will automatically identify whether the target database has enabled SSL connection. If the database has enabled SSL connection, DMS will connect to the database via SSL; if the database has not enabled SSL connection, it will connect in a normal way.
  • 1: Enable SSL connection. If the database has not enabled SSL connection, this parameter is invalid.
  • -1: Disable SSL connection. Note:
  • This configuration item only appears when the database is MySQL or Redis.
  • SSL (Secure Sockets Layer) can encrypt network connections at the transport layer to improve the security and integrity of communication data, but it will increase the network connection response time.

VpcIdOptional

VpcId interface{}
  • Type: interface{}

Property vpcId: The ID of the VPC to which the database instance belongs.

Note You must specify this parameter if the InstanceSource parameter is set to VPC_IDC.