pulumi-alicloud-kotlin/com.pulumi.alicloud.dms.kotlin/EnterpriseInstanceArgs

EnterpriseInstanceArgs

data class EnterpriseInstanceArgs(val dataLinkName: Output<String>? = null, val databasePassword: Output<String>? = null, val databaseUser: Output<String>? = null, val dbaId: Output<String>? = null, val dbaUid: Output<Int>? = null, val ddlOnline: Output<Int>? = null, val ecsInstanceId: Output<String>? = null, val ecsRegion: Output<String>? = null, val envType: Output<String>? = null, val exportTimeout: Output<Int>? = null, val host: Output<String>? = null, val instanceAlias: Output<String>? = null, val instanceId: Output<String>? = null, val instanceName: Output<String>? = null, val instanceSource: Output<String>? = null, val instanceType: Output<String>? = null, val networkType: Output<String>? = null, val port: Output<Int>? = null, val queryTimeout: Output<Int>? = null, val safeRule: Output<String>? = null, val safeRuleId: Output<String>? = null, val sid: Output<String>? = null, val skipTest: Output<Boolean>? = null, val tid: Output<Int>? = null, val useDsql: Output<Int>? = null, val vpcId: Output<String>? = null) : ConvertibleToJava<EnterpriseInstanceArgs>

Provides a DMS Enterprise Instance resource.

NOTE: API users must first register in DMS. NOTE: Available since v1.81.0.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetRegionsArgs;
import com.pulumi.alicloud.dms.DmsFunctions;
import com.pulumi.alicloud.dms.inputs.GetUserTenantsArgs;
import com.pulumi.alicloud.rds.RdsFunctions;
import com.pulumi.alicloud.rds.inputs.GetZonesArgs;
import com.pulumi.alicloud.rds.inputs.GetInstanceClassesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.rds.Instance;
import com.pulumi.alicloud.rds.InstanceArgs;
import com.pulumi.alicloud.rds.Account;
import com.pulumi.alicloud.rds.AccountArgs;
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) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("tf-example");
        final var current = AlicloudFunctions.getAccount();
        final var defaultRegions = AlicloudFunctions.getRegions(GetRegionsArgs.builder()
            .current(true)
            .build());
        final var defaultUserTenants = DmsFunctions.getUserTenants(GetUserTenantsArgs.builder()
            .status("ACTIVE")
            .build());
        final var defaultZones = RdsFunctions.getZones(GetZonesArgs.builder()
            .engine("MySQL")
            .engineVersion("8.0")
            .instanceChargeType("PostPaid")
            .category("HighAvailability")
            .dbInstanceStorageType("cloud_essd")
            .build());
        final var defaultInstanceClasses = RdsFunctions.getInstanceClasses(GetInstanceClassesArgs.builder()
            .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .engine("MySQL")
            .engineVersion("8.0")
            .category("HighAvailability")
            .dbInstanceStorageType("cloud_essd")
            .instanceChargeType("PostPaid")
            .build());
        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("10.4.0.0/16")
            .build());
        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vswitchName(name)
            .cidrBlock("10.4.0.0/24")
            .vpcId(defaultNetwork.id())
            .zoneId(defaultZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .build());
        var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
            .vpcId(defaultNetwork.id())
            .build());
        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .engine("MySQL")
            .engineVersion("8.0")
            .dbInstanceStorageType("cloud_essd")
            .instanceType(defaultInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].instanceClass()))
            .instanceStorage(defaultInstanceClasses.applyValue(getInstanceClassesResult -> getInstanceClassesResult.instanceClasses()[0].storageRange().min()))
            .vswitchId(defaultSwitch.id())
            .instanceName(name)
            .securityIps(
                "100.104.5.0/24",
                "192.168.0.6")
            .tags(Map.ofEntries(
                Map.entry("Created", "TF"),
                Map.entry("For", "example")
            ))
            .build());
        var defaultAccount = new Account("defaultAccount", AccountArgs.builder()
            .dbInstanceId(defaultInstance.id())
            .accountName("tfexamplename")
            .accountPassword("Example12345")
            .accountType("Normal")
            .build());
        var defaultEnterpriseInstance = new EnterpriseInstance("defaultEnterpriseInstance", EnterpriseInstanceArgs.builder()
            .tid(defaultUserTenants.applyValue(getUserTenantsResult -> getUserTenantsResult.ids()[0]))
            .instanceType("MySQL")
            .instanceSource("RDS")
            .networkType("VPC")
            .envType("dev")
            .host(defaultInstance.connectionString())
            .port(3306)
            .databaseUser(defaultAccount.accountName())
            .databasePassword(defaultAccount.accountPassword())
            .instanceName(name)
            .dbaUid(current.applyValue(getAccountResult -> getAccountResult.id()))
            .safeRule("自由操作")
            .queryTimeout(60)
            .exportTimeout(600)
            .ecsRegion(defaultRegions.applyValue(getRegionsResult -> getRegionsResult.regions()[0].id()))
            .build());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun EnterpriseInstanceArgs(dataLinkName: Output<String>? = null, databasePassword: Output<String>? = null, databaseUser: Output<String>? = null, dbaId: Output<String>? = null, dbaUid: Output<Int>? = null, ddlOnline: Output<Int>? = null, ecsInstanceId: Output<String>? = null, ecsRegion: Output<String>? = null, envType: Output<String>? = null, exportTimeout: Output<Int>? = null, host: Output<String>? = null, instanceAlias: Output<String>? = null, instanceId: Output<String>? = null, instanceName: Output<String>? = null, instanceSource: Output<String>? = null, instanceType: Output<String>? = null, networkType: Output<String>? = null, port: Output<Int>? = null, queryTimeout: Output<Int>? = null, safeRule: Output<String>? = null, safeRuleId: Output<String>? = null, sid: Output<String>? = null, skipTest: Output<Boolean>? = null, tid: Output<Int>? = null, useDsql: Output<Int>? = null, vpcId: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): EnterpriseInstanceArgs

Properties

Link copied to clipboard
val databasePassword: Output<String>? = null

Database access password.

Link copied to clipboard
val databaseUser: Output<String>? = null

Database access account.

Link copied to clipboard
val dataLinkName: Output<String>? = null

Cross-database query datalink name.

Link copied to clipboard
val dbaId: Output<String>? = null

The dba id of the database instance.

Link copied to clipboard
val dbaUid: Output<Int>? = null

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

Link copied to clipboard
val ddlOnline: Output<Int>? = null

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.

Link copied to clipboard
val ecsInstanceId: Output<String>? = null

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

Link copied to clipboard
val ecsRegion: Output<String>? = null

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.

Link copied to clipboard
val envType: Output<String>? = null

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.

Link copied to clipboard
val exportTimeout: Output<Int>? = null

Export timeout, unit: s (seconds).

Link copied to clipboard
val host: Output<String>? = null

Host address of the target database.

Link copied to clipboard
val instanceAlias: Output<String>? = null

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

Link copied to clipboard
val instanceId: Output<String>? = null

The instance id of the database instance.

Link copied to clipboard
val instanceName: Output<String>? = null

Instance name, to help users quickly distinguish positioning.

Link copied to clipboard
val instanceSource: Output<String>? = null

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

Link copied to clipboard
val instanceType: Output<String>? = null

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

Link copied to clipboard
val networkType: Output<String>? = null

Network type. Valid values: CLASSIC, VPC.

Link copied to clipboard
val port: Output<Int>? = null

Access port of the target database.

Link copied to clipboard
val queryTimeout: Output<Int>? = null

Query timeout time, unit: s (seconds).

Link copied to clipboard
val safeRule: Output<String>? = null

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

Link copied to clipboard
val safeRuleId: Output<String>? = null

The safe rule id of the database instance.

Link copied to clipboard
val sid: Output<String>? = null

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

Link copied to clipboard
val skipTest: Output<Boolean>? = null

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

Link copied to clipboard
val tid: Output<Int>? = null

The tenant ID.

Link copied to clipboard
val useDsql: Output<Int>? = null

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

Link copied to clipboard
val vpcId: Output<String>? = null

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