Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import { InstanceProps } from '@alicloud/ros-cdk-dms'
const instanceProps: InstanceProps = { ... }

Properties

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

databasePasswordRequired 

public readonly databasePassword: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property databasePassword: The logon password of the database instance.

databaseUserRequired 

public readonly databaseUser: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property databaseUser: The logon username of the database instance.

dbaUidRequired 

public readonly dbaUid: number | IResolvable;
  • Type: number | @alicloud/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.

envTypeRequired 

public readonly envType: string | IResolvable;
  • Type: string | @alicloud/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.

exportTimeoutRequired 

public readonly exportTimeout: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

Unit: seconds.

hostRequired 

public readonly host: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property host: The endpoint of the database instance.

instanceAliasRequired 

public readonly instanceAlias: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceAlias: The alias of the database instance.

The alias helps you quickly find the required instance.

instanceSourceRequired 

public readonly instanceSource: string | IResolvable;
  • Type: string | @alicloud/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).

instanceTypeRequired 

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceType: The type of the database instance.

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

networkTypeRequired 

public readonly networkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The network type of the database instance.

Valid values: CLASSIC VPC

portRequired 

public readonly port: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property port: The connection port of the database instance.

queryTimeoutRequired 

public readonly queryTimeout: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

Unit: seconds.

safeRuleRequired 

public readonly safeRule: string | IResolvable;
  • Type: string | @alicloud/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.

dataLinkNameOptional 

public readonly dataLinkName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

ddlOnlineOptional 

public readonly ddlOnline: number | IResolvable;
  • Type: number | @alicloud/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.

ecsInstanceIdOptional 

public readonly ecsInstanceId: string | IResolvable;
  • Type: string | @alicloud/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.

ecsRegionOptional 

public readonly ecsRegion: string | IResolvable;
  • Type: string | @alicloud/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.

sidOptional 

public readonly sid: string | IResolvable;
  • Type: string | @alicloud/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.

tidOptional 

public readonly tid: number | IResolvable;
  • Type: number | @alicloud/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.

useDsqlOptional 

public readonly useDsql: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

Valid values: 0: disabled 1: enabled

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/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.