Module dms

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

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.

Resources

EnterpriseInstance

Resources

Resource EnterpriseInstance

class EnterpriseInstance extends CustomResource

Provides a DMS Enterprise Instance resource.

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const defaultEnterpriseInstance = new alicloud.dms.EnterpriseInstance("default", {
    databasePassword: "Yourpassword123",
    databaseUser: "yourUserName",
    dbaUid: Number.parseFloat("1182725234xxxxxxx"),
    ecsRegion: "cn-shanghai",
    envType: "test",
    exportTimeout: 600,
    host: "rm-uf648hgsxxxxxx.mysql.rds.aliyuncs.com",
    instanceAlias: "yourAliasName",
    instanceSource: "RDS",
    instanceType: "MySQL",
    networkType: "VPC",
    port: 3306,
    queryTimeout: 60,
    safeRule: "自由操作",
    tid: 12345,
});

constructor

new EnterpriseInstance(name: string, args: EnterpriseInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a EnterpriseInstance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EnterpriseInstanceState, opts?: pulumi.CustomResourceOptions): EnterpriseInstance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EnterpriseInstance

Returns true if the given object is an instance of EnterpriseInstance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dataLinkName

public dataLinkName: pulumi.Output<string | undefined>;

Cross-database query datalink name.

property databasePassword

public databasePassword: pulumi.Output<string>;

Database access password.

property databaseUser

public databaseUser: pulumi.Output<string>;

Database access account.

property dbaId

public dbaId: pulumi.Output<string>;

property dbaNickName

public dbaNickName: pulumi.Output<string>;

The instance dba nickname.

property dbaUid

public dbaUid: pulumi.Output<number>;

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

property ddlOnline

public ddlOnline: pulumi.Output<number | undefined>;

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.

property ecsInstanceId

public ecsInstanceId: pulumi.Output<string>;

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

property ecsRegion

public ecsRegion: pulumi.Output<string | undefined>;

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.

property envType

public envType: pulumi.Output<string>;

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.

property exportTimeout

public exportTimeout: pulumi.Output<number>;

Export timeout, unit: s (seconds).

property host

public host: pulumi.Output<string>;

Host address of the target database.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceAlias

public instanceAlias: pulumi.Output<string>;

Instance alias, to help users quickly distinguish positioning.

property instanceId

public instanceId: pulumi.Output<string>;

property instanceSource

public instanceSource: pulumi.Output<string>;

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

property instanceType

public instanceType: pulumi.Output<string>;

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

property networkType

public networkType: pulumi.Output<string>;

Network type. Valid values: CLASSIC, VPC.

property port

public port: pulumi.Output<number>;

Access port of the target database.

property queryTimeout

public queryTimeout: pulumi.Output<number>;

Query timeout time, unit: s (seconds).

property safeRule

public safeRule: pulumi.Output<string>;

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

property safeRuleId

public safeRuleId: pulumi.Output<string>;

property sid

public sid: pulumi.Output<string | undefined>;

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

property state

public state: pulumi.Output<string>;

The instance status.

property tid

public tid: pulumi.Output<number | undefined>;

The tenant ID.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property useDsql

public useDsql: pulumi.Output<number | undefined>;

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

property vpcId

public vpcId: pulumi.Output<string | undefined>;

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

Others

interface EnterpriseInstanceArgs

interface EnterpriseInstanceArgs

The set of arguments for constructing a EnterpriseInstance resource.

property dataLinkName

dataLinkName?: pulumi.Input<string>;

Cross-database query datalink name.

property databasePassword

databasePassword: pulumi.Input<string>;

Database access password.

property databaseUser

databaseUser: pulumi.Input<string>;

Database access account.

property dbaId

dbaId?: pulumi.Input<string>;

property dbaUid

dbaUid: pulumi.Input<number>;

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

property ddlOnline

ddlOnline?: pulumi.Input<number>;

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.

property ecsInstanceId

ecsInstanceId?: pulumi.Input<string>;

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

property ecsRegion

ecsRegion?: pulumi.Input<string>;

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.

property envType

envType: pulumi.Input<string>;

property exportTimeout

exportTimeout: pulumi.Input<number>;

Export timeout, unit: s (seconds).

property host

host: pulumi.Input<string>;

Host address of the target database.

property instanceAlias

instanceAlias: pulumi.Input<string>;

Instance alias, to help users quickly distinguish positioning.

property instanceId

instanceId?: pulumi.Input<string>;

property instanceSource

instanceSource: pulumi.Input<string>;

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

property instanceType

instanceType: pulumi.Input<string>;

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

property networkType

networkType: pulumi.Input<string>;

Network type. Valid values: CLASSIC, VPC.

property port

port: pulumi.Input<number>;

Access port of the target database.

property queryTimeout

queryTimeout: pulumi.Input<number>;

Query timeout time, unit: s (seconds).

property safeRule

safeRule: pulumi.Input<string>;

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

property safeRuleId

safeRuleId?: pulumi.Input<string>;

property sid

sid?: pulumi.Input<string>;

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

property tid

tid?: pulumi.Input<number>;

The tenant ID.

property useDsql

useDsql?: pulumi.Input<number>;

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

property vpcId

vpcId?: pulumi.Input<string>;

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

interface EnterpriseInstanceState

interface EnterpriseInstanceState

Input properties used for looking up and filtering EnterpriseInstance resources.

property dataLinkName

dataLinkName?: pulumi.Input<string>;

Cross-database query datalink name.

property databasePassword

databasePassword?: pulumi.Input<string>;

Database access password.

property databaseUser

databaseUser?: pulumi.Input<string>;

Database access account.

property dbaId

dbaId?: pulumi.Input<string>;

property dbaNickName

dbaNickName?: pulumi.Input<string>;

The instance dba nickname.

property dbaUid

dbaUid?: pulumi.Input<number>;

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

property ddlOnline

ddlOnline?: pulumi.Input<number>;

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.

property ecsInstanceId

ecsInstanceId?: pulumi.Input<string>;

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

property ecsRegion

ecsRegion?: pulumi.Input<string>;

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.