alicloud.dms.EnterpriseInstance
Provides a DMS Enterprise Instance resource.
NOTE: API users must first register in DMS. NOTE: Available in 1.81.0+.
Example Usage
using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var @default = new AliCloud.Dms.EnterpriseInstance("default", new()
{
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 _default = new alicloud.dms.EnterpriseInstance("default", {
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,
});
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 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:
- Database
Password string Database access password.
- Database
User string Database access account.
- Dba
Uid int The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- Env
Type 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.- Export
Timeout int Export timeout, unit: s (seconds).
- Host string
Host address of the target database.
- Instance
Source string The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- Instance
Type string Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- Network
Type string 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 string The security rule of the instance is passed into the name of the security rule in the enterprise.
- Data
Link stringName Cross-database query datalink name.
- Dba
Id string 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 stringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- Ecs
Region 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.
- Instance
Alias string Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- Instance
Id string The instance id of the database instance.
- Instance
Name string Instance name, to help users quickly distinguish positioning.
- Safe
Rule stringId The safe rule id of the database instance.
- Sid string
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 string VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- Database
Password string Database access password.
- Database
User string Database access account.
- Dba
Uid int The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- Env
Type 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.- Export
Timeout int Export timeout, unit: s (seconds).
- Host string
Host address of the target database.
- Instance
Source string The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- Instance
Type string Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- Network
Type string 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 string The security rule of the instance is passed into the name of the security rule in the enterprise.
- Data
Link stringName Cross-database query datalink name.
- Dba
Id string 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 stringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- Ecs
Region 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.
- Instance
Alias string Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- Instance
Id string The instance id of the database instance.
- Instance
Name string Instance name, to help users quickly distinguish positioning.
- Safe
Rule stringId The safe rule id of the database instance.
- Sid string
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 string VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- database
Password String Database access password.
- database
User String Database access account.
- dba
Uid Integer The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- env
Type 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.- export
Timeout Integer Export timeout, unit: s (seconds).
- host String
Host address of the target database.
- instance
Source String The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- instance
Type String Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- network
Type String Network type. Valid values:
CLASSIC
,VPC
.- port Integer
Access port of the target database.
- query
Timeout Integer Query timeout time, unit: s (seconds).
- safe
Rule String The security rule of the instance is passed into the name of the security rule in the enterprise.
- data
Link StringName Cross-database query datalink name.
- dba
Id String The dba id of the database instance.
- ddl
Online 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.- ecs
Instance StringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- ecs
Region 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.
- instance
Alias String Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- instance
Id String The instance id of the database instance.
- instance
Name String Instance name, to help users quickly distinguish positioning.
- safe
Rule StringId The safe rule id of the database instance.
- sid String
The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
- skip
Test Boolean Whether the instance ignores test connectivity. Valid values:
true
,false
.- tid Integer
The tenant ID.
- use
Dsql Integer Whether to enable cross-instance query. Valid values:
0
not open,1
open.- vpc
Id String VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- database
Password string Database access password.
- database
User string Database access account.
- dba
Uid number The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- env
Type 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.- export
Timeout number Export timeout, unit: s (seconds).
- host string
Host address of the target database.
- instance
Source string The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- instance
Type string Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- network
Type string Network type. Valid values:
CLASSIC
,VPC
.- port number
Access port of the target database.
- query
Timeout number Query timeout time, unit: s (seconds).
- safe
Rule string The security rule of the instance is passed into the name of the security rule in the enterprise.
- data
Link stringName Cross-database query datalink name.
- dba
Id string The dba id of the database instance.
- ddl
Online 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.- ecs
Instance stringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- ecs
Region 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.
- instance
Alias string Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- instance
Id string The instance id of the database instance.
- instance
Name string Instance name, to help users quickly distinguish positioning.
- safe
Rule stringId The safe rule id of the database instance.
- sid string
The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
- skip
Test boolean Whether the instance ignores test connectivity. Valid values:
true
,false
.- tid number
The tenant ID.
- use
Dsql number Whether to enable cross-instance query. Valid values:
0
not open,1
open.- vpc
Id 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_ strname 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_ strid 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. Useinstance_name
instead.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_ strid 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.
- database
Password String Database access password.
- database
User String Database access account.
- dba
Uid Number The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- env
Type 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.- export
Timeout Number Export timeout, unit: s (seconds).
- host String
Host address of the target database.
- instance
Source String The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- instance
Type String Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- network
Type String Network type. Valid values:
CLASSIC
,VPC
.- port Number
Access port of the target database.
- query
Timeout Number Query timeout time, unit: s (seconds).
- safe
Rule String The security rule of the instance is passed into the name of the security rule in the enterprise.
- data
Link StringName Cross-database query datalink name.
- dba
Id String The dba id of the database instance.
- ddl
Online 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.- ecs
Instance StringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- ecs
Region 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.
- instance
Alias String Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- instance
Id String The instance id of the database instance.
- instance
Name String Instance name, to help users quickly distinguish positioning.
- safe
Rule StringId The safe rule id of the database instance.
- sid String
The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
- skip
Test Boolean Whether the instance ignores test connectivity. Valid values:
true
,false
.- tid Number
The tenant ID.
- use
Dsql Number Whether to enable cross-instance query. Valid values:
0
not open,1
open.- vpc
Id 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:
- Dba
Nick stringName 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- Status string
The instance status.
- Dba
Nick stringName 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- Status string
The instance status.
- dba
Nick StringName 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status String
The instance status.
- dba
Nick stringName 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status string
The instance status.
- dba_
nick_ strname 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status str
The instance status.
- dba
Nick StringName 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status String
The instance status.
Look up 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.
- Data
Link stringName Cross-database query datalink name.
- Database
Password string Database access password.
- Database
User string Database access account.
- Dba
Id string The dba id of the database instance.
- Dba
Nick stringName 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 stringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- Ecs
Region 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.
- Env
Type 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.- Export
Timeout int Export timeout, unit: s (seconds).
- Host string
Host address of the target database.
- Instance
Alias string Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- Instance
Id string The instance id of the database instance.
- Instance
Name string Instance name, to help users quickly distinguish positioning.
- Instance
Source string The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- Instance
Type string Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- Network
Type string 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 string The security rule of the instance is passed into the name of the security rule in the enterprise.
- Safe
Rule stringId The safe rule id of the database instance.
- Sid string
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 string
It has been deprecated from provider version 1.100.0 and 'status' instead.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- Status string
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 string VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- Data
Link stringName Cross-database query datalink name.
- Database
Password string Database access password.
- Database
User string Database access account.
- Dba
Id string The dba id of the database instance.
- Dba
Nick stringName 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 stringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- Ecs
Region 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.
- Env
Type 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.- Export
Timeout int Export timeout, unit: s (seconds).
- Host string
Host address of the target database.
- Instance
Alias string Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- Instance
Id string The instance id of the database instance.
- Instance
Name string Instance name, to help users quickly distinguish positioning.
- Instance
Source string The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- Instance
Type string Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- Network
Type string 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 string The security rule of the instance is passed into the name of the security rule in the enterprise.
- Safe
Rule stringId The safe rule id of the database instance.
- Sid string
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 string
It has been deprecated from provider version 1.100.0 and 'status' instead.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- Status string
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 string VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- data
Link StringName Cross-database query datalink name.
- database
Password String Database access password.
- database
User String Database access account.
- dba
Id String The dba id of the database instance.
- dba
Nick StringName The instance dba nickname.
- dba
Uid Integer The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- ddl
Online 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.- ecs
Instance StringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- ecs
Region 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.
- env
Type 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.- export
Timeout Integer Export timeout, unit: s (seconds).
- host String
Host address of the target database.
- instance
Alias String Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- instance
Id String The instance id of the database instance.
- instance
Name String Instance name, to help users quickly distinguish positioning.
- instance
Source String The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- instance
Type String Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- network
Type String Network type. Valid values:
CLASSIC
,VPC
.- port Integer
Access port of the target database.
- query
Timeout Integer Query timeout time, unit: s (seconds).
- safe
Rule String The security rule of the instance is passed into the name of the security rule in the enterprise.
- safe
Rule StringId The safe rule id of the database instance.
- sid String
The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
- skip
Test 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status String
The instance status.
- tid Integer
The tenant ID.
- use
Dsql Integer Whether to enable cross-instance query. Valid values:
0
not open,1
open.- vpc
Id String VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- data
Link stringName Cross-database query datalink name.
- database
Password string Database access password.
- database
User string Database access account.
- dba
Id string The dba id of the database instance.
- dba
Nick stringName The instance dba nickname.
- dba
Uid number The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- ddl
Online 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.- ecs
Instance stringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- ecs
Region 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.
- env
Type 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.- export
Timeout number Export timeout, unit: s (seconds).
- host string
Host address of the target database.
- instance
Alias string Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- instance
Id string The instance id of the database instance.
- instance
Name string Instance name, to help users quickly distinguish positioning.
- instance
Source string The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- instance
Type string Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- network
Type string Network type. Valid values:
CLASSIC
,VPC
.- port number
Access port of the target database.
- query
Timeout number Query timeout time, unit: s (seconds).
- safe
Rule string The security rule of the instance is passed into the name of the security rule in the enterprise.
- safe
Rule stringId The safe rule id of the database instance.
- sid string
The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
- skip
Test 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status string
The instance status.
- tid number
The tenant ID.
- use
Dsql number Whether to enable cross-instance query. Valid values:
0
not open,1
open.- vpc
Id string VPC ID. This value must be passed when the value of InstanceSource is VPC dedicated line IDC.
- data_
link_ strname 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_ strname 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_ strid 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. Useinstance_name
instead.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_ strid 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.
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.
- data
Link StringName Cross-database query datalink name.
- database
Password String Database access password.
- database
User String Database access account.
- dba
Id String The dba id of the database instance.
- dba
Nick StringName The instance dba nickname.
- dba
Uid Number The DBA of the instance is passed into the Alibaba Cloud uid of the DBA.
- ddl
Online 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.- ecs
Instance StringId ECS instance ID. The value of InstanceSource is the ECS self-built library. This value must be passed.
- ecs
Region 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.
- env
Type 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.- export
Timeout Number Export timeout, unit: s (seconds).
- host String
Host address of the target database.
- instance
Alias String Field
instance_alias
has been deprecated from version 1.100.0. Useinstance_name
instead.Field 'instance_alias' has been deprecated from version 1.100.0. Use 'instance_name' instead.
- instance
Id String The instance id of the database instance.
- instance
Name String Instance name, to help users quickly distinguish positioning.
- instance
Source String The source of the database instance. Valid values:
PUBLIC_OWN
,RDS
,ECS_OWN
,VPC_IDC
.- instance
Type String Database type. Valid values:
MySQL
,SQLServer
,PostgreSQL
,Oracle,
DRDS
,OceanBase
,Mongo
,Redis
.- network
Type String Network type. Valid values:
CLASSIC
,VPC
.- port Number
Access port of the target database.
- query
Timeout Number Query timeout time, unit: s (seconds).
- safe
Rule String The security rule of the instance is passed into the name of the security rule in the enterprise.
- safe
Rule StringId The safe rule id of the database instance.
- sid String
The SID. This value must be passed when InstanceType is PostgreSQL or Oracle.
- skip
Test 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.
Field 'state' has been deprecated from version 1.100.0. Use 'status' instead.
- status String
The instance status.
- tid Number
The tenant ID.
- use
Dsql Number Whether to enable cross-instance query. Valid values:
0
not open,1
open.- vpc
Id 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
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.