Instance2Props

Properties for defining a Instance2.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Dms;
new Instance2Props {
    object DatabasePassword,
    object DatabaseUser,
    object DbaId,
    object EnableSellTrust,
    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 EnableSellCommon = null,
    object EnableSellSitd = null,
    object EnableSellStable = null,
    object Sid = null,
    object SkipTest = null,
    object TemplateId = null,
    object TemplateType = null,
    object Tid = null,
    object UseDsql = null,
    object UseSsl = 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.
DbaId	object	Property dbaId: The user ID of the instance DBA role.
EnableSellTrust	object	Property enableSellTrust: Whether the instance needs to enable secure hosting.
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.
EnableSellCommon	object	Property enableSellCommon: Whether the instance needs to enable the security collaboration function.
EnableSellSitd	object	Property enableSellSitd: Y: enables the sensitive data protection feature NULL or other: disables the sensitive data protection feature.
EnableSellStable	object	Property enableSellStable: Whether the instance needs to enable the stable change function.
Sid	object	Property sid: The system ID (SID) of the database instance.
SkipTest	object	Property skipTest: Whether the instance ignores the test connectivity.
TemplateId	object	Property templateId: The ID of the classification template.
TemplateType	object	Property templateType: The type of the classification template.
Tid	object	Property tid: The ID of the tenant.
UseDsql	object	Property useDsql: Specifies whether to enable cross-database query for the database instance.
UseSsl	object	Property useSsl: Select whether to enable SSL connection.
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.

---

DbaId^Required

public object DbaId { get; set; }

• Type: object

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.

---

EnableSellTrust^Required

public object EnableSellTrust { get; set; }

• Type: object

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

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

---

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.

---

EnableSellCommon^Optional

public object EnableSellCommon { get; set; }

• Type: object

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

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

---

EnableSellSitd^Optional

public object EnableSellSitd { get; set; }

• Type: object

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

---

EnableSellStable^Optional

public object EnableSellStable { get; set; }

• Type: object

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

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

---

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.

---

SkipTest^Optional

public object SkipTest { get; set; }

• Type: object

Property skipTest: Whether the instance ignores the test connectivity.

The values are as follows:

• true: ignore
• false: do not ignore

---

TemplateId^Optional

public object TemplateId { get; set; }

• Type: object

Property templateId: The ID of the classification template.

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

---

TemplateType^Optional

public object TemplateType { get; set; }

• Type: object

Property templateType: The type of the classification template.

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

---

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

---

UseSsl^Optional

public object UseSsl { get; set; }

• Type: object

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.

---

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.

---