Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

EnterpriseInstance

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.AliCloud.Dms

Assembly: Pulumi.AliCloud.dll

Syntax

public class EnterpriseInstance : CustomResource

Constructors

EnterpriseInstance(String, EnterpriseInstanceArgs, CustomResourceOptions)

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

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
EnterpriseInstanceArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

DatabasePassword

Database access password.

Declaration

public Output<string> DatabasePassword { get; }

Property Value

Type	Description
Output<System.String>

DatabaseUser

Database access account.

Declaration

public Output<string> DatabaseUser { get; }

Property Value

Type	Description
Output<System.String>

DataLinkName

Cross-database query datalink name.

Declaration

public Output<string> DataLinkName { get; }

Property Value

Type	Description
Output<System.String>

DbaId

Declaration

public Output<string> DbaId { get; }

Property Value

Type	Description
Output<System.String>

DbaNickName

The instance dba nickname.

Declaration

public Output<string> DbaNickName { get; }

Property Value

Type	Description
Output<System.String>

DbaUid

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

Declaration

public Output<int> DbaUid { get; }

Property Value

Type	Description
Output<System.Int32>

DdlOnline

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.

Declaration

public Output<int?> DdlOnline { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

EcsInstanceId

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

Declaration

public Output<string> EcsInstanceId { get; }

Property Value

Type	Description
Output<System.String>

EcsRegion

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.

Declaration

public Output<string> EcsRegion { get; }

Property Value

Type	Description
Output<System.String>

EnvType

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.

Declaration

public Output<string> EnvType { get; }

Property Value

Type	Description
Output<System.String>

ExportTimeout

Export timeout, unit: s (seconds).

Declaration

public Output<int> ExportTimeout { get; }

Property Value

Type	Description
Output<System.Int32>

Host

Host address of the target database.

Declaration

public Output<string> Host { get; }

Property Value

Type	Description
Output<System.String>

InstanceAlias

Instance alias, to help users quickly distinguish positioning.

Declaration

public Output<string> InstanceAlias { get; }

Property Value

Type	Description
Output<System.String>

InstanceId

Declaration

public Output<string> InstanceId { get; }

Property Value

Type	Description
Output<System.String>

InstanceSource

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

Declaration

public Output<string> InstanceSource { get; }

Property Value

Type	Description
Output<System.String>

InstanceType

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

Declaration

public Output<string> InstanceType { get; }

Property Value

Type	Description
Output<System.String>

NetworkType

Network type. Valid values: CLASSIC, VPC.

Declaration

public Output<string> NetworkType { get; }

Property Value

Type	Description
Output<System.String>

Port

Access port of the target database.

Declaration

public Output<int> Port { get; }

Property Value

Type	Description
Output<System.Int32>

QueryTimeout

Query timeout time, unit: s (seconds).

Declaration

public Output<int> QueryTimeout { get; }

Property Value

Type	Description
Output<System.Int32>

SafeRule

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

Declaration

public Output<string> SafeRule { get; }

Property Value

Type	Description
Output<System.String>

SafeRuleId

Declaration

public Output<string> SafeRuleId { get; }

Property Value

Type	Description
Output<System.String>

Sid

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

Declaration

public Output<string> Sid { get; }

Property Value

Type	Description
Output<System.String>

State

The instance status.

Declaration

public Output<string> State { get; }

Property Value

Type	Description
Output<System.String>

Tid

The tenant ID.

Declaration

public Output<int?> Tid { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

UseDsql

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

Declaration

public Output<int?> UseDsql { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

VpcId

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

Declaration

public Output<string> VpcId { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, EnterpriseInstanceState, CustomResourceOptions)

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

Declaration

public static EnterpriseInstance Get(string name, Input<string> id, EnterpriseInstanceState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
EnterpriseInstanceState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
EnterpriseInstance