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",
            InstanceAlias = "your_alias_name",
            InstanceSource = "RDS",
            InstanceType = "MySQL",
            NetworkType = "VPC",
            Port = 3306,
            QueryTimeout = 60,
            SafeRule = "自由操作",
            Tid = 12345,
        });
    }

}

Coming soon!

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")

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",
    instanceAlias: "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);

def 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);

func NewEnterpriseInstance(ctx *Context, name string, args EnterpriseInstanceArgs, opts ...ResourceOption) (*EnterpriseInstance, error)

public EnterpriseInstance(string name, EnterpriseInstanceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

EnterpriseInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
InstanceAlias string: Instance alias, 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.
DataLinkName string: Cross-database query datalink name.
DbaId string
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.
InstanceId string
SafeRuleId string
Sid string: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
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.
InstanceAlias string: Instance alias, 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.
DataLinkName string: Cross-database query datalink name.
DbaId string
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.
InstanceId string
SafeRuleId string
Sid string: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
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 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.
instanceAlias string: Instance alias, 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.
dataLinkName string: Cross-database query datalink name.
dbaId string
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.
instanceId string
safeRuleId string
sid string: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
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 float: 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 float: Export timeout, unit: s (seconds).
host str: Host address of the target database.
instance_alias str: Instance alias, 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 float: Access port of the target database.
query_timeout float: 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
ddl_online 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 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_id str
safe_rule_id str
sid str: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
tid float: The tenant ID.
use_dsql float: 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.

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: The instance status.

DbaNickName string: The instance dba nickname.
Id string: The provider-assigned unique ID for this managed resource.
State string: The instance status.

dbaNickName string: The instance dba nickname.
id string: The provider-assigned unique ID for this managed resource.
state 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: 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

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, __props__=None);

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)

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.

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
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: Instance alias, to help users quickly distinguish positioning.
InstanceId string
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
Sid string: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
State 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
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: Instance alias, to help users quickly distinguish positioning.
InstanceId string
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
Sid string: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
State 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
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: Instance alias, to help users quickly distinguish positioning.
instanceId string
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
sid string: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
state 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
dba_nick_name str: The instance dba nickname.
dba_uid float: The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
ddl_online 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 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 float: Export timeout, unit: s (seconds).
host str: Host address of the target database.
instance_alias str: Instance alias, to help users quickly distinguish positioning.
instance_id str
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 float: Access port of the target database.
query_timeout float: 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
sid str: The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
state str: The instance status.
tid float: The tenant ID.
use_dsql float: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud