Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer 

import ros_cdk_dms
ros_cdk_dms.InstanceProps(
  database_password: typing.Union[str, IResolvable],
  database_user: typing.Union[str, IResolvable],
  dba_uid: typing.Union[typing.Union[int, float], IResolvable],
  env_type: typing.Union[str, IResolvable],
  export_timeout: typing.Union[typing.Union[int, float], IResolvable],
  host: typing.Union[str, IResolvable],
  instance_alias: typing.Union[str, IResolvable],
  instance_source: typing.Union[str, IResolvable],
  instance_type: typing.Union[str, IResolvable],
  network_type: typing.Union[str, IResolvable],
  port: typing.Union[typing.Union[int, float], IResolvable],
  query_timeout: typing.Union[typing.Union[int, float], IResolvable],
  safe_rule: typing.Union[str, IResolvable],
  data_link_name: typing.Union[str, IResolvable] = None,
  ddl_online: typing.Union[typing.Union[int, float], IResolvable] = None,
  ecs_instance_id: typing.Union[str, IResolvable] = None,
  ecs_region: typing.Union[str, IResolvable] = None,
  sid: typing.Union[str, IResolvable] = None,
  tid: typing.Union[typing.Union[int, float], IResolvable] = None,
  use_dsql: typing.Union[typing.Union[int, float], IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
database_password typing.Union[str, ros_cdk_core.IResolvable] Property databasePassword: The logon password of the database instance.
database_user typing.Union[str, ros_cdk_core.IResolvable] Property databaseUser: The logon username of the database instance.
dba_uid typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dbaUid: The Alibaba Cloud unique ID (UID) of the database administrator (DBA) of the database instance.
env_type typing.Union[str, ros_cdk_core.IResolvable] Property envType: The type of the environment to which the database instance belongs.
export_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property exportTimeout: The timeout period for exporting the database instance.
host typing.Union[str, ros_cdk_core.IResolvable] Property host: The endpoint of the database instance.
instance_alias typing.Union[str, ros_cdk_core.IResolvable] Property instanceAlias: The alias of the database instance.
instance_source typing.Union[str, ros_cdk_core.IResolvable] Property instanceSource: The source of the database instance.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: The type of the database instance.
network_type typing.Union[str, ros_cdk_core.IResolvable] Property networkType: The network type of the database instance.
port typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property port: The connection port of the database instance.
query_timeout typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property queryTimeout: The timeout period for querying the database instance.
safe_rule typing.Union[str, ros_cdk_core.IResolvable] Property safeRule: The security rule of the database instance.
data_link_name typing.Union[str, ros_cdk_core.IResolvable] Property dataLinkName: The name of the data link for cross-database query.
ddl_online typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ddlOnline: [Important] Specifies whether to enable the online data description language (DDL) service.
ecs_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property ecsInstanceId: The ID of the ECS instance to which the database instance belongs.
ecs_region typing.Union[str, ros_cdk_core.IResolvable] Property ecsRegion: The region where the database instance resides.
sid typing.Union[str, ros_cdk_core.IResolvable] Property sid: The system ID (SID) of the database instance.
tid typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property tid: The ID of the tenant.
use_dsql typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property useDsql: Specifies whether to enable cross-database query for the database instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The ID of the VPC to which the database instance belongs.

database_passwordRequired 

database_password: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property databasePassword: The logon password of the database instance.

database_userRequired 

database_user: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property databaseUser: The logon username of the database instance.

dba_uidRequired 

dba_uid: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

env_typeRequired 

env_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

export_timeoutRequired 

export_timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Unit: seconds.

hostRequired 

host: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property host: The endpoint of the database instance.

instance_aliasRequired 

instance_alias: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceAlias: The alias of the database instance.

The alias helps you quickly find the required instance.

instance_sourceRequired 

instance_source: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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).

instance_typeRequired 

instance_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceType: The type of the database instance.

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

network_typeRequired 

network_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property networkType: The network type of the database instance.

Valid values: CLASSIC VPC

portRequired 

port: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property port: The connection port of the database instance.

query_timeoutRequired 

query_timeout: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Unit: seconds.

safe_ruleRequired 

safe_rule: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

data_link_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

ddl_onlineOptional 

ddl_online: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

ecs_instance_idOptional 

ecs_instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

ecs_regionOptional 

ecs_region: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

sid: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

tid: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], 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.

use_dsqlOptional 

use_dsql: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

Valid values: 0: disabled 1: enabled

vpc_idOptional 

vpc_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.