InstanceProps

Properties for defining a Instance.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Dms;
new InstanceProps {
    object DatabasePassword,
    object DatabaseUser,
    object DbaUid,
    object EnvType,
    object ExportTimeout,
    object Host,
    object InstanceAlias,
    object InstanceSource,
    object InstanceType,
    object NetworkType,
    object Port,
    object QueryTimeout,
    object SafeRule,
    object DataLinkName = null,
    object DdlOnline = null,
    object EcsInstanceId = null,
    object EcsRegion = null,
    object Sid = null,
    object Tid = null,
    object UseDsql = null,
    object VpcId = null
};

Properties

Name	Type	Description
DatabasePassword	object	Property databasePassword: The logon password of the database instance.
DatabaseUser	object	Property databaseUser: The logon username of the database instance.
DbaUid	object	Property dbaUid: The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of the database instance.
EnvType	object	Property envType: The type of the environment to which the database instance belongs.
ExportTimeout	object	Property exportTimeout: The timeout period for exporting the database instance.
Host	object	Property host: The endpoint of the database instance.
InstanceAlias	object	Property instanceAlias: The alias of the database instance.
InstanceSource	object	Property instanceSource: The source of the database instance.
InstanceType	object	Property instanceType: The type of the database instance.
NetworkType	object	Property networkType: The network type of the database instance.
Port	object	Property port: The connection port of the database instance.
QueryTimeout	object	Property queryTimeout: The timeout period for querying the database instance.
SafeRule	object	Property safeRule: The security rule of the database instance.
DataLinkName	object	Property dataLinkName: The name of the data link for cross-database query.
DdlOnline	object	Property ddlOnline: [Important] Specifies whether to enable the online data description language (DDL) service.
EcsInstanceId	object	Property ecsInstanceId: The ID of the ECS instance to which the database instance belongs.
EcsRegion	object	Property ecsRegion: The region where the database instance resides.
Sid	object	Property sid: The system ID (SID) of the database instance.
Tid	object	Property tid: The ID of the tenant.
UseDsql	object	Property useDsql: Specifies whether to enable cross-database query for the database instance.
VpcId	object	Property vpcId: The ID of the VPC to which the database instance belongs.

---

DatabasePassword^Required

public object DatabasePassword { get; set; }

• Type: object

Property databasePassword: The logon password of the database instance.

---

DatabaseUser^Required

public object DatabaseUser { get; set; }

• Type: object

Property databaseUser: The logon username of the database instance.

---

DbaUid^Required

public object DbaUid { get; set; }

• Type: object

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

public object EnvType { get; set; }

• Type: object

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

public object ExportTimeout { get; set; }

• Type: object

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

Unit: seconds.

---

Host^Required

public object Host { get; set; }

• Type: object

Property host: The endpoint of the database instance.

---

InstanceAlias^Required

public object InstanceAlias { get; set; }

• Type: object

Property instanceAlias: The alias of the database instance.

The alias helps you quickly find the required instance.

---

InstanceSource^Required

public object InstanceSource { get; set; }

• Type: object

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

public object InstanceType { get; set; }

• Type: object

Property instanceType: The type of the database instance.

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

---

NetworkType^Required

public object NetworkType { get; set; }

• Type: object

Property networkType: The network type of the database instance.

Valid values: CLASSIC VPC

---

Port^Required

public object Port { get; set; }

• Type: object

Property port: The connection port of the database instance.

---

QueryTimeout^Required

public object QueryTimeout { get; set; }

• Type: object

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

Unit: seconds.

---

SafeRule^Required

public object SafeRule { get; set; }

• Type: object

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

public object DataLinkName { get; set; }

• Type: object

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

---

DdlOnline^Optional

public object DdlOnline { get; set; }

• Type: object

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

public object EcsInstanceId { get; set; }

• Type: object

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

public object EcsRegion { get; set; }

• Type: object

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

public object Sid { get; set; }

• Type: object

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

public object Tid { get; set; }

• Type: object

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

public object UseDsql { get; set; }

• Type: object

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

Valid values: 0: disabled 1: enabled

---

VpcId^Optional

public object VpcId { get; set; }

• Type: object

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.

---