Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.27.0 published on Monday, Aug 8, 2022 by Pulumi

EnterpriseInstance

Provides a DMS Enterprise Instance resource.

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

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new AliCloud.Dms.EnterpriseInstance("default", new AliCloud.Dms.EnterpriseInstanceArgs
        {
            DatabasePassword = "Yourpassword123",
            DatabaseUser = "your_user_name",
            DbaUid = "1182725234xxxxxxx",
            EcsRegion = "cn-shanghai",
            EnvType = "test",
            ExportTimeout = 600,
            Host = "rm-uf648hgsxxxxxx.mysql.rds.aliyuncs.com",
            InstanceName = "your_alias_name",
            InstanceSource = "RDS",
            InstanceType = "MySQL",
            NetworkType = "VPC",
            Port = 3306,
            QueryTimeout = 60,
            SafeRule = "自由操作",
            Tid = 12345,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dms.NewEnterpriseInstance(ctx, "default", &dms.EnterpriseInstanceArgs{
			DatabasePassword: pulumi.String("Yourpassword123"),
			DatabaseUser:     pulumi.String("your_user_name"),
			DbaUid:           pulumi.Int("1182725234xxxxxxx"),
			EcsRegion:        pulumi.String("cn-shanghai"),
			EnvType:          pulumi.String("test"),
			ExportTimeout:    pulumi.Int(600),
			Host:             pulumi.String("rm-uf648hgsxxxxxx.mysql.rds.aliyuncs.com"),
			InstanceName:     pulumi.String("your_alias_name"),
			InstanceSource:   pulumi.String("RDS"),
			InstanceType:     pulumi.String("MySQL"),
			NetworkType:      pulumi.String("VPC"),
			Port:             pulumi.Int(3306),
			QueryTimeout:     pulumi.Int(60),
			SafeRule:         pulumi.String("自由操作"),
			Tid:              pulumi.Int(12345),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.dms.EnterpriseInstance;
import com.pulumi.alicloud.dms.EnterpriseInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var default_ = new EnterpriseInstance("default", EnterpriseInstanceArgs.builder()        
            .databasePassword("Yourpassword123")
            .databaseUser("your_user_name")
            .dbaUid("1182725234xxxxxxx")
            .ecsRegion("cn-shanghai")
            .envType("test")
            .exportTimeout(600)
            .host("rm-uf648hgsxxxxxx.mysql.rds.aliyuncs.com")
            .instanceName("your_alias_name")
            .instanceSource("RDS")
            .instanceType("MySQL")
            .networkType("VPC")
            .port(3306)
            .queryTimeout(60)
            .safeRule("自由操作")
            .tid("12345")
            .build());

    }
}
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_name="your_alias_name",
    instance_source="RDS",
    instance_type="MySQL",
    network_type="VPC",
    port=3306,
    query_timeout=60,
    safe_rule="自由操作",
    tid=12345)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

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

Create a EnterpriseInstance Resource

new EnterpriseInstance(name: string, args: EnterpriseInstanceArgs, opts?: CustomResourceOptions);
@overload
def EnterpriseInstance(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       data_link_name: Optional[str] = None,
                       database_password: Optional[str] = None,
                       database_user: Optional[str] = None,
                       dba_id: Optional[str] = None,
                       dba_uid: Optional[int] = None,
                       ddl_online: Optional[int] = None,
                       ecs_instance_id: Optional[str] = None,
                       ecs_region: Optional[str] = None,
                       env_type: Optional[str] = None,
                       export_timeout: Optional[int] = None,
                       host: Optional[str] = None,
                       instance_alias: Optional[str] = None,
                       instance_id: Optional[str] = None,
                       instance_name: Optional[str] = None,
                       instance_source: Optional[str] = None,
                       instance_type: Optional[str] = None,
                       network_type: Optional[str] = None,
                       port: Optional[int] = None,
                       query_timeout: Optional[int] = None,
                       safe_rule: Optional[str] = None,
                       safe_rule_id: Optional[str] = None,
                       sid: Optional[str] = None,
                       skip_test: Optional[bool] = None,
                       tid: Optional[int] = None,
                       use_dsql: Optional[int] = None,
                       vpc_id: Optional[str] = None)
@overload
def EnterpriseInstance(resource_name: str,
                       args: EnterpriseInstanceArgs,
                       opts: Optional[ResourceOptions] = None)
func NewEnterpriseInstance(ctx *Context, name string, args EnterpriseInstanceArgs, opts ...ResourceOption) (*EnterpriseInstance, error)
public EnterpriseInstance(string name, EnterpriseInstanceArgs args, CustomResourceOptions? opts = null)
public EnterpriseInstance(String name, EnterpriseInstanceArgs args)
public EnterpriseInstance(String name, EnterpriseInstanceArgs args, CustomResourceOptions options)
type: alicloud:dms:EnterpriseInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EnterpriseInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EnterpriseInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EnterpriseInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnterpriseInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnterpriseInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EnterpriseInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EnterpriseInstance resource accepts the following input properties:

DatabasePassword string

Database access password.

DatabaseUser string

Database access account.

DbaUid int

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

EnvType 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.

ExportTimeout int

Export timeout, unit: s (seconds).

Host string

Host address of the target database.

InstanceSource string

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

InstanceType string

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

NetworkType string

Network type. Valid values: CLASSIC, VPC.

Port int

Access port of the target database.

QueryTimeout int

Query timeout time, unit: s (seconds).

SafeRule string

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

DataLinkName string

Cross-database query datalink name.

DbaId string

The dba id of the database instance.

DdlOnline int

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.

EcsInstanceId string

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

EcsRegion 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.

InstanceAlias string

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

InstanceId string

The instance id of the database instance.

InstanceName string

Instance name, to help users quickly distinguish positioning.

SafeRuleId string

The safe rule id of the database instance.

Sid string

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

SkipTest bool

Whether the instance ignores test connectivity. Valid values: true, false.

Tid int

The tenant ID.

UseDsql int

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

VpcId string

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

DatabasePassword string

Database access password.

DatabaseUser string

Database access account.

DbaUid int

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

EnvType 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.

ExportTimeout int

Export timeout, unit: s (seconds).

Host string

Host address of the target database.

InstanceSource string

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

InstanceType string

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

NetworkType string

Network type. Valid values: CLASSIC, VPC.

Port int

Access port of the target database.

QueryTimeout int

Query timeout time, unit: s (seconds).

SafeRule string

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

DataLinkName string

Cross-database query datalink name.

DbaId string

The dba id of the database instance.

DdlOnline int

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.

EcsInstanceId string

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

EcsRegion 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.

InstanceAlias string

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

InstanceId string

The instance id of the database instance.

InstanceName string

Instance name, to help users quickly distinguish positioning.

SafeRuleId string

The safe rule id of the database instance.

Sid string

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

SkipTest bool

Whether the instance ignores test connectivity. Valid values: true, false.

Tid int

The tenant ID.

UseDsql int

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

VpcId string

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

databasePassword String

Database access password.

databaseUser String

Database access account.

dbaUid Integer

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

envType 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.

exportTimeout Integer

Export timeout, unit: s (seconds).

host String

Host address of the target database.

instanceSource String

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

instanceType String

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

networkType String

Network type. Valid values: CLASSIC, VPC.

port Integer

Access port of the target database.

queryTimeout Integer

Query timeout time, unit: s (seconds).

safeRule String

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

dataLinkName String

Cross-database query datalink name.

dbaId String

The dba id of the database instance.

ddlOnline Integer

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.

ecsInstanceId String

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

ecsRegion 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.

instanceAlias String

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instanceId String

The instance id of the database instance.

instanceName String

Instance name, to help users quickly distinguish positioning.

safeRuleId String

The safe rule id of the database instance.

sid String

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

skipTest Boolean

Whether the instance ignores test connectivity. Valid values: true, false.

tid Integer

The tenant ID.

useDsql Integer

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

vpcId String

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

databasePassword string

Database access password.

databaseUser string

Database access account.

dbaUid number

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

envType 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.

exportTimeout number

Export timeout, unit: s (seconds).

host string

Host address of the target database.

instanceSource string

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

instanceType string

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

networkType string

Network type. Valid values: CLASSIC, VPC.

port number

Access port of the target database.

queryTimeout number

Query timeout time, unit: s (seconds).

safeRule string

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

dataLinkName string

Cross-database query datalink name.

dbaId string

The dba id of the database instance.

ddlOnline 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.

ecsInstanceId string

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

ecsRegion 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.

instanceAlias string

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instanceId string

The instance id of the database instance.

instanceName string

Instance name, to help users quickly distinguish positioning.

safeRuleId string

The safe rule id of the database instance.

sid string

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

skipTest boolean

Whether the instance ignores test connectivity. Valid values: true, false.

tid number

The tenant ID.

useDsql number

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

vpcId string

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

database_password str

Database access password.

database_user str

Database access account.

dba_uid int

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

env_type 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 int

Export timeout, unit: s (seconds).

host str

Host address of the target database.

instance_source str

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

instance_type str

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

network_type str

Network type. Valid values: CLASSIC, VPC.

port int

Access port of the target database.

query_timeout int

Query timeout time, unit: s (seconds).

safe_rule str

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

data_link_name str

Cross-database query datalink name.

dba_id str

The dba id of the database instance.

ddl_online int

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 str

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

ecs_region 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.

instance_alias str

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instance_id str

The instance id of the database instance.

instance_name str

Instance name, to help users quickly distinguish positioning.

safe_rule_id str

The safe rule id of the database instance.

sid str

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

skip_test bool

Whether the instance ignores test connectivity. Valid values: true, false.

tid int

The tenant ID.

use_dsql int

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

vpc_id str

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

databasePassword String

Database access password.

databaseUser String

Database access account.

dbaUid Number

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

envType 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.

exportTimeout Number

Export timeout, unit: s (seconds).

host String

Host address of the target database.

instanceSource String

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

instanceType String

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

networkType String

Network type. Valid values: CLASSIC, VPC.

port Number

Access port of the target database.

queryTimeout Number

Query timeout time, unit: s (seconds).

safeRule String

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

dataLinkName String

Cross-database query datalink name.

dbaId String

The dba id of the database instance.

ddlOnline 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.

ecsInstanceId String

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

ecsRegion 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.

instanceAlias String

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instanceId String

The instance id of the database instance.

instanceName String

Instance name, to help users quickly distinguish positioning.

safeRuleId String

The safe rule id of the database instance.

sid String

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

skipTest Boolean

Whether the instance ignores test connectivity. Valid values: true, false.

tid Number

The tenant ID.

useDsql Number

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

vpcId String

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

Outputs

All input properties are implicitly available as output properties. Additionally, the EnterpriseInstance resource produces the following output properties:

DbaNickName string

The instance dba nickname.

Id string

The provider-assigned unique ID for this managed resource.

State string

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

Status string

The instance status.

DbaNickName string

The instance dba nickname.

Id string

The provider-assigned unique ID for this managed resource.

State string

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

Status string

The instance status.

dbaNickName String

The instance dba nickname.

id String

The provider-assigned unique ID for this managed resource.

state String

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status String

The instance status.

dbaNickName string

The instance dba nickname.

id string

The provider-assigned unique ID for this managed resource.

state string

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status string

The instance status.

dba_nick_name str

The instance dba nickname.

id str

The provider-assigned unique ID for this managed resource.

state str

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status str

The instance status.

dbaNickName String

The instance dba nickname.

id String

The provider-assigned unique ID for this managed resource.

state String

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status String

The instance status.

Look up an Existing EnterpriseInstance Resource

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

public static get(name: string, id: Input<ID>, state?: EnterpriseInstanceState, opts?: CustomResourceOptions): EnterpriseInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_link_name: Optional[str] = None,
        database_password: Optional[str] = None,
        database_user: Optional[str] = None,
        dba_id: Optional[str] = None,
        dba_nick_name: Optional[str] = None,
        dba_uid: Optional[int] = None,
        ddl_online: Optional[int] = None,
        ecs_instance_id: Optional[str] = None,
        ecs_region: Optional[str] = None,
        env_type: Optional[str] = None,
        export_timeout: Optional[int] = None,
        host: Optional[str] = None,
        instance_alias: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_source: Optional[str] = None,
        instance_type: Optional[str] = None,
        network_type: Optional[str] = None,
        port: Optional[int] = None,
        query_timeout: Optional[int] = None,
        safe_rule: Optional[str] = None,
        safe_rule_id: Optional[str] = None,
        sid: Optional[str] = None,
        skip_test: Optional[bool] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        tid: Optional[int] = None,
        use_dsql: Optional[int] = None,
        vpc_id: Optional[str] = None) -> EnterpriseInstance
func GetEnterpriseInstance(ctx *Context, name string, id IDInput, state *EnterpriseInstanceState, opts ...ResourceOption) (*EnterpriseInstance, error)
public static EnterpriseInstance Get(string name, Input<string> id, EnterpriseInstanceState? state, CustomResourceOptions? opts = null)
public static EnterpriseInstance get(String name, Output<String> id, EnterpriseInstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DataLinkName string

Cross-database query datalink name.

DatabasePassword string

Database access password.

DatabaseUser string

Database access account.

DbaId string

The dba id of the database instance.

DbaNickName string

The instance dba nickname.

DbaUid int

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

DdlOnline int

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.

EcsInstanceId string

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

EcsRegion 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.

EnvType 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.

ExportTimeout int

Export timeout, unit: s (seconds).

Host string

Host address of the target database.

InstanceAlias string

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

InstanceId string

The instance id of the database instance.

InstanceName string

Instance name, to help users quickly distinguish positioning.

InstanceSource string

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

InstanceType string

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

NetworkType string

Network type. Valid values: CLASSIC, VPC.

Port int

Access port of the target database.

QueryTimeout int

Query timeout time, unit: s (seconds).

SafeRule string

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

SafeRuleId string

The safe rule id of the database instance.

Sid string

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

SkipTest bool

Whether the instance ignores test connectivity. Valid values: true, false.

State string

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

Status string

The instance status.

Tid int

The tenant ID.

UseDsql int

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

VpcId string

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

DataLinkName string

Cross-database query datalink name.

DatabasePassword string

Database access password.

DatabaseUser string

Database access account.

DbaId string

The dba id of the database instance.

DbaNickName string

The instance dba nickname.

DbaUid int

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

DdlOnline int

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.

EcsInstanceId string

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

EcsRegion 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.

EnvType 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.

ExportTimeout int

Export timeout, unit: s (seconds).

Host string

Host address of the target database.

InstanceAlias string

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

InstanceId string

The instance id of the database instance.

InstanceName string

Instance name, to help users quickly distinguish positioning.

InstanceSource string

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

InstanceType string

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

NetworkType string

Network type. Valid values: CLASSIC, VPC.

Port int

Access port of the target database.

QueryTimeout int

Query timeout time, unit: s (seconds).

SafeRule string

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

SafeRuleId string

The safe rule id of the database instance.

Sid string

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

SkipTest bool

Whether the instance ignores test connectivity. Valid values: true, false.

State string

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

Status string

The instance status.

Tid int

The tenant ID.

UseDsql int

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

VpcId string

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

dataLinkName String

Cross-database query datalink name.

databasePassword String

Database access password.

databaseUser String

Database access account.

dbaId String

The dba id of the database instance.

dbaNickName String

The instance dba nickname.

dbaUid Integer

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

ddlOnline Integer

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.

ecsInstanceId String

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

ecsRegion 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.

envType 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.

exportTimeout Integer

Export timeout, unit: s (seconds).

host String

Host address of the target database.

instanceAlias String

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instanceId String

The instance id of the database instance.

instanceName String

Instance name, to help users quickly distinguish positioning.

instanceSource String

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

instanceType String

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

networkType String

Network type. Valid values: CLASSIC, VPC.

port Integer

Access port of the target database.

queryTimeout Integer

Query timeout time, unit: s (seconds).

safeRule String

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

safeRuleId String

The safe rule id of the database instance.

sid String

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

skipTest Boolean

Whether the instance ignores test connectivity. Valid values: true, false.

state String

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status String

The instance status.

tid Integer

The tenant ID.

useDsql Integer

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

vpcId String

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

dataLinkName string

Cross-database query datalink name.

databasePassword string

Database access password.

databaseUser string

Database access account.

dbaId string

The dba id of the database instance.

dbaNickName string

The instance dba nickname.

dbaUid number

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

ddlOnline 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.

ecsInstanceId string

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

ecsRegion 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.

envType 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.

exportTimeout number

Export timeout, unit: s (seconds).

host string

Host address of the target database.

instanceAlias string

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instanceId string

The instance id of the database instance.

instanceName string

Instance name, to help users quickly distinguish positioning.

instanceSource string

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

instanceType string

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

networkType string

Network type. Valid values: CLASSIC, VPC.

port number

Access port of the target database.

queryTimeout number

Query timeout time, unit: s (seconds).

safeRule string

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

safeRuleId string

The safe rule id of the database instance.

sid string

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

skipTest boolean

Whether the instance ignores test connectivity. Valid values: true, false.

state string

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status string

The instance status.

tid number

The tenant ID.

useDsql number

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

vpcId string

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

data_link_name str

Cross-database query datalink name.

database_password str

Database access password.

database_user str

Database access account.

dba_id str

The dba id of the database instance.

dba_nick_name str

The instance dba nickname.

dba_uid int

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

ddl_online int

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 str

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

ecs_region 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 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 int

Export timeout, unit: s (seconds).

host str

Host address of the target database.

instance_alias str

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instance_id str

The instance id of the database instance.

instance_name str

Instance name, to help users quickly distinguish positioning.

instance_source str

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

instance_type str

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

network_type str

Network type. Valid values: CLASSIC, VPC.

port int

Access port of the target database.

query_timeout int

Query timeout time, unit: s (seconds).

safe_rule str

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

safe_rule_id str

The safe rule id of the database instance.

sid str

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

skip_test bool

Whether the instance ignores test connectivity. Valid values: true, false.

state str

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status str

The instance status.

tid int

The tenant ID.

use_dsql int

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

vpc_id str

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

dataLinkName String

Cross-database query datalink name.

databasePassword String

Database access password.

databaseUser String

Database access account.

dbaId String

The dba id of the database instance.

dbaNickName String

The instance dba nickname.

dbaUid Number

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

ddlOnline 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.

ecsInstanceId String

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

ecsRegion 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.

envType 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.

exportTimeout Number

Export timeout, unit: s (seconds).

host String

Host address of the target database.

instanceAlias String

Field instance_alias has been deprecated from version 1.100.0. Use instance_name instead.

Deprecated:

Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.

instanceId String

The instance id of the database instance.

instanceName String

Instance name, to help users quickly distinguish positioning.

instanceSource String

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

instanceType String

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

networkType String

Network type. Valid values: CLASSIC, VPC.

port Number

Access port of the target database.

queryTimeout Number

Query timeout time, unit: s (seconds).

safeRule String

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

safeRuleId String

The safe rule id of the database instance.

sid String

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

skipTest Boolean

Whether the instance ignores test connectivity. Valid values: true, false.

state String

It has been deprecated from provider version 1.100.0 and 'status' instead.

Deprecated:

Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.

status String

The instance status.

tid Number

The tenant ID.

useDsql Number

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

vpcId String

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

Import

DMS Enterprise can be imported using host and port, e.g.

 $ pulumi import alicloud:dms/enterpriseInstance:EnterpriseInstance example rm-uf648hgs7874xxxx.mysql.rds.aliyuncs.com:3306

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.