dms¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.dms.AwaitableGetEnterpriseInstancesResult(env_type=None, id=None, instance_alias_regex=None, instance_source=None, instance_type=None, instances=None, net_type=None, output_file=None, search_key=None, status=None, tid=None)¶

class pulumi_alicloud.dms.EnterpriseInstance(resource_name, opts=None, data_link_name=None, database_password=None, database_user=None, dba_id=None, dba_uid=None, ddl_online=None, ecs_instance_id=None, ecs_region=None, env_type=None, export_timeout=None, host=None, instance_alias=None, instance_id=None, instance_source=None, instance_type=None, network_type=None, port=None, query_timeout=None, safe_rule=None, safe_rule_id=None, sid=None, tid=None, use_dsql=None, vpc_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a DMS Enterprise Instance resource.

NOTE: API users must first register in DMS. NOTE: Available in 1.81.0+.

import pulumi
import pulumi_alicloud as alicloud

default = alicloud.dms.EnterpriseInstance("default",
    database_password="Yourpassword123",
    database_user="your_user_name",
    dba_uid="1182725234xxxxxxx",
    ecs_region="cn-shanghai",
    env_type="test",
    export_timeout=600,
    host="rm-uf648hgsxxxxxx.mysql.rds.aliyuncs.com",
    instance_alias="your_alias_name",
    instance_source="RDS",
    instance_type="MySQL",
    network_type="VPC",
    port=3306,
    query_timeout=60,
    safe_rule="自由操作",
    tid="12345")

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• data_link_name (pulumi.Input[str]) – Cross-database query datalink name.

• database_password (pulumi.Input[str]) – Database access password.

• database_user (pulumi.Input[str]) – Database access account.

• dba_uid (pulumi.Input[float]) – The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.

• ddl_online (pulumi.Input[float]) – Whether to use online services, currently only supports MySQL and PolarDB. Valid values: 0 Not used, 1 Native online DDL priority, 2 DMS lock-free table structure change priority.

• ecs_instance_id (pulumi.Input[str]) – ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.

• ecs_region (pulumi.Input[str]) – The region where the instance is located. This value must be passed when the value of InstanceSource is RDS, ECS self-built library, and VPC dedicated line IDC.

• env_type (pulumi.Input[str]) – Environment type. Valid values: product production environment, dev development environment, pre pre-release environment, test test environment, sit SIT environment, uat UAT environment, pet pressure test environment, stag STAG environment.

• export_timeout (pulumi.Input[float]) – Export timeout, unit: s (seconds).

• host (pulumi.Input[str]) – Host address of the target database.

• instance_alias (pulumi.Input[str]) – Instance alias, to help users quickly distinguish positioning.

• instance_source (pulumi.Input[str]) – The source of the database instance. Valid values: PUBLIC_OWN, RDS, ECS_OWN, VPC_IDC.

• instance_type (pulumi.Input[str]) – Database type. Valid values: MySQL, SQLServer, PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis.

• network_type (pulumi.Input[str]) – Network type. Valid values: CLASSIC, VPC.

• port (pulumi.Input[float]) – Access port of the target database.

• query_timeout (pulumi.Input[float]) – Query timeout time, unit: s (seconds).

• safe_rule (pulumi.Input[str]) – The security rule of the instance is passed into the name of the security rule in the enterprise.

• sid (pulumi.Input[str]) – The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.

• tid (pulumi.Input[float]) – The tenant ID.

• use_dsql (pulumi.Input[float]) – Whether to enable cross-instance query. Valid values: 0 not open, 1 open.

• vpc_id (pulumi.Input[str]) – VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.

data_link_name: pulumi.Output[str] = None¶

Cross-database query datalink name.

database_password: pulumi.Output[str] = None¶

Database access password.

database_user: pulumi.Output[str] = None¶

Database access account.

dba_nick_name: pulumi.Output[str] = None¶

The instance dba nickname.

dba_uid: pulumi.Output[float] = None¶

The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.

ddl_online: pulumi.Output[float] = None¶

Whether to use online services, currently only supports MySQL and PolarDB. Valid values: 0 Not used, 1 Native online DDL priority, 2 DMS lock-free table structure change priority.

ecs_instance_id: pulumi.Output[str] = None¶

ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.

ecs_region: pulumi.Output[str] = None¶

The region where the instance is located. This value must be passed when the value of InstanceSource is RDS, ECS self-built library, and VPC dedicated line IDC.

env_type: pulumi.Output[str] = None¶

Environment type. Valid values: product production environment, dev development environment, pre pre-release environment, test test environment, sit SIT environment, uat UAT environment, pet pressure test environment, stag STAG environment.

export_timeout: pulumi.Output[float] = None¶

Export timeout, unit: s (seconds).

host: pulumi.Output[str] = None¶

Host address of the target database.

instance_alias: pulumi.Output[str] = None¶

Instance alias, to help users quickly distinguish positioning.

instance_source: pulumi.Output[str] = None¶

The source of the database instance. Valid values: PUBLIC_OWN, RDS, ECS_OWN, VPC_IDC.

instance_type: pulumi.Output[str] = None¶

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

network_type: pulumi.Output[str] = None¶

Network type. Valid values: CLASSIC, VPC.

port: pulumi.Output[float] = None¶

Access port of the target database.

query_timeout: pulumi.Output[float] = None¶

Query timeout time, unit: s (seconds).

safe_rule: pulumi.Output[str] = None¶

The security rule of the instance is passed into the name of the security rule in the enterprise.

sid: pulumi.Output[str] = None¶

The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.

state: pulumi.Output[str] = None¶

The instance status.

tid: pulumi.Output[float] = None¶

The tenant ID.

use_dsql: pulumi.Output[float] = None¶

Whether to enable cross-instance query. Valid values: 0 not open, 1 open.

vpc_id: pulumi.Output[str] = None¶

VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.

static get(resource_name, id, opts=None, data_link_name=None, database_password=None, database_user=None, dba_id=None, dba_nick_name=None, dba_uid=None, ddl_online=None, ecs_instance_id=None, ecs_region=None, env_type=None, export_timeout=None, host=None, instance_alias=None, instance_id=None, instance_source=None, instance_type=None, network_type=None, port=None, query_timeout=None, safe_rule=None, safe_rule_id=None, sid=None, state=None, tid=None, use_dsql=None, vpc_id=None)¶

Get an existing EnterpriseInstance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• data_link_name (pulumi.Input[str]) – Cross-database query datalink name.

• database_password (pulumi.Input[str]) – Database access password.

• database_user (pulumi.Input[str]) – Database access account.

• dba_nick_name (pulumi.Input[str]) – The instance dba nickname.

• dba_uid (pulumi.Input[float]) – The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.

• ddl_online (pulumi.Input[float]) – Whether to use online services, currently only supports MySQL and PolarDB. Valid values: 0 Not used, 1 Native online DDL priority, 2 DMS lock-free table structure change priority.

• ecs_instance_id (pulumi.Input[str]) – ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.

• ecs_region (pulumi.Input[str]) – The region where the instance is located. This value must be passed when the value of InstanceSource is RDS, ECS self-built library, and VPC dedicated line IDC.

• env_type (pulumi.Input[str]) – Environment type. Valid values: product production environment, dev development environment, pre pre-release environment, test test environment, sit SIT environment, uat UAT environment, pet pressure test environment, stag STAG environment.

• export_timeout (pulumi.Input[float]) – Export timeout, unit: s (seconds).

• host (pulumi.Input[str]) – Host address of the target database.

• instance_alias (pulumi.Input[str]) – Instance alias, to help users quickly distinguish positioning.

• instance_source (pulumi.Input[str]) – The source of the database instance. Valid values: PUBLIC_OWN, RDS, ECS_OWN, VPC_IDC.

• instance_type (pulumi.Input[str]) – Database type. Valid values: MySQL, SQLServer, PostgreSQL, Oracle, DRDS, OceanBase, Mongo, Redis.

• network_type (pulumi.Input[str]) – Network type. Valid values: CLASSIC, VPC.

• port (pulumi.Input[float]) – Access port of the target database.

• query_timeout (pulumi.Input[float]) – Query timeout time, unit: s (seconds).

• safe_rule (pulumi.Input[str]) – The security rule of the instance is passed into the name of the security rule in the enterprise.

• sid (pulumi.Input[str]) – The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.

• state (pulumi.Input[str]) – The instance status.

• tid (pulumi.Input[float]) – The tenant ID.

• use_dsql (pulumi.Input[float]) – Whether to enable cross-instance query. Valid values: 0 not open, 1 open.

• vpc_id (pulumi.Input[str]) – VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_alicloud.dms.GetEnterpriseInstancesResult(env_type=None, id=None, instance_alias_regex=None, instance_source=None, instance_type=None, instances=None, net_type=None, output_file=None, search_key=None, status=None, tid=None)¶

A collection of values returned by getEnterpriseInstances.

env_type = None¶

The type of the environment to which the database instance belongs..

id = None¶

The provider-assigned unique ID for this managed resource.

instance_source = None¶

The ID of the database instance.

instance_type = None¶

The ID of the database instance.

instances = None¶

A list of KMS keys. Each element contains the following attributes:

status = None¶

The status of the database instance.

pulumi_alicloud.dms.get_enterprise_instances(env_type=None, instance_alias_regex=None, instance_source=None, instance_type=None, net_type=None, output_file=None, search_key=None, status=None, tid=None, opts=None)¶

This data source provides a list of DMS Enterprise Instances in an Alibaba Cloud account according to the specified filters.

NOTE: Available in 1.88.0+

Parameters

• env_type (str) – The type of the environment to which the database instance belongs.

• instance_alias_regex (str) – A regex string to filter the results by the DMS Enterprise Instance instance_alias.

• instance_source (str) – The source of the database instance.

• instance_type (str) – The ID of the database instance.

• net_type (str) – The network type of the database instance. Valid values: CLASSIC and VPC. For more information about the valid values, see the description of the RegisterInstance operation.

• search_key (str) – The keyword used to query database instances.

• status (str) – Filter the results by status of the DMS Enterprise Instances. Valid values: NORMAL, UNAVAILABLE, UNKNOWN, DELETED, DISABLE.

• tid (float) – The ID of the tenant in Data Management (DMS) Enterprise.