InstanceProps

Properties for defining a Instance.

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

Initializer

import com.aliyun.ros.cdk.dms.InstanceProps;
InstanceProps.builder()
    .databasePassword(java.lang.String)
    .databasePassword(IResolvable)
    .databaseUser(java.lang.String)
    .databaseUser(IResolvable)
    .dbaUid(java.lang.Number)
    .dbaUid(IResolvable)
    .envType(java.lang.String)
    .envType(IResolvable)
    .exportTimeout(java.lang.Number)
    .exportTimeout(IResolvable)
    .host(java.lang.String)
    .host(IResolvable)
    .instanceAlias(java.lang.String)
    .instanceAlias(IResolvable)
    .instanceSource(java.lang.String)
    .instanceSource(IResolvable)
    .instanceType(java.lang.String)
    .instanceType(IResolvable)
    .networkType(java.lang.String)
    .networkType(IResolvable)
    .port(java.lang.Number)
    .port(IResolvable)
    .queryTimeout(java.lang.Number)
    .queryTimeout(IResolvable)
    .safeRule(java.lang.String)
    .safeRule(IResolvable)
//  .dataLinkName(java.lang.String)
//  .dataLinkName(IResolvable)
//  .ddlOnline(java.lang.Number)
//  .ddlOnline(IResolvable)
//  .ecsInstanceId(java.lang.String)
//  .ecsInstanceId(IResolvable)
//  .ecsRegion(java.lang.String)
//  .ecsRegion(IResolvable)
//  .sid(java.lang.String)
//  .sid(IResolvable)
//  .tid(java.lang.Number)
//  .tid(IResolvable)
//  .useDsql(java.lang.Number)
//  .useDsql(IResolvable)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
    .build();

Properties

Name	Type	Description
databasePassword	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property databasePassword: The logon password of the database instance.
databaseUser	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property databaseUser: The logon username of the database instance.
dbaUid	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property dbaUid: The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of the database instance.
envType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property envType: The type of the environment to which the database instance belongs.
exportTimeout	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property exportTimeout: The timeout period for exporting the database instance.
host	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property host: The endpoint of the database instance.
instanceAlias	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceAlias: The alias of the database instance.
instanceSource	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceSource: The source of the database instance.
instanceType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceType: The type of the database instance.
networkType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property networkType: The network type of the database instance.
port	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property port: The connection port of the database instance.
queryTimeout	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property queryTimeout: The timeout period for querying the database instance.
safeRule	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property safeRule: The security rule of the database instance.
dataLinkName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property dataLinkName: The name of the data link for cross-database query.
ddlOnline	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property ddlOnline: [Important] Specifies whether to enable the online data description language (DDL) service.
ecsInstanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ecsInstanceId: The ID of the ECS instance to which the database instance belongs.
ecsRegion	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property ecsRegion: The region where the database instance resides.
sid	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property sid: The system ID (SID) of the database instance.
tid	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property tid: The ID of the tenant.
useDsql	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property useDsql: Specifies whether to enable cross-database query for the database instance.
vpcId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vpcId: The ID of the VPC to which the database instance belongs.

---

databasePassword^Required

public java.lang.Object getDatabasePassword();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property databasePassword: The logon password of the database instance.

---

databaseUser^Required

public java.lang.Object getDatabaseUser();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property databaseUser: The logon username of the database instance.

---

dbaUid^Required

public java.lang.Object getDbaUid();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getEnvType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getExportTimeout();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Unit: seconds.

---

host^Required

public java.lang.Object getHost();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property host: The endpoint of the database instance.

---

instanceAlias^Required

public java.lang.Object getInstanceAlias();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceAlias: The alias of the database instance.

The alias helps you quickly find the required instance.

---

instanceSource^Required

public java.lang.Object getInstanceSource();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getInstanceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceType: The type of the database instance.

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

---

networkType^Required

public java.lang.Object getNetworkType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property networkType: The network type of the database instance.

Valid values: CLASSIC VPC

---

port^Required

public java.lang.Object getPort();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property port: The connection port of the database instance.

---

queryTimeout^Required

public java.lang.Object getQueryTimeout();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Unit: seconds.

---

safeRule^Required

public java.lang.Object getSafeRule();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getDataLinkName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

ddlOnline^Optional

public java.lang.Object getDdlOnline();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getEcsInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getEcsRegion();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getSid();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getTid();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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 java.lang.Object getUseDsql();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: 0: disabled 1: enabled

---

vpcId^Optional

public java.lang.Object getVpcId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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.

---