Skip to content

Instance2Props

Properties for defining a Instance2.

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

Initializer 

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

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.
dbaId number | @alicloud/ros-cdk-core.IResolvable Property dbaId: The user ID of the instance DBA role.
enableSellTrust string | @alicloud/ros-cdk-core.IResolvable Property enableSellTrust: Whether the instance needs to enable secure hosting.
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.
enableSellCommon string | @alicloud/ros-cdk-core.IResolvable Property enableSellCommon: Whether the instance needs to enable the security collaboration function.
enableSellSitd string | @alicloud/ros-cdk-core.IResolvable Property enableSellSitd: Y: enables the sensitive data protection feature NULL or other: disables the sensitive data protection feature.
enableSellStable string | @alicloud/ros-cdk-core.IResolvable Property enableSellStable: Whether the instance needs to enable the stable change function.
sid string | @alicloud/ros-cdk-core.IResolvable Property sid: The system ID (SID) of the database instance.
skipTest boolean | @alicloud/ros-cdk-core.IResolvable Property skipTest: Whether the instance ignores the test connectivity.
templateId number | @alicloud/ros-cdk-core.IResolvable Property templateId: The ID of the classification template.
templateType string | @alicloud/ros-cdk-core.IResolvable Property templateType: The type of the classification template.
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.
useSsl number | @alicloud/ros-cdk-core.IResolvable Property useSsl: Select whether to enable SSL connection.
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.

dbaIdRequired 

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

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.

enableSellTrustRequired 

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

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

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

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.

enableSellCommonOptional 

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

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

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

enableSellSitdOptional 

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

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

enableSellStableOptional 

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

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

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

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.

skipTestOptional 

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

Property skipTest: Whether the instance ignores the test connectivity.

The values are as follows: - true: ignore - false: do not ignore

templateIdOptional 

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

Property templateId: The ID of the classification template.

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

templateTypeOptional 

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

Property templateType: The type of the classification template.

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

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

useSslOptional 

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

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.

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.