1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. mongodb
  5. Instance
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi

alicloud.mongodb.Instance

Explore with Pulumi AI

Provides a MongoDB instance resource supports replica set instances only. the MongoDB provides stable, reliable, and automatic scalable database services. It offers a full range of database solutions, such as disaster recovery, backup, recovery, monitoring, and alarms. You can see detail product introduction here

NOTE: Available since v1.37.0.

NOTE: The following regions don’t support create Classic network MongoDB instance. [cn-zhangjiakou,cn-huhehaote,ap-southeast-3,ap-southeast-5,me-east-1,ap-northeast-1,eu-west-1]

NOTE: Create MongoDB instance or change instance type and storage would cost 5~10 minutes. Please make full preparation

Example Usage

Create a Mongodb instance

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = alicloud.mongodb.getZones({});
const index = _default.then(_default => _default.zones).length.then(length => length - 1);
const zoneId = _default.then(_default => _default.zones[index].id);
const defaultNetwork = new alicloud.vpc.Network("default", {
    vpcName: name,
    cidrBlock: "172.17.3.0/24",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    vswitchName: name,
    cidrBlock: "172.17.3.0/24",
    vpcId: defaultNetwork.id,
    zoneId: zoneId,
});
const defaultInstance = new alicloud.mongodb.Instance("default", {
    engineVersion: "4.2",
    dbInstanceClass: "dds.mongo.mid",
    dbInstanceStorage: 10,
    vswitchId: defaultSwitch.id,
    securityIpLists: [
        "10.168.1.12",
        "100.69.7.112",
    ],
    name: name,
    tags: {
        Created: "TF",
        For: "example",
    },
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.mongodb.get_zones()
index = len(default.zones) - 1
zone_id = default.zones[index].id
default_network = alicloud.vpc.Network("default",
    vpc_name=name,
    cidr_block="172.17.3.0/24")
default_switch = alicloud.vpc.Switch("default",
    vswitch_name=name,
    cidr_block="172.17.3.0/24",
    vpc_id=default_network.id,
    zone_id=zone_id)
default_instance = alicloud.mongodb.Instance("default",
    engine_version="4.2",
    db_instance_class="dds.mongo.mid",
    db_instance_storage=10,
    vswitch_id=default_switch.id,
    security_ip_lists=[
        "10.168.1.12",
        "100.69.7.112",
    ],
    name=name,
    tags={
        "Created": "TF",
        "For": "example",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/mongodb"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := mongodb.GetZones(ctx, &mongodb.GetZonesArgs{}, nil)
		if err != nil {
			return err
		}
		index := pulumi.Float64(len(_default.Zones)) - 1
		zoneId := _default.Zones[index].Id
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.17.3.0/24"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String(name),
			CidrBlock:   pulumi.String("172.17.3.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(zoneId),
		})
		if err != nil {
			return err
		}
		_, err = mongodb.NewInstance(ctx, "default", &mongodb.InstanceArgs{
			EngineVersion:     pulumi.String("4.2"),
			DbInstanceClass:   pulumi.String("dds.mongo.mid"),
			DbInstanceStorage: pulumi.Int(10),
			VswitchId:         defaultSwitch.ID(),
			SecurityIpLists: pulumi.StringArray{
				pulumi.String("10.168.1.12"),
				pulumi.String("100.69.7.112"),
			},
			Name: pulumi.String(name),
			Tags: pulumi.StringMap{
				"Created": pulumi.String("TF"),
				"For":     pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = AliCloud.MongoDB.GetZones.Invoke();

    var index = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones)).Length.Apply(length => length - 1);

    var zoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones)[index].Id);

    var defaultNetwork = new AliCloud.Vpc.Network("default", new()
    {
        VpcName = name,
        CidrBlock = "172.17.3.0/24",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
    {
        VswitchName = name,
        CidrBlock = "172.17.3.0/24",
        VpcId = defaultNetwork.Id,
        ZoneId = zoneId,
    });

    var defaultInstance = new AliCloud.MongoDB.Instance("default", new()
    {
        EngineVersion = "4.2",
        DbInstanceClass = "dds.mongo.mid",
        DbInstanceStorage = 10,
        VswitchId = defaultSwitch.Id,
        SecurityIpLists = new[]
        {
            "10.168.1.12",
            "100.69.7.112",
        },
        Name = name,
        Tags = 
        {
            { "Created", "TF" },
            { "For", "example" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.mongodb.MongodbFunctions;
import com.pulumi.alicloud.mongodb.inputs.GetZonesArgs;
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.mongodb.Instance;
import com.pulumi.alicloud.mongodb.InstanceArgs;
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("terraform-example");
        final var default = MongodbFunctions.getZones();

        final var index = default_.zones().length() - 1;

        final var zoneId = default_.zones()[index].id();

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("172.17.3.0/24")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vswitchName(name)
            .cidrBlock("172.17.3.0/24")
            .vpcId(defaultNetwork.id())
            .zoneId(zoneId)
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .engineVersion("4.2")
            .dbInstanceClass("dds.mongo.mid")
            .dbInstanceStorage(10)
            .vswitchId(defaultSwitch.id())
            .securityIpLists(            
                "10.168.1.12",
                "100.69.7.112")
            .name(name)
            .tags(Map.ofEntries(
                Map.entry("Created", "TF"),
                Map.entry("For", "example")
            ))
            .build());

    }
}
Copy
Coming soon!

Module Support

You can use to the existing mongodb module to create a MongoDB instance resource one-click.

Create Instance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             db_instance_class: Optional[str] = None,
             engine_version: Optional[str] = None,
             db_instance_storage: Optional[int] = None,
             maintain_start_time: Optional[str] = None,
             effective_time: Optional[str] = None,
             order_type: Optional[str] = None,
             backup_time: Optional[str] = None,
             cloud_disk_encryption_key: Optional[str] = None,
             backup_periods: Optional[Sequence[str]] = None,
             backup_interval: Optional[str] = None,
             network_type: Optional[str] = None,
             enable_backup_log: Optional[int] = None,
             encrypted: Optional[bool] = None,
             encryption_key: Optional[str] = None,
             encryptor_name: Optional[str] = None,
             name: Optional[str] = None,
             hidden_zone_id: Optional[str] = None,
             instance_charge_type: Optional[str] = None,
             kms_encrypted_password: Optional[str] = None,
             kms_encryption_context: Optional[Mapping[str, str]] = None,
             log_backup_retention_period: Optional[int] = None,
             maintain_end_time: Optional[str] = None,
             account_password: Optional[str] = None,
             auto_renew: Optional[bool] = None,
             backup_retention_period: Optional[int] = None,
             backup_retention_policy_on_cluster_deletion: Optional[int] = None,
             parameters: Optional[Sequence[InstanceParameterArgs]] = None,
             period: Optional[int] = None,
             provisioned_iops: Optional[int] = None,
             readonly_replicas: Optional[int] = None,
             replication_factor: Optional[int] = None,
             resource_group_id: Optional[str] = None,
             role_arn: Optional[str] = None,
             secondary_zone_id: Optional[str] = None,
             security_group_id: Optional[str] = None,
             security_ip_lists: Optional[Sequence[str]] = None,
             snapshot_backup_type: Optional[str] = None,
             ssl_action: Optional[str] = None,
             storage_engine: Optional[str] = None,
             storage_type: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             tde_status: Optional[str] = None,
             vpc_id: Optional[str] = None,
             vswitch_id: Optional[str] = None,
             zone_id: Optional[str] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: alicloud:mongodb:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleinstanceResourceResourceFromMongodbinstance = new AliCloud.MongoDB.Instance("exampleinstanceResourceResourceFromMongodbinstance", new()
{
    DbInstanceClass = "string",
    EngineVersion = "string",
    DbInstanceStorage = 0,
    MaintainStartTime = "string",
    EffectiveTime = "string",
    OrderType = "string",
    BackupTime = "string",
    CloudDiskEncryptionKey = "string",
    BackupPeriods = new[]
    {
        "string",
    },
    BackupInterval = "string",
    NetworkType = "string",
    EnableBackupLog = 0,
    Encrypted = false,
    EncryptionKey = "string",
    EncryptorName = "string",
    Name = "string",
    HiddenZoneId = "string",
    InstanceChargeType = "string",
    KmsEncryptedPassword = "string",
    KmsEncryptionContext = 
    {
        { "string", "string" },
    },
    LogBackupRetentionPeriod = 0,
    MaintainEndTime = "string",
    AccountPassword = "string",
    AutoRenew = false,
    BackupRetentionPeriod = 0,
    BackupRetentionPolicyOnClusterDeletion = 0,
    Parameters = new[]
    {
        new AliCloud.MongoDB.Inputs.InstanceParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Period = 0,
    ProvisionedIops = 0,
    ReadonlyReplicas = 0,
    ReplicationFactor = 0,
    ResourceGroupId = "string",
    RoleArn = "string",
    SecondaryZoneId = "string",
    SecurityGroupId = "string",
    SecurityIpLists = new[]
    {
        "string",
    },
    SnapshotBackupType = "string",
    SslAction = "string",
    StorageEngine = "string",
    StorageType = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TdeStatus = "string",
    VpcId = "string",
    VswitchId = "string",
    ZoneId = "string",
});
Copy
example, err := mongodb.NewInstance(ctx, "exampleinstanceResourceResourceFromMongodbinstance", &mongodb.InstanceArgs{
	DbInstanceClass:        pulumi.String("string"),
	EngineVersion:          pulumi.String("string"),
	DbInstanceStorage:      pulumi.Int(0),
	MaintainStartTime:      pulumi.String("string"),
	EffectiveTime:          pulumi.String("string"),
	OrderType:              pulumi.String("string"),
	BackupTime:             pulumi.String("string"),
	CloudDiskEncryptionKey: pulumi.String("string"),
	BackupPeriods: pulumi.StringArray{
		pulumi.String("string"),
	},
	BackupInterval:       pulumi.String("string"),
	NetworkType:          pulumi.String("string"),
	EnableBackupLog:      pulumi.Int(0),
	Encrypted:            pulumi.Bool(false),
	EncryptionKey:        pulumi.String("string"),
	EncryptorName:        pulumi.String("string"),
	Name:                 pulumi.String("string"),
	HiddenZoneId:         pulumi.String("string"),
	InstanceChargeType:   pulumi.String("string"),
	KmsEncryptedPassword: pulumi.String("string"),
	KmsEncryptionContext: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	LogBackupRetentionPeriod:               pulumi.Int(0),
	MaintainEndTime:                        pulumi.String("string"),
	AccountPassword:                        pulumi.String("string"),
	AutoRenew:                              pulumi.Bool(false),
	BackupRetentionPeriod:                  pulumi.Int(0),
	BackupRetentionPolicyOnClusterDeletion: pulumi.Int(0),
	Parameters: mongodb.InstanceParameterArray{
		&mongodb.InstanceParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Period:            pulumi.Int(0),
	ProvisionedIops:   pulumi.Int(0),
	ReadonlyReplicas:  pulumi.Int(0),
	ReplicationFactor: pulumi.Int(0),
	ResourceGroupId:   pulumi.String("string"),
	RoleArn:           pulumi.String("string"),
	SecondaryZoneId:   pulumi.String("string"),
	SecurityGroupId:   pulumi.String("string"),
	SecurityIpLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	SnapshotBackupType: pulumi.String("string"),
	SslAction:          pulumi.String("string"),
	StorageEngine:      pulumi.String("string"),
	StorageType:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TdeStatus: pulumi.String("string"),
	VpcId:     pulumi.String("string"),
	VswitchId: pulumi.String("string"),
	ZoneId:    pulumi.String("string"),
})
Copy
var exampleinstanceResourceResourceFromMongodbinstance = new Instance("exampleinstanceResourceResourceFromMongodbinstance", InstanceArgs.builder()
    .dbInstanceClass("string")
    .engineVersion("string")
    .dbInstanceStorage(0)
    .maintainStartTime("string")
    .effectiveTime("string")
    .orderType("string")
    .backupTime("string")
    .cloudDiskEncryptionKey("string")
    .backupPeriods("string")
    .backupInterval("string")
    .networkType("string")
    .enableBackupLog(0)
    .encrypted(false)
    .encryptionKey("string")
    .encryptorName("string")
    .name("string")
    .hiddenZoneId("string")
    .instanceChargeType("string")
    .kmsEncryptedPassword("string")
    .kmsEncryptionContext(Map.of("string", "string"))
    .logBackupRetentionPeriod(0)
    .maintainEndTime("string")
    .accountPassword("string")
    .autoRenew(false)
    .backupRetentionPeriod(0)
    .backupRetentionPolicyOnClusterDeletion(0)
    .parameters(InstanceParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .period(0)
    .provisionedIops(0)
    .readonlyReplicas(0)
    .replicationFactor(0)
    .resourceGroupId("string")
    .roleArn("string")
    .secondaryZoneId("string")
    .securityGroupId("string")
    .securityIpLists("string")
    .snapshotBackupType("string")
    .sslAction("string")
    .storageEngine("string")
    .storageType("string")
    .tags(Map.of("string", "string"))
    .tdeStatus("string")
    .vpcId("string")
    .vswitchId("string")
    .zoneId("string")
    .build());
Copy
exampleinstance_resource_resource_from_mongodbinstance = alicloud.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance",
    db_instance_class="string",
    engine_version="string",
    db_instance_storage=0,
    maintain_start_time="string",
    effective_time="string",
    order_type="string",
    backup_time="string",
    cloud_disk_encryption_key="string",
    backup_periods=["string"],
    backup_interval="string",
    network_type="string",
    enable_backup_log=0,
    encrypted=False,
    encryption_key="string",
    encryptor_name="string",
    name="string",
    hidden_zone_id="string",
    instance_charge_type="string",
    kms_encrypted_password="string",
    kms_encryption_context={
        "string": "string",
    },
    log_backup_retention_period=0,
    maintain_end_time="string",
    account_password="string",
    auto_renew=False,
    backup_retention_period=0,
    backup_retention_policy_on_cluster_deletion=0,
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    period=0,
    provisioned_iops=0,
    readonly_replicas=0,
    replication_factor=0,
    resource_group_id="string",
    role_arn="string",
    secondary_zone_id="string",
    security_group_id="string",
    security_ip_lists=["string"],
    snapshot_backup_type="string",
    ssl_action="string",
    storage_engine="string",
    storage_type="string",
    tags={
        "string": "string",
    },
    tde_status="string",
    vpc_id="string",
    vswitch_id="string",
    zone_id="string")
Copy
const exampleinstanceResourceResourceFromMongodbinstance = new alicloud.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", {
    dbInstanceClass: "string",
    engineVersion: "string",
    dbInstanceStorage: 0,
    maintainStartTime: "string",
    effectiveTime: "string",
    orderType: "string",
    backupTime: "string",
    cloudDiskEncryptionKey: "string",
    backupPeriods: ["string"],
    backupInterval: "string",
    networkType: "string",
    enableBackupLog: 0,
    encrypted: false,
    encryptionKey: "string",
    encryptorName: "string",
    name: "string",
    hiddenZoneId: "string",
    instanceChargeType: "string",
    kmsEncryptedPassword: "string",
    kmsEncryptionContext: {
        string: "string",
    },
    logBackupRetentionPeriod: 0,
    maintainEndTime: "string",
    accountPassword: "string",
    autoRenew: false,
    backupRetentionPeriod: 0,
    backupRetentionPolicyOnClusterDeletion: 0,
    parameters: [{
        name: "string",
        value: "string",
    }],
    period: 0,
    provisionedIops: 0,
    readonlyReplicas: 0,
    replicationFactor: 0,
    resourceGroupId: "string",
    roleArn: "string",
    secondaryZoneId: "string",
    securityGroupId: "string",
    securityIpLists: ["string"],
    snapshotBackupType: "string",
    sslAction: "string",
    storageEngine: "string",
    storageType: "string",
    tags: {
        string: "string",
    },
    tdeStatus: "string",
    vpcId: "string",
    vswitchId: "string",
    zoneId: "string",
});
Copy
type: alicloud:mongodb:Instance
properties:
    accountPassword: string
    autoRenew: false
    backupInterval: string
    backupPeriods:
        - string
    backupRetentionPeriod: 0
    backupRetentionPolicyOnClusterDeletion: 0
    backupTime: string
    cloudDiskEncryptionKey: string
    dbInstanceClass: string
    dbInstanceStorage: 0
    effectiveTime: string
    enableBackupLog: 0
    encrypted: false
    encryptionKey: string
    encryptorName: string
    engineVersion: string
    hiddenZoneId: string
    instanceChargeType: string
    kmsEncryptedPassword: string
    kmsEncryptionContext:
        string: string
    logBackupRetentionPeriod: 0
    maintainEndTime: string
    maintainStartTime: string
    name: string
    networkType: string
    orderType: string
    parameters:
        - name: string
          value: string
    period: 0
    provisionedIops: 0
    readonlyReplicas: 0
    replicationFactor: 0
    resourceGroupId: string
    roleArn: string
    secondaryZoneId: string
    securityGroupId: string
    securityIpLists:
        - string
    snapshotBackupType: string
    sslAction: string
    storageEngine: string
    storageType: string
    tags:
        string: string
    tdeStatus: string
    vpcId: string
    vswitchId: string
    zoneId: string
Copy

Instance Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Instance resource accepts the following input properties:

DbInstanceClass This property is required. string
Instance specification. see Instance specifications.
DbInstanceStorage This property is required. int
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
EngineVersion This property is required. string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

BackupInterval string
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
BackupPeriods List<string>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
BackupRetentionPeriod int
The retention period of full backups.
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
CloudDiskEncryptionKey Changes to this property will trigger replacement. string
The ID of the encryption key.
EffectiveTime string
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
EnableBackupLog int
Specifies whether to enable the log backup feature. Valid values:
Encrypted Changes to this property will trigger replacement. bool
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
EncryptionKey string
The ID of the custom key.
EncryptorName string
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
HiddenZoneId Changes to this property will trigger replacement. string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, string>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
LogBackupRetentionPeriod int
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
MaintainEndTime string
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic, VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Parameters List<Pulumi.AliCloud.MongoDB.Inputs.InstanceParameter>
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ReadonlyReplicas int
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
ReplicationFactor int
Number of replica set nodes. Valid values: 1, 3, 5, 7.
ResourceGroupId string
The ID of the Resource Group.
RoleArn string
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
SecondaryZoneId Changes to this property will trigger replacement. string
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists List<string>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
SnapshotBackupType string
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
SslAction string
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. Valid values: enabled.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
DbInstanceClass This property is required. string
Instance specification. see Instance specifications.
DbInstanceStorage This property is required. int
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
EngineVersion This property is required. string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

BackupInterval string
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
BackupPeriods []string
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
BackupRetentionPeriod int
The retention period of full backups.
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
CloudDiskEncryptionKey Changes to this property will trigger replacement. string
The ID of the encryption key.
EffectiveTime string
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
EnableBackupLog int
Specifies whether to enable the log backup feature. Valid values:
Encrypted Changes to this property will trigger replacement. bool
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
EncryptionKey string
The ID of the custom key.
EncryptorName string
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
HiddenZoneId Changes to this property will trigger replacement. string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]string
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
LogBackupRetentionPeriod int
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
MaintainEndTime string
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic, VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Parameters []InstanceParameterArgs
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ReadonlyReplicas int
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
ReplicationFactor int
Number of replica set nodes. Valid values: 1, 3, 5, 7.
ResourceGroupId string
The ID of the Resource Group.
RoleArn string
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
SecondaryZoneId Changes to this property will trigger replacement. string
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists []string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
SnapshotBackupType string
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
SslAction string
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags map[string]string
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. Valid values: enabled.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
dbInstanceClass This property is required. String
Instance specification. see Instance specifications.
dbInstanceStorage This property is required. Integer
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
engineVersion This property is required. String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backupInterval String
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backupRetentionPeriod Integer
The retention period of full backups.
backupRetentionPolicyOnClusterDeletion Integer
The backup retention policy configured for the instance. Valid values:
backupTime String
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloudDiskEncryptionKey Changes to this property will trigger replacement. String
The ID of the encryption key.
effectiveTime String
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enableBackupLog Integer
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. Boolean
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryptionKey String
The ID of the custom key.
encryptorName String
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
hiddenZoneId Changes to this property will trigger replacement. String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String,String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
logBackupRetentionPeriod Integer
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintainEndTime String
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime String
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic, VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters List<InstanceParameter>
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period Integer
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisionedIops Integer
The provisioned IOPS. Valid values: 0 to 50000.
readonlyReplicas Integer
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replicationFactor Integer
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resourceGroupId String
The ID of the Resource Group.
roleArn String
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondaryZoneId Changes to this property will trigger replacement. String
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshotBackupType String
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
sslAction String
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String,String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
dbInstanceClass This property is required. string
Instance specification. see Instance specifications.
dbInstanceStorage This property is required. number
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
engineVersion This property is required. string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
accountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backupInterval string
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backupPeriods string[]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backupRetentionPeriod number
The retention period of full backups.
backupRetentionPolicyOnClusterDeletion number
The backup retention policy configured for the instance. Valid values:
backupTime string
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloudDiskEncryptionKey Changes to this property will trigger replacement. string
The ID of the encryption key.
effectiveTime string
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enableBackupLog number
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. boolean
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryptionKey string
The ID of the custom key.
encryptorName string
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
hiddenZoneId Changes to this property will trigger replacement. string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: string}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
logBackupRetentionPeriod number
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintainEndTime string
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime string
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name string
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic, VPC.
orderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters InstanceParameter[]
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisionedIops number
The provisioned IOPS. Valid values: 0 to 50000.
readonlyReplicas number
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replicationFactor number
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resourceGroupId string
The ID of the Resource Group.
roleArn string
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondaryZoneId Changes to this property will trigger replacement. string
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
securityGroupId string
The Security Group ID of ECS.
securityIpLists string[]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshotBackupType string
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
sslAction string
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
storageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
tdeStatus string
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
db_instance_class This property is required. str
Instance specification. see Instance specifications.
db_instance_storage This property is required. int
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
engine_version This property is required. str
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
account_password str
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
auto_renew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backup_interval str
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backup_periods Sequence[str]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backup_retention_period int
The retention period of full backups.
backup_retention_policy_on_cluster_deletion int
The backup retention policy configured for the instance. Valid values:
backup_time str
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloud_disk_encryption_key Changes to this property will trigger replacement. str
The ID of the encryption key.
effective_time str
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enable_backup_log int
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. bool
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryption_key str
The ID of the custom key.
encryptor_name str
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
hidden_zone_id Changes to this property will trigger replacement. str
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instance_charge_type str
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kms_encrypted_password str
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Mapping[str, str]
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
log_backup_retention_period int
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintain_end_time str
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start_time str
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name str
The name of DB instance. It must be 2 to 256 characters in length.
network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values:Classic, VPC.
order_type str
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters Sequence[InstanceParameterArgs]
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisioned_iops int
The provisioned IOPS. Valid values: 0 to 50000.
readonly_replicas int
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replication_factor int
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resource_group_id str
The ID of the Resource Group.
role_arn str
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondary_zone_id Changes to this property will trigger replacement. str
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
security_group_id str
The Security Group ID of ECS.
security_ip_lists Sequence[str]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshot_backup_type str
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
ssl_action str
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
storage_engine Changes to this property will trigger replacement. str
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storage_type str
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
tde_status str
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpc_id Changes to this property will trigger replacement. str
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitch_id Changes to this property will trigger replacement. str
The virtual switch ID to launch DB instances in one VPC.
zone_id Changes to this property will trigger replacement. str
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
dbInstanceClass This property is required. String
Instance specification. see Instance specifications.
dbInstanceStorage This property is required. Number
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
engineVersion This property is required. String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backupInterval String
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backupRetentionPeriod Number
The retention period of full backups.
backupRetentionPolicyOnClusterDeletion Number
The backup retention policy configured for the instance. Valid values:
backupTime String
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloudDiskEncryptionKey Changes to this property will trigger replacement. String
The ID of the encryption key.
effectiveTime String
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enableBackupLog Number
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. Boolean
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryptionKey String
The ID of the custom key.
encryptorName String
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
hiddenZoneId Changes to this property will trigger replacement. String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
logBackupRetentionPeriod Number
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintainEndTime String
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime String
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic, VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters List<Property Map>
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period Number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisionedIops Number
The provisioned IOPS. Valid values: 0 to 50000.
readonlyReplicas Number
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replicationFactor Number
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resourceGroupId String
The ID of the Resource Group.
roleArn String
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondaryZoneId Changes to this property will trigger replacement. String
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshotBackupType String
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
sslAction String
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ReplicaSetName string
The name of the mongo replica set.
ReplicaSets List<Pulumi.AliCloud.MongoDB.Outputs.InstanceReplicaSet>
Replica set instance information.
RetentionPeriod int
Instance data backup retention days. Available since v1.42.0.
SslStatus string
Status of the SSL feature.
Id string
The provider-assigned unique ID for this managed resource.
ReplicaSetName string
The name of the mongo replica set.
ReplicaSets []InstanceReplicaSet
Replica set instance information.
RetentionPeriod int
Instance data backup retention days. Available since v1.42.0.
SslStatus string
Status of the SSL feature.
id String
The provider-assigned unique ID for this managed resource.
replicaSetName String
The name of the mongo replica set.
replicaSets List<InstanceReplicaSet>
Replica set instance information.
retentionPeriod Integer
Instance data backup retention days. Available since v1.42.0.
sslStatus String
Status of the SSL feature.
id string
The provider-assigned unique ID for this managed resource.
replicaSetName string
The name of the mongo replica set.
replicaSets InstanceReplicaSet[]
Replica set instance information.
retentionPeriod number
Instance data backup retention days. Available since v1.42.0.
sslStatus string
Status of the SSL feature.
id str
The provider-assigned unique ID for this managed resource.
replica_set_name str
The name of the mongo replica set.
replica_sets Sequence[InstanceReplicaSet]
Replica set instance information.
retention_period int
Instance data backup retention days. Available since v1.42.0.
ssl_status str
Status of the SSL feature.
id String
The provider-assigned unique ID for this managed resource.
replicaSetName String
The name of the mongo replica set.
replicaSets List<Property Map>
Replica set instance information.
retentionPeriod Number
Instance data backup retention days. Available since v1.42.0.
sslStatus String
Status of the SSL feature.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_password: Optional[str] = None,
        auto_renew: Optional[bool] = None,
        backup_interval: Optional[str] = None,
        backup_periods: Optional[Sequence[str]] = None,
        backup_retention_period: Optional[int] = None,
        backup_retention_policy_on_cluster_deletion: Optional[int] = None,
        backup_time: Optional[str] = None,
        cloud_disk_encryption_key: Optional[str] = None,
        db_instance_class: Optional[str] = None,
        db_instance_storage: Optional[int] = None,
        effective_time: Optional[str] = None,
        enable_backup_log: Optional[int] = None,
        encrypted: Optional[bool] = None,
        encryption_key: Optional[str] = None,
        encryptor_name: Optional[str] = None,
        engine_version: Optional[str] = None,
        hidden_zone_id: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        kms_encrypted_password: Optional[str] = None,
        kms_encryption_context: Optional[Mapping[str, str]] = None,
        log_backup_retention_period: Optional[int] = None,
        maintain_end_time: Optional[str] = None,
        maintain_start_time: Optional[str] = None,
        name: Optional[str] = None,
        network_type: Optional[str] = None,
        order_type: Optional[str] = None,
        parameters: Optional[Sequence[InstanceParameterArgs]] = None,
        period: Optional[int] = None,
        provisioned_iops: Optional[int] = None,
        readonly_replicas: Optional[int] = None,
        replica_set_name: Optional[str] = None,
        replica_sets: Optional[Sequence[InstanceReplicaSetArgs]] = None,
        replication_factor: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        retention_period: Optional[int] = None,
        role_arn: Optional[str] = None,
        secondary_zone_id: Optional[str] = None,
        security_group_id: Optional[str] = None,
        security_ip_lists: Optional[Sequence[str]] = None,
        snapshot_backup_type: Optional[str] = None,
        ssl_action: Optional[str] = None,
        ssl_status: Optional[str] = None,
        storage_engine: Optional[str] = None,
        storage_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tde_status: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vswitch_id: Optional[str] = None,
        zone_id: Optional[str] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
resources:  _:    type: alicloud:mongodb:Instance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

BackupInterval string
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
BackupPeriods List<string>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
BackupRetentionPeriod int
The retention period of full backups.
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
CloudDiskEncryptionKey Changes to this property will trigger replacement. string
The ID of the encryption key.
DbInstanceClass string
Instance specification. see Instance specifications.
DbInstanceStorage int
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
EffectiveTime string
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
EnableBackupLog int
Specifies whether to enable the log backup feature. Valid values:
Encrypted Changes to this property will trigger replacement. bool
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
EncryptionKey string
The ID of the custom key.
EncryptorName string
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
EngineVersion string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
HiddenZoneId Changes to this property will trigger replacement. string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext Dictionary<string, string>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
LogBackupRetentionPeriod int
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
MaintainEndTime string
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic, VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Parameters List<Pulumi.AliCloud.MongoDB.Inputs.InstanceParameter>
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ReadonlyReplicas int
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
ReplicaSetName string
The name of the mongo replica set.
ReplicaSets List<Pulumi.AliCloud.MongoDB.Inputs.InstanceReplicaSet>
Replica set instance information.
ReplicationFactor int
Number of replica set nodes. Valid values: 1, 3, 5, 7.
ResourceGroupId string
The ID of the Resource Group.
RetentionPeriod int
Instance data backup retention days. Available since v1.42.0.
RoleArn string
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
SecondaryZoneId Changes to this property will trigger replacement. string
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists List<string>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
SnapshotBackupType string
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
SslAction string
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
SslStatus string
Status of the SSL feature.
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. Valid values: enabled.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
AccountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
AutoRenew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

BackupInterval string
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
BackupPeriods []string
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
BackupRetentionPeriod int
The retention period of full backups.
BackupRetentionPolicyOnClusterDeletion int
The backup retention policy configured for the instance. Valid values:
BackupTime string
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
CloudDiskEncryptionKey Changes to this property will trigger replacement. string
The ID of the encryption key.
DbInstanceClass string
Instance specification. see Instance specifications.
DbInstanceStorage int
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
EffectiveTime string
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
EnableBackupLog int
Specifies whether to enable the log backup feature. Valid values:
Encrypted Changes to this property will trigger replacement. bool
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
EncryptionKey string
The ID of the custom key.
EncryptorName string
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
EngineVersion string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
HiddenZoneId Changes to this property will trigger replacement. string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
InstanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
KmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
KmsEncryptionContext map[string]string
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
LogBackupRetentionPeriod int
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
MaintainEndTime string
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
MaintainStartTime string
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
Name string
The name of DB instance. It must be 2 to 256 characters in length.
NetworkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic, VPC.
OrderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
Parameters []InstanceParameterArgs
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
Period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
ProvisionedIops int
The provisioned IOPS. Valid values: 0 to 50000.
ReadonlyReplicas int
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
ReplicaSetName string
The name of the mongo replica set.
ReplicaSets []InstanceReplicaSetArgs
Replica set instance information.
ReplicationFactor int
Number of replica set nodes. Valid values: 1, 3, 5, 7.
ResourceGroupId string
The ID of the Resource Group.
RetentionPeriod int
Instance data backup retention days. Available since v1.42.0.
RoleArn string
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
SecondaryZoneId Changes to this property will trigger replacement. string
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
SecurityGroupId string
The Security Group ID of ECS.
SecurityIpLists []string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
SnapshotBackupType string
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
SslAction string
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
SslStatus string
Status of the SSL feature.
StorageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
StorageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
Tags map[string]string
A mapping of tags to assign to the resource.
TdeStatus string
The TDE(Transparent Data Encryption) status. Valid values: enabled.
VpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
ZoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backupInterval String
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backupRetentionPeriod Integer
The retention period of full backups.
backupRetentionPolicyOnClusterDeletion Integer
The backup retention policy configured for the instance. Valid values:
backupTime String
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloudDiskEncryptionKey Changes to this property will trigger replacement. String
The ID of the encryption key.
dbInstanceClass String
Instance specification. see Instance specifications.
dbInstanceStorage Integer
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
effectiveTime String
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enableBackupLog Integer
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. Boolean
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryptionKey String
The ID of the custom key.
encryptorName String
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
engineVersion String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
hiddenZoneId Changes to this property will trigger replacement. String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String,String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
logBackupRetentionPeriod Integer
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintainEndTime String
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime String
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic, VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters List<InstanceParameter>
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period Integer
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisionedIops Integer
The provisioned IOPS. Valid values: 0 to 50000.
readonlyReplicas Integer
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replicaSetName String
The name of the mongo replica set.
replicaSets List<InstanceReplicaSet>
Replica set instance information.
replicationFactor Integer
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resourceGroupId String
The ID of the Resource Group.
retentionPeriod Integer
Instance data backup retention days. Available since v1.42.0.
roleArn String
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondaryZoneId Changes to this property will trigger replacement. String
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshotBackupType String
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
sslAction String
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
sslStatus String
Status of the SSL feature.
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String,String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
accountPassword string
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backupInterval string
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backupPeriods string[]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backupRetentionPeriod number
The retention period of full backups.
backupRetentionPolicyOnClusterDeletion number
The backup retention policy configured for the instance. Valid values:
backupTime string
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloudDiskEncryptionKey Changes to this property will trigger replacement. string
The ID of the encryption key.
dbInstanceClass string
Instance specification. see Instance specifications.
dbInstanceStorage number
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
effectiveTime string
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enableBackupLog number
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. boolean
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryptionKey string
The ID of the custom key.
encryptorName string
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
engineVersion string
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
hiddenZoneId Changes to this property will trigger replacement. string
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instanceChargeType string
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kmsEncryptedPassword string
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext {[key: string]: string}
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
logBackupRetentionPeriod number
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintainEndTime string
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime string
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name string
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. string
The network type of the instance. Valid values:Classic, VPC.
orderType string
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters InstanceParameter[]
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisionedIops number
The provisioned IOPS. Valid values: 0 to 50000.
readonlyReplicas number
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replicaSetName string
The name of the mongo replica set.
replicaSets InstanceReplicaSet[]
Replica set instance information.
replicationFactor number
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resourceGroupId string
The ID of the Resource Group.
retentionPeriod number
Instance data backup retention days. Available since v1.42.0.
roleArn string
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondaryZoneId Changes to this property will trigger replacement. string
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
securityGroupId string
The Security Group ID of ECS.
securityIpLists string[]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshotBackupType string
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
sslAction string
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
sslStatus string
Status of the SSL feature.
storageEngine Changes to this property will trigger replacement. string
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType string
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
tdeStatus string
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpcId Changes to this property will trigger replacement. string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. string
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. string
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
account_password str
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
auto_renew bool

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backup_interval str
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backup_periods Sequence[str]
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backup_retention_period int
The retention period of full backups.
backup_retention_policy_on_cluster_deletion int
The backup retention policy configured for the instance. Valid values:
backup_time str
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloud_disk_encryption_key Changes to this property will trigger replacement. str
The ID of the encryption key.
db_instance_class str
Instance specification. see Instance specifications.
db_instance_storage int
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
effective_time str
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enable_backup_log int
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. bool
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryption_key str
The ID of the custom key.
encryptor_name str
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
engine_version str
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
hidden_zone_id Changes to this property will trigger replacement. str
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instance_charge_type str
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kms_encrypted_password str
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kms_encryption_context Mapping[str, str]
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
log_backup_retention_period int
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintain_end_time str
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintain_start_time str
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name str
The name of DB instance. It must be 2 to 256 characters in length.
network_type Changes to this property will trigger replacement. str
The network type of the instance. Valid values:Classic, VPC.
order_type str
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters Sequence[InstanceParameterArgs]
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period int
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisioned_iops int
The provisioned IOPS. Valid values: 0 to 50000.
readonly_replicas int
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replica_set_name str
The name of the mongo replica set.
replica_sets Sequence[InstanceReplicaSetArgs]
Replica set instance information.
replication_factor int
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resource_group_id str
The ID of the Resource Group.
retention_period int
Instance data backup retention days. Available since v1.42.0.
role_arn str
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondary_zone_id Changes to this property will trigger replacement. str
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
security_group_id str
The Security Group ID of ECS.
security_ip_lists Sequence[str]
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshot_backup_type str
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
ssl_action str
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
ssl_status str
Status of the SSL feature.
storage_engine Changes to this property will trigger replacement. str
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storage_type str
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
tde_status str
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpc_id Changes to this property will trigger replacement. str
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitch_id Changes to this property will trigger replacement. str
The virtual switch ID to launch DB instances in one VPC.
zone_id Changes to this property will trigger replacement. str
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.
accountPassword String
Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines.
autoRenew Boolean

Auto renew for prepaid. Default value: false. Valid values: true, false.

NOTE: The start time to the end time must be 1 hour. For example, the MaintainStartTime is 01:00Z, then the MaintainEndTime must be 02:00Z.

backupInterval String
The frequency at which high-frequency backups are created. Valid values: -1, 15, 30, 60, 120, 180, 240, 360, 480, 720.
backupPeriods List<String>
MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
backupRetentionPeriod Number
The retention period of full backups.
backupRetentionPolicyOnClusterDeletion Number
The backup retention policy configured for the instance. Valid values:
backupTime String
MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. If not set, the system will return a default, like "23:00Z-24:00Z".
cloudDiskEncryptionKey Changes to this property will trigger replacement. String
The ID of the encryption key.
dbInstanceClass String
Instance specification. see Instance specifications.
dbInstanceStorage Number
User-defined DB instance storage space.Unit: GB. Value range:

  • Custom storage space.
  • 10-GB increments.
effectiveTime String
The time when the changed configurations take effect. Valid values: Immediately, MaintainTime.
enableBackupLog Number
Specifies whether to enable the log backup feature. Valid values:
encrypted Changes to this property will trigger replacement. Boolean
Whether to enable cloud disk encryption. Default value: false. Valid values: true, false.
encryptionKey String
The ID of the custom key.
encryptorName String
The encryption method. NOTE: encryptor_name is valid only when tde_status is set to enabled.
engineVersion String
Database version. Value options can refer to the latest docs CreateDBInstance EngineVersion. NOTE: From version 1.225.0, engine_version can be modified.
hiddenZoneId Changes to this property will trigger replacement. String
Configure the zone where the hidden node is located to deploy multiple zones. NOTE: This parameter value cannot be the same as zone_id and secondary_zone_id parameter values.
instanceChargeType String
The billing method of the instance. Default value: PostPaid. Valid values: PrePaid, PostPaid. NOTE: It can be modified from PostPaid to PrePaid after version 1.63.0.
kmsEncryptedPassword String
An KMS encrypts password used to a instance. If the account_password is filled in, this field will be ignored.
kmsEncryptionContext Map<String>
An KMS encryption context used to decrypt kms_encrypted_password before creating or updating instance with kms_encrypted_password. See Encryption Context. It is valid when kms_encrypted_password is set.
logBackupRetentionPeriod Number
The number of days for which log backups are retained. Valid values: 7 to 730. NOTE: log_backup_retention_period is valid only when enable_backup_log is set to 1.
maintainEndTime String
The end time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
maintainStartTime String
The start time of the operation and maintenance time period of the instance, in the format of HH:mmZ (UTC time).
name String
The name of DB instance. It must be 2 to 256 characters in length.
networkType Changes to this property will trigger replacement. String
The network type of the instance. Valid values:Classic, VPC.
orderType String
The type of configuration changes performed. Default value: DOWNGRADE. Valid values:

  • UPGRADE: The specifications are upgraded.
  • DOWNGRADE: The specifications are downgraded. NOTE: order_type is only applicable to instances when instance_charge_type is PrePaid.
parameters List<Property Map>
Set of parameters needs to be set after mongodb instance was launched. See parameters below.
period Number
The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Default value: 1. Valid values: [1~9], 12, 24, 36.
provisionedIops Number
The provisioned IOPS. Valid values: 0 to 50000.
readonlyReplicas Number
The number of read-only nodes in the replica set instance. Default value: 0. Valid values: 0 to 5.
replicaSetName String
The name of the mongo replica set.
replicaSets List<Property Map>
Replica set instance information.
replicationFactor Number
Number of replica set nodes. Valid values: 1, 3, 5, 7.
resourceGroupId String
The ID of the Resource Group.
retentionPeriod Number
Instance data backup retention days. Available since v1.42.0.
roleArn String
The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role.
secondaryZoneId Changes to this property will trigger replacement. String
Configure the available area where the slave node (Secondary node) is located to realize multi-available area deployment. NOTE: This parameter value cannot be the same as zone_id and hidden_zone_id parameter values.
securityGroupId String
The Security Group ID of ECS.
securityIpLists List<String>
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]).
snapshotBackupType String
The snapshot backup type. Default value: Standard. Valid values:

  • Standard: standard backup.
  • Flash : single-digit second backup.
sslAction String
Actions performed on SSL functions. Valid values:

  • Open: turn on SSL encryption.
  • Close: turn off SSL encryption.
  • Update: update SSL certificate.
sslStatus String
Status of the SSL feature.
storageEngine Changes to this property will trigger replacement. String
The storage engine of the instance. Default value: WiredTiger. Valid values: WiredTiger, RocksDB.
storageType String
The storage type of the instance. Valid values: cloud_essd1, cloud_essd2, cloud_essd3, cloud_auto, local_ssd. NOTE: From version 1.229.0, storage_type can be modified. However, storage_type can only be modified to cloud_auto.
tags Map<String>
A mapping of tags to assign to the resource.
tdeStatus String
The TDE(Transparent Data Encryption) status. Valid values: enabled.
vpcId Changes to this property will trigger replacement. String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId Changes to this property will trigger replacement. String
The virtual switch ID to launch DB instances in one VPC.
zoneId Changes to this property will trigger replacement. String
The Zone to launch the DB instance. it supports multiple zone. If it is a multi-zone and vswitch_id is specified, the vswitch must in one of them. The multiple zone ID can be retrieved by setting multi to "true" in the data source alicloud.getZones.

Supporting Types

InstanceParameter
, InstanceParameterArgs

Name This property is required. string
The name of the parameter.
Value This property is required. string
The value of the parameter.
Name This property is required. string
The name of the parameter.
Value This property is required. string
The value of the parameter.
name This property is required. String
The name of the parameter.
value This property is required. String
The value of the parameter.
name This property is required. string
The name of the parameter.
value This property is required. string
The value of the parameter.
name This property is required. str
The name of the parameter.
value This property is required. str
The value of the parameter.
name This property is required. String
The name of the parameter.
value This property is required. String
The value of the parameter.

InstanceReplicaSet
, InstanceReplicaSetArgs

ConnectionDomain string
The connection address of the node.
ConnectionPort string
The connection port of the node.
NetworkType string
The network type of the instance. Valid values:Classic, VPC.
ReplicaSetRole string
The role of the node.
VpcCloudInstanceId string
VPC instance ID.
VpcId string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId string
The virtual switch ID to launch DB instances in one VPC.
ConnectionDomain string
The connection address of the node.
ConnectionPort string
The connection port of the node.
NetworkType string
The network type of the instance. Valid values:Classic, VPC.
ReplicaSetRole string
The role of the node.
VpcCloudInstanceId string
VPC instance ID.
VpcId string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
VswitchId string
The virtual switch ID to launch DB instances in one VPC.
connectionDomain String
The connection address of the node.
connectionPort String
The connection port of the node.
networkType String
The network type of the instance. Valid values:Classic, VPC.
replicaSetRole String
The role of the node.
vpcCloudInstanceId String
VPC instance ID.
vpcId String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId String
The virtual switch ID to launch DB instances in one VPC.
connectionDomain string
The connection address of the node.
connectionPort string
The connection port of the node.
networkType string
The network type of the instance. Valid values:Classic, VPC.
replicaSetRole string
The role of the node.
vpcCloudInstanceId string
VPC instance ID.
vpcId string
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId string
The virtual switch ID to launch DB instances in one VPC.
connection_domain str
The connection address of the node.
connection_port str
The connection port of the node.
network_type str
The network type of the instance. Valid values:Classic, VPC.
replica_set_role str
The role of the node.
vpc_cloud_instance_id str
VPC instance ID.
vpc_id str
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitch_id str
The virtual switch ID to launch DB instances in one VPC.
connectionDomain String
The connection address of the node.
connectionPort String
The connection port of the node.
networkType String
The network type of the instance. Valid values:Classic, VPC.
replicaSetRole String
The role of the node.
vpcCloudInstanceId String
VPC instance ID.
vpcId String
The ID of the VPC. > NOTE: vpc_id is valid only when network_type is set to VPC.
vswitchId String
The virtual switch ID to launch DB instances in one VPC.

Import

MongoDB instance can be imported using the id, e.g.

$ pulumi import alicloud:mongodb/instance:Instance example dds-bp1291daeda44194
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.