InstanceProps

Properties for defining a Instance.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdms"
&alicloudroscdkdms.InstanceProps {
    DatabasePassword: interface{},
    DatabaseUser: interface{},
    DbaUid: 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{},
    Sid: interface{},
    Tid: interface{},
    UseDsql: 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.
DbaUid	interface{}	Property dbaUid: The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of the database instance.
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.
Sid	interface{}	Property sid: The system ID (SID) of the database instance.
Tid	interface{}	Property tid: The ID of the tenant.
UseDsql	interface{}	Property useDsql: Specifies whether to enable cross-database query for the database instance.
VpcId	interface{}	Property vpcId: The ID of the VPC to which the database instance belongs.

---

DatabasePassword^Required

DatabasePassword interface{}

• Type: interface{}

Property databasePassword: The logon password of the database instance.

---

DatabaseUser^Required

DatabaseUser interface{}

• Type: interface{}

Property databaseUser: The logon username of the database instance.

---

DbaUid^Required

DbaUid interface{}

• Type: interface{}

Property dbaUid: The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of the database instance.

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

User Management.

---

EnvType^Required

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.

---

ExportTimeout^Required

ExportTimeout interface{}

• Type: interface{}

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

Unit: seconds.

---

Host^Required

Host interface{}

• Type: interface{}

Property host: The endpoint of the database instance.

---

InstanceAlias^Required

InstanceAlias interface{}

• Type: interface{}

Property instanceAlias: The alias of the database instance.

The alias helps you quickly find the required instance.

---

InstanceSource^Required

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

---

InstanceType^Required

InstanceType interface{}

• Type: interface{}

Property instanceType: The type of the database instance.

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

---

NetworkType^Required

NetworkType interface{}

• Type: interface{}

Property networkType: The network type of the database instance.

Valid values: CLASSIC VPC

---

Port^Required

Port interface{}

• Type: interface{}

Property port: The connection port of the database instance.

---

QueryTimeout^Required

QueryTimeout interface{}

• Type: interface{}

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

Unit: seconds.

---

SafeRule^Required

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.

---

DataLinkName^Optional

DataLinkName interface{}

• Type: interface{}

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

---

DdlOnline^Optional

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.

---

EcsInstanceId^Optional

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.

---

EcsRegion^Optional

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.

---

Sid^Optional

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.

---

Tid^Optional

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.

---

UseDsql^Optional

UseDsql interface{}

• Type: interface{}

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

Valid values: 0: disabled 1: enabled

---

VpcId^Optional

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.

---