1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. mongodb
  5. Instance
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.mongodb.Instance

bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    MongoDB document database supports multiple architectures for flexible business deployment. In addition to replica set instances, MongoDB document database also provides sharded cluster architecture for large-scale data scenarios, along with disaster recovery, backup and restore, monitoring, and a complete solution set. It is widely used in industries such as internet (gaming, e-commerce, live streaming, news, social), new retail, online education, finance, IoT, and government/enterprise.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const mongoDBInstanceDemo = new bytepluscc.mongodb.Instance("MongoDBInstanceDemo", {
    zoneId: "cn-beijing-a,cn-beijing-c,cn-beijing-d",
    vpcId: "vpc-1a1vgeo9xxxcg8nvepjyxxxxx",
    subnetId: "subnet-ij9s4hxxxs3k74o8cuxxxxx",
    dbEngine: "MongoDB",
    dbEngineVersion: "MongoDB_7_0",
    instanceType: "ShardedCluster",
    nodeSpec: "mongo.shard.2c4g",
    nodeNumber: 3,
    mongosNodeSpec: "mongo.mongos.2c4g",
    mongosNodeNumber: 3,
    shardNumber: 2,
    storageSpaceGb: 100,
    configServerNodeSpec: "mongo.config.2c4g",
    configServerStorageSpaceGb: 20,
    superAccountName: "****",
    superAccountPassword: "*******",
    instanceName: "MongoDBInstanceDemo",
    instanceCount: 1,
    chargeType: "PostPaid",
    projectName: "default",
    tags: [{
        key: "env",
        value: "test",
    }],
    allowListIds: [
        "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
        "acl-70dbb8ee8893467dbafxxxc964xxxxx",
    ],
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

mongo_db_instance_demo = bytepluscc.mongodb.Instance("MongoDBInstanceDemo",
    zone_id="cn-beijing-a,cn-beijing-c,cn-beijing-d",
    vpc_id="vpc-1a1vgeo9xxxcg8nvepjyxxxxx",
    subnet_id="subnet-ij9s4hxxxs3k74o8cuxxxxx",
    db_engine="MongoDB",
    db_engine_version="MongoDB_7_0",
    instance_type="ShardedCluster",
    node_spec="mongo.shard.2c4g",
    node_number=3,
    mongos_node_spec="mongo.mongos.2c4g",
    mongos_node_number=3,
    shard_number=2,
    storage_space_gb=100,
    config_server_node_spec="mongo.config.2c4g",
    config_server_storage_space_gb=20,
    super_account_name="****",
    super_account_password="*******",
    instance_name="MongoDBInstanceDemo",
    instance_count=1,
    charge_type="PostPaid",
    project_name="default",
    tags=[{
        "key": "env",
        "value": "test",
    }],
    allow_list_ids=[
        "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
        "acl-70dbb8ee8893467dbafxxxc964xxxxx",
    ])

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/mongodb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodb.NewInstance(ctx, "MongoDBInstanceDemo", &mongodb.InstanceArgs{
			ZoneId:                     pulumi.String("cn-beijing-a,cn-beijing-c,cn-beijing-d"),
			VpcId:                      pulumi.String("vpc-1a1vgeo9xxxcg8nvepjyxxxxx"),
			SubnetId:                   pulumi.String("subnet-ij9s4hxxxs3k74o8cuxxxxx"),
			DbEngine:                   pulumi.String("MongoDB"),
			DbEngineVersion:            pulumi.String("MongoDB_7_0"),
			InstanceType:               pulumi.String("ShardedCluster"),
			NodeSpec:                   pulumi.String("mongo.shard.2c4g"),
			NodeNumber:                 pulumi.Int(3),
			MongosNodeSpec:             pulumi.String("mongo.mongos.2c4g"),
			MongosNodeNumber:           pulumi.Int(3),
			ShardNumber:                pulumi.Int(2),
			StorageSpaceGb:             pulumi.Int(100),
			ConfigServerNodeSpec:       pulumi.String("mongo.config.2c4g"),
			ConfigServerStorageSpaceGb: pulumi.Int(20),
			SuperAccountName:           pulumi.String("****"),
			SuperAccountPassword:       pulumi.String("*******"),
			InstanceName:               pulumi.String("MongoDBInstanceDemo"),
			InstanceCount:              pulumi.Int(1),
			ChargeType:                 pulumi.String("PostPaid"),
			ProjectName:                pulumi.String("default"),
			Tags: mongodb.InstanceTagArray{
				&mongodb.InstanceTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			AllowListIds: pulumi.StringArray{
				pulumi.String("acl-c972e7b4ce4941a1a8d5xxxe57xxxxx"),
				pulumi.String("acl-70dbb8ee8893467dbafxxxc964xxxxx"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var mongoDBInstanceDemo = new Bytepluscc.Mongodb.Instance("MongoDBInstanceDemo", new()
    {
        ZoneId = "cn-beijing-a,cn-beijing-c,cn-beijing-d",
        VpcId = "vpc-1a1vgeo9xxxcg8nvepjyxxxxx",
        SubnetId = "subnet-ij9s4hxxxs3k74o8cuxxxxx",
        DbEngine = "MongoDB",
        DbEngineVersion = "MongoDB_7_0",
        InstanceType = "ShardedCluster",
        NodeSpec = "mongo.shard.2c4g",
        NodeNumber = 3,
        MongosNodeSpec = "mongo.mongos.2c4g",
        MongosNodeNumber = 3,
        ShardNumber = 2,
        StorageSpaceGb = 100,
        ConfigServerNodeSpec = "mongo.config.2c4g",
        ConfigServerStorageSpaceGb = 20,
        SuperAccountName = "****",
        SuperAccountPassword = "*******",
        InstanceName = "MongoDBInstanceDemo",
        InstanceCount = 1,
        ChargeType = "PostPaid",
        ProjectName = "default",
        Tags = new[]
        {
            new Bytepluscc.Mongodb.Inputs.InstanceTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        AllowListIds = new[]
        {
            "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
            "acl-70dbb8ee8893467dbafxxxc964xxxxx",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.mongodb.Instance;
import com.byteplus.bytepluscc.mongodb.InstanceArgs;
import com.pulumi.bytepluscc.mongodb.inputs.InstanceTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mongoDBInstanceDemo = new Instance("mongoDBInstanceDemo", InstanceArgs.builder()
            .zoneId("cn-beijing-a,cn-beijing-c,cn-beijing-d")
            .vpcId("vpc-1a1vgeo9xxxcg8nvepjyxxxxx")
            .subnetId("subnet-ij9s4hxxxs3k74o8cuxxxxx")
            .dbEngine("MongoDB")
            .dbEngineVersion("MongoDB_7_0")
            .instanceType("ShardedCluster")
            .nodeSpec("mongo.shard.2c4g")
            .nodeNumber(3)
            .mongosNodeSpec("mongo.mongos.2c4g")
            .mongosNodeNumber(3)
            .shardNumber(2)
            .storageSpaceGb(100)
            .configServerNodeSpec("mongo.config.2c4g")
            .configServerStorageSpaceGb(20)
            .superAccountName("****")
            .superAccountPassword("*******")
            .instanceName("MongoDBInstanceDemo")
            .instanceCount(1)
            .chargeType("PostPaid")
            .projectName("default")
            .tags(InstanceTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .allowListIds(            
                "acl-c972e7b4ce4941a1a8d5xxxe57xxxxx",
                "acl-70dbb8ee8893467dbafxxxc964xxxxx")
            .build());

    }
}

    resources:
  mongoDBInstanceDemo:
    type: bytepluscc:mongodb:Instance
    name: MongoDBInstanceDemo
    properties:
      zoneId: cn-beijing-a,cn-beijing-c,cn-beijing-d
      vpcId: vpc-1a1vgeo9xxxcg8nvepjyxxxxx
      subnetId: subnet-ij9s4hxxxs3k74o8cuxxxxx
      dbEngine: MongoDB
      dbEngineVersion: MongoDB_7_0
      instanceType: ShardedCluster
      nodeSpec: mongo.shard.2c4g
      nodeNumber: 3
      mongosNodeSpec: mongo.mongos.2c4g
      mongosNodeNumber: 3
      shardNumber: 2
      storageSpaceGb: 100
      configServerNodeSpec: mongo.config.2c4g
      configServerStorageSpaceGb: 20
      superAccountName: '****'
      superAccountPassword: '*******'
      instanceName: MongoDBInstanceDemo
      instanceCount: 1
      chargeType: PostPaid
      projectName: default
      tags:
        - key: env
          value: test
      allowListIds:
        - acl-c972e7b4ce4941a1a8d5xxxe57xxxxx
        - acl-70dbb8ee8893467dbafxxxc964xxxxx

    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,
             node_spec: Optional[str] = None,
             zone_id: Optional[str] = None,
             vpc_id: Optional[str] = None,
             subnet_id: Optional[str] = None,
             storage_space_gb: Optional[int] = None,
             node_availability_zones: Optional[Sequence[InstanceNodeAvailabilityZoneArgs]] = None,
             period_unit: Optional[str] = None,
             instance_count: Optional[int] = None,
             instance_name: Optional[str] = None,
             instance_type: Optional[str] = None,
             mongos_node_number: Optional[int] = None,
             mongos_node_spec: Optional[str] = None,
             allow_list_ids: Optional[Sequence[str]] = None,
             node_number: Optional[int] = None,
             db_engine: Optional[str] = None,
             period: Optional[int] = None,
             db_engine_version: Optional[str] = None,
             project_name: Optional[str] = None,
             shard_number: Optional[int] = None,
             config_server_storage_space_gb: Optional[int] = None,
             config_server_node_spec: Optional[str] = None,
             super_account_name: Optional[str] = None,
             super_account_password: Optional[str] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             charge_type: Optional[str] = None,
             auto_renew: Optional[bool] = 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: bytepluscc:mongodb:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 Bytepluscc.Mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", new()
{
    NodeSpec = "string",
    ZoneId = "string",
    VpcId = "string",
    SubnetId = "string",
    StorageSpaceGb = 0,
    NodeAvailabilityZones = new[]
    {
        new Bytepluscc.Mongodb.Inputs.InstanceNodeAvailabilityZoneArgs
        {
            NodeNumber = 0,
            ZoneId = "string",
        },
    },
    PeriodUnit = "string",
    InstanceCount = 0,
    InstanceName = "string",
    InstanceType = "string",
    MongosNodeNumber = 0,
    MongosNodeSpec = "string",
    AllowListIds = new[]
    {
        "string",
    },
    NodeNumber = 0,
    DbEngine = "string",
    Period = 0,
    DbEngineVersion = "string",
    ProjectName = "string",
    ShardNumber = 0,
    ConfigServerStorageSpaceGb = 0,
    ConfigServerNodeSpec = "string",
    SuperAccountName = "string",
    SuperAccountPassword = "string",
    Tags = new[]
    {
        new Bytepluscc.Mongodb.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    ChargeType = "string",
    AutoRenew = false,
});

    example, err := mongodb.NewInstance(ctx, "exampleinstanceResourceResourceFromMongodbinstance", &mongodb.InstanceArgs{
	NodeSpec:       pulumi.String("string"),
	ZoneId:         pulumi.String("string"),
	VpcId:          pulumi.String("string"),
	SubnetId:       pulumi.String("string"),
	StorageSpaceGb: pulumi.Int(0),
	NodeAvailabilityZones: mongodb.InstanceNodeAvailabilityZoneArray{
		&mongodb.InstanceNodeAvailabilityZoneArgs{
			NodeNumber: pulumi.Int(0),
			ZoneId:     pulumi.String("string"),
		},
	},
	PeriodUnit:       pulumi.String("string"),
	InstanceCount:    pulumi.Int(0),
	InstanceName:     pulumi.String("string"),
	InstanceType:     pulumi.String("string"),
	MongosNodeNumber: pulumi.Int(0),
	MongosNodeSpec:   pulumi.String("string"),
	AllowListIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	NodeNumber:                 pulumi.Int(0),
	DbEngine:                   pulumi.String("string"),
	Period:                     pulumi.Int(0),
	DbEngineVersion:            pulumi.String("string"),
	ProjectName:                pulumi.String("string"),
	ShardNumber:                pulumi.Int(0),
	ConfigServerStorageSpaceGb: pulumi.Int(0),
	ConfigServerNodeSpec:       pulumi.String("string"),
	SuperAccountName:           pulumi.String("string"),
	SuperAccountPassword:       pulumi.String("string"),
	Tags: mongodb.InstanceTagArray{
		&mongodb.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ChargeType: pulumi.String("string"),
	AutoRenew:  pulumi.Bool(false),
})

    var exampleinstanceResourceResourceFromMongodbinstance = new com.byteplus.bytepluscc.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", com.byteplus.bytepluscc.mongodb.InstanceArgs.builder()
    .nodeSpec("string")
    .zoneId("string")
    .vpcId("string")
    .subnetId("string")
    .storageSpaceGb(0)
    .nodeAvailabilityZones(InstanceNodeAvailabilityZoneArgs.builder()
        .nodeNumber(0)
        .zoneId("string")
        .build())
    .periodUnit("string")
    .instanceCount(0)
    .instanceName("string")
    .instanceType("string")
    .mongosNodeNumber(0)
    .mongosNodeSpec("string")
    .allowListIds("string")
    .nodeNumber(0)
    .dbEngine("string")
    .period(0)
    .dbEngineVersion("string")
    .projectName("string")
    .shardNumber(0)
    .configServerStorageSpaceGb(0)
    .configServerNodeSpec("string")
    .superAccountName("string")
    .superAccountPassword("string")
    .tags(InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .chargeType("string")
    .autoRenew(false)
    .build());

    exampleinstance_resource_resource_from_mongodbinstance = bytepluscc.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance",
    node_spec="string",
    zone_id="string",
    vpc_id="string",
    subnet_id="string",
    storage_space_gb=0,
    node_availability_zones=[{
        "node_number": 0,
        "zone_id": "string",
    }],
    period_unit="string",
    instance_count=0,
    instance_name="string",
    instance_type="string",
    mongos_node_number=0,
    mongos_node_spec="string",
    allow_list_ids=["string"],
    node_number=0,
    db_engine="string",
    period=0,
    db_engine_version="string",
    project_name="string",
    shard_number=0,
    config_server_storage_space_gb=0,
    config_server_node_spec="string",
    super_account_name="string",
    super_account_password="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    charge_type="string",
    auto_renew=False)

    const exampleinstanceResourceResourceFromMongodbinstance = new bytepluscc.mongodb.Instance("exampleinstanceResourceResourceFromMongodbinstance", {
    nodeSpec: "string",
    zoneId: "string",
    vpcId: "string",
    subnetId: "string",
    storageSpaceGb: 0,
    nodeAvailabilityZones: [{
        nodeNumber: 0,
        zoneId: "string",
    }],
    periodUnit: "string",
    instanceCount: 0,
    instanceName: "string",
    instanceType: "string",
    mongosNodeNumber: 0,
    mongosNodeSpec: "string",
    allowListIds: ["string"],
    nodeNumber: 0,
    dbEngine: "string",
    period: 0,
    dbEngineVersion: "string",
    projectName: "string",
    shardNumber: 0,
    configServerStorageSpaceGb: 0,
    configServerNodeSpec: "string",
    superAccountName: "string",
    superAccountPassword: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    chargeType: "string",
    autoRenew: false,
});

    type: bytepluscc:mongodb:Instance
properties:
    allowListIds:
        - string
    autoRenew: false
    chargeType: string
    configServerNodeSpec: string
    configServerStorageSpaceGb: 0
    dbEngine: string
    dbEngineVersion: string
    instanceCount: 0
    instanceName: string
    instanceType: string
    mongosNodeNumber: 0
    mongosNodeSpec: string
    nodeAvailabilityZones:
        - nodeNumber: 0
          zoneId: string
    nodeNumber: 0
    nodeSpec: string
    period: 0
    periodUnit: string
    projectName: string
    shardNumber: 0
    storageSpaceGb: 0
    subnetId: string
    superAccountName: string
    superAccountPassword: string
    tags:
        - key: string
          value: string
    vpcId: string
    zoneId: string

    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:

    NodeSpec string
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    StorageSpaceGb int
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    SubnetId string
    Subnet ID.
    VpcId string
    Private network ID.
    ZoneId string
    Availability zone ID where the instance is located.
    AllowListIds List<string>
    Allowlist ID list. New instances are bound to the specified allowlist.
    AutoRenew bool
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    ChargeType string
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    ConfigServerNodeSpec string
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    ConfigServerStorageSpaceGb int
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    DbEngine string
    Database engine. The value is fixed as MongoDB
    DbEngineVersion string
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    InstanceCount int
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    InstanceName string
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    InstanceType string
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    MongosNodeNumber int
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    MongosNodeSpec string
    Specification code for Mongos nodes in a sharded cluster.
    NodeAvailabilityZones List<Byteplus.InstanceNodeAvailabilityZone>
    NodeNumber int
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    Period int
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    PeriodUnit string
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    ProjectName string
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    ShardNumber int
    Number of shards in the sharded cluster. Range: 2–32.
    SuperAccountName string
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    SuperAccountPassword string
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    Tags List<Byteplus.InstanceTag>
    NodeSpec string
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    StorageSpaceGb int
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    SubnetId string
    Subnet ID.
    VpcId string
    Private network ID.
    ZoneId string
    Availability zone ID where the instance is located.
    AllowListIds []string
    Allowlist ID list. New instances are bound to the specified allowlist.
    AutoRenew bool
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    ChargeType string
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    ConfigServerNodeSpec string
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    ConfigServerStorageSpaceGb int
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    DbEngine string
    Database engine. The value is fixed as MongoDB
    DbEngineVersion string
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    InstanceCount int
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    InstanceName string
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    InstanceType string
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    MongosNodeNumber int
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    MongosNodeSpec string
    Specification code for Mongos nodes in a sharded cluster.
    NodeAvailabilityZones []InstanceNodeAvailabilityZoneArgs
    NodeNumber int
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    Period int
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    PeriodUnit string
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    ProjectName string
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    ShardNumber int
    Number of shards in the sharded cluster. Range: 2–32.
    SuperAccountName string
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    SuperAccountPassword string
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    Tags []InstanceTagArgs
    nodeSpec String
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    storageSpaceGb Integer
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    subnetId String
    Subnet ID.
    vpcId String
    Private network ID.
    zoneId String
    Availability zone ID where the instance is located.
    allowListIds List<String>
    Allowlist ID list. New instances are bound to the specified allowlist.
    autoRenew Boolean
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    chargeType String
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    configServerNodeSpec String
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    configServerStorageSpaceGb Integer
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    dbEngine String
    Database engine. The value is fixed as MongoDB
    dbEngineVersion String
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    instanceCount Integer
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instanceName String
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instanceType String
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongosNodeNumber Integer
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongosNodeSpec String
    Specification code for Mongos nodes in a sharded cluster.
    nodeAvailabilityZones List<InstanceNodeAvailabilityZone>
    nodeNumber Integer
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    period Integer
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    periodUnit String
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    projectName String
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    shardNumber Integer
    Number of shards in the sharded cluster. Range: 2–32.
    superAccountName String
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    superAccountPassword String
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags List<InstanceTag>
    nodeSpec string
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    storageSpaceGb number
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    subnetId string
    Subnet ID.
    vpcId string
    Private network ID.
    zoneId string
    Availability zone ID where the instance is located.
    allowListIds string[]
    Allowlist ID list. New instances are bound to the specified allowlist.
    autoRenew boolean
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    chargeType string
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    configServerNodeSpec string
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    configServerStorageSpaceGb number
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    dbEngine string
    Database engine. The value is fixed as MongoDB
    dbEngineVersion string
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    instanceCount number
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instanceName string
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instanceType string
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongosNodeNumber number
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongosNodeSpec string
    Specification code for Mongos nodes in a sharded cluster.
    nodeAvailabilityZones InstanceNodeAvailabilityZone[]
    nodeNumber number
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    period number
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    periodUnit string
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    projectName string
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    shardNumber number
    Number of shards in the sharded cluster. Range: 2–32.
    superAccountName string
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    superAccountPassword string
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags InstanceTag[]
    node_spec str
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    storage_space_gb int
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    subnet_id str
    Subnet ID.
    vpc_id str
    Private network ID.
    zone_id str
    Availability zone ID where the instance is located.
    allow_list_ids Sequence[str]
    Allowlist ID list. New instances are bound to the specified allowlist.
    auto_renew bool
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    charge_type str
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    config_server_node_spec str
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    config_server_storage_space_gb int
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    db_engine str
    Database engine. The value is fixed as MongoDB
    db_engine_version str
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    instance_count int
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instance_name str
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instance_type str
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongos_node_number int
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongos_node_spec str
    Specification code for Mongos nodes in a sharded cluster.
    node_availability_zones Sequence[InstanceNodeAvailabilityZoneArgs]
    node_number int
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    period int
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    period_unit str
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    project_name str
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    shard_number int
    Number of shards in the sharded cluster. Range: 2–32.
    super_account_name str
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    super_account_password str
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags Sequence[InstanceTagArgs]
    nodeSpec String
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    storageSpaceGb Number
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    subnetId String
    Subnet ID.
    vpcId String
    Private network ID.
    zoneId String
    Availability zone ID where the instance is located.
    allowListIds List<String>
    Allowlist ID list. New instances are bound to the specified allowlist.
    autoRenew Boolean
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    chargeType String
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    configServerNodeSpec String
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    configServerStorageSpaceGb Number
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    dbEngine String
    Database engine. The value is fixed as MongoDB
    dbEngineVersion String
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    instanceCount Number
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instanceName String
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instanceType String
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongosNodeNumber Number
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongosNodeSpec String
    Specification code for Mongos nodes in a sharded cluster.
    nodeAvailabilityZones List<Property Map>
    nodeNumber Number
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    period Number
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    periodUnit String
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    projectName String
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    shardNumber Number
    Number of shards in the sharded cluster. Range: 2–32.
    superAccountName String
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    superAccountPassword String
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags List<Property Map>

    Outputs

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

    ChargeStatus string
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    ClosedTime string
    Scheduled shutdown time (UTC).
    ConfigServers List<Byteplus.InstanceConfigServer>
    ConfigServersId string
    ConfigServer ID
    CreatedTime string
    Instance creation time (UTC).
    DbEngineVersionStr string
    Database engine version string
    ExpiredTime string
    Instance expiration time (UTC).
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    Mongos List<Byteplus.InstanceMongo>
    MongosId string
    Mongos ID.
    Nodes List<Byteplus.InstanceNode>
    PrivateEndpoint string
    String information for the instance's private network connection address.
    ReadOnlyNodeNumber int
    Number of read-only nodes in the instance
    ReclaimTime string
    Scheduled recycle time for the instance (UTC)
    Shards List<Byteplus.InstanceShard>
    StorageType string
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    UpdatedTime string
    Instance update time (UTC).
    ChargeStatus string
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    ClosedTime string
    Scheduled shutdown time (UTC).
    ConfigServers []InstanceConfigServer
    ConfigServersId string
    ConfigServer ID
    CreatedTime string
    Instance creation time (UTC).
    DbEngineVersionStr string
    Database engine version string
    ExpiredTime string
    Instance expiration time (UTC).
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    Mongos []InstanceMongo
    MongosId string
    Mongos ID.
    Nodes []InstanceNode
    PrivateEndpoint string
    String information for the instance's private network connection address.
    ReadOnlyNodeNumber int
    Number of read-only nodes in the instance
    ReclaimTime string
    Scheduled recycle time for the instance (UTC)
    Shards []InstanceShard
    StorageType string
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    UpdatedTime string
    Instance update time (UTC).
    chargeStatus String
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    closedTime String
    Scheduled shutdown time (UTC).
    configServers List<InstanceConfigServer>
    configServersId String
    ConfigServer ID
    createdTime String
    Instance creation time (UTC).
    dbEngineVersionStr String
    Database engine version string
    expiredTime String
    Instance expiration time (UTC).
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    mongos List<InstanceMongo>
    mongosId String
    Mongos ID.
    nodes List<InstanceNode>
    privateEndpoint String
    String information for the instance's private network connection address.
    readOnlyNodeNumber Integer
    Number of read-only nodes in the instance
    reclaimTime String
    Scheduled recycle time for the instance (UTC)
    shards List<InstanceShard>
    storageType String
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    updatedTime String
    Instance update time (UTC).
    chargeStatus string
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    closedTime string
    Scheduled shutdown time (UTC).
    configServers InstanceConfigServer[]
    configServersId string
    ConfigServer ID
    createdTime string
    Instance creation time (UTC).
    dbEngineVersionStr string
    Database engine version string
    expiredTime string
    Instance expiration time (UTC).
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID.
    instanceStatus string
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    mongos InstanceMongo[]
    mongosId string
    Mongos ID.
    nodes InstanceNode[]
    privateEndpoint string
    String information for the instance's private network connection address.
    readOnlyNodeNumber number
    Number of read-only nodes in the instance
    reclaimTime string
    Scheduled recycle time for the instance (UTC)
    shards InstanceShard[]
    storageType string
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    updatedTime string
    Instance update time (UTC).
    charge_status str
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    closed_time str
    Scheduled shutdown time (UTC).
    config_servers Sequence[InstanceConfigServer]
    config_servers_id str
    ConfigServer ID
    created_time str
    Instance creation time (UTC).
    db_engine_version_str str
    Database engine version string
    expired_time str
    Instance expiration time (UTC).
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Instance ID.
    instance_status str
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    mongos Sequence[InstanceMongo]
    mongos_id str
    Mongos ID.
    nodes Sequence[InstanceNode]
    private_endpoint str
    String information for the instance's private network connection address.
    read_only_node_number int
    Number of read-only nodes in the instance
    reclaim_time str
    Scheduled recycle time for the instance (UTC)
    shards Sequence[InstanceShard]
    storage_type str
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    updated_time str
    Instance update time (UTC).
    chargeStatus String
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    closedTime String
    Scheduled shutdown time (UTC).
    configServers List<Property Map>
    configServersId String
    ConfigServer ID
    createdTime String
    Instance creation time (UTC).
    dbEngineVersionStr String
    Database engine version string
    expiredTime String
    Instance expiration time (UTC).
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    mongos List<Property Map>
    mongosId String
    Mongos ID.
    nodes List<Property Map>
    privateEndpoint String
    String information for the instance's private network connection address.
    readOnlyNodeNumber Number
    Number of read-only nodes in the instance
    reclaimTime String
    Scheduled recycle time for the instance (UTC)
    shards List<Property Map>
    storageType String
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    updatedTime String
    Instance update time (UTC).

    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,
        allow_list_ids: Optional[Sequence[str]] = None,
        auto_renew: Optional[bool] = None,
        charge_status: Optional[str] = None,
        charge_type: Optional[str] = None,
        closed_time: Optional[str] = None,
        config_server_node_spec: Optional[str] = None,
        config_server_storage_space_gb: Optional[int] = None,
        config_servers: Optional[Sequence[InstanceConfigServerArgs]] = None,
        config_servers_id: Optional[str] = None,
        created_time: Optional[str] = None,
        db_engine: Optional[str] = None,
        db_engine_version: Optional[str] = None,
        db_engine_version_str: Optional[str] = None,
        expired_time: Optional[str] = None,
        instance_count: Optional[int] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        instance_type: Optional[str] = None,
        mongos: Optional[Sequence[InstanceMongoArgs]] = None,
        mongos_id: Optional[str] = None,
        mongos_node_number: Optional[int] = None,
        mongos_node_spec: Optional[str] = None,
        node_availability_zones: Optional[Sequence[InstanceNodeAvailabilityZoneArgs]] = None,
        node_number: Optional[int] = None,
        node_spec: Optional[str] = None,
        nodes: Optional[Sequence[InstanceNodeArgs]] = None,
        period: Optional[int] = None,
        period_unit: Optional[str] = None,
        private_endpoint: Optional[str] = None,
        project_name: Optional[str] = None,
        read_only_node_number: Optional[int] = None,
        reclaim_time: Optional[str] = None,
        shard_number: Optional[int] = None,
        shards: Optional[Sequence[InstanceShardArgs]] = None,
        storage_space_gb: Optional[int] = None,
        storage_type: Optional[str] = None,
        subnet_id: Optional[str] = None,
        super_account_name: Optional[str] = None,
        super_account_password: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        updated_time: Optional[str] = None,
        vpc_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: bytepluscc:mongodb:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowListIds List<string>
    Allowlist ID list. New instances are bound to the specified allowlist.
    AutoRenew bool
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    ChargeStatus string
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    ChargeType string
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    ClosedTime string
    Scheduled shutdown time (UTC).
    ConfigServerNodeSpec string
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    ConfigServerStorageSpaceGb int
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    ConfigServers List<Byteplus.InstanceConfigServer>
    ConfigServersId string
    ConfigServer ID
    CreatedTime string
    Instance creation time (UTC).
    DbEngine string
    Database engine. The value is fixed as MongoDB
    DbEngineVersion string
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    DbEngineVersionStr string
    Database engine version string
    ExpiredTime string
    Instance expiration time (UTC).
    InstanceCount int
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    InstanceStatus string
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    InstanceType string
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    Mongos List<Byteplus.InstanceMongo>
    MongosId string
    Mongos ID.
    MongosNodeNumber int
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    MongosNodeSpec string
    Specification code for Mongos nodes in a sharded cluster.
    NodeAvailabilityZones List<Byteplus.InstanceNodeAvailabilityZone>
    NodeNumber int
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    NodeSpec string
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    Nodes List<Byteplus.InstanceNode>
    Period int
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    PeriodUnit string
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    PrivateEndpoint string
    String information for the instance's private network connection address.
    ProjectName string
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    ReadOnlyNodeNumber int
    Number of read-only nodes in the instance
    ReclaimTime string
    Scheduled recycle time for the instance (UTC)
    ShardNumber int
    Number of shards in the sharded cluster. Range: 2–32.
    Shards List<Byteplus.InstanceShard>
    StorageSpaceGb int
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    StorageType string
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    SubnetId string
    Subnet ID.
    SuperAccountName string
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    SuperAccountPassword string
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    Tags List<Byteplus.InstanceTag>
    UpdatedTime string
    Instance update time (UTC).
    VpcId string
    Private network ID.
    ZoneId string
    Availability zone ID where the instance is located.
    AllowListIds []string
    Allowlist ID list. New instances are bound to the specified allowlist.
    AutoRenew bool
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    ChargeStatus string
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    ChargeType string
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    ClosedTime string
    Scheduled shutdown time (UTC).
    ConfigServerNodeSpec string
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    ConfigServerStorageSpaceGb int
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    ConfigServers []InstanceConfigServerArgs
    ConfigServersId string
    ConfigServer ID
    CreatedTime string
    Instance creation time (UTC).
    DbEngine string
    Database engine. The value is fixed as MongoDB
    DbEngineVersion string
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    DbEngineVersionStr string
    Database engine version string
    ExpiredTime string
    Instance expiration time (UTC).
    InstanceCount int
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    InstanceStatus string
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    InstanceType string
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    Mongos []InstanceMongoArgs
    MongosId string
    Mongos ID.
    MongosNodeNumber int
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    MongosNodeSpec string
    Specification code for Mongos nodes in a sharded cluster.
    NodeAvailabilityZones []InstanceNodeAvailabilityZoneArgs
    NodeNumber int
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    NodeSpec string
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    Nodes []InstanceNodeArgs
    Period int
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    PeriodUnit string
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    PrivateEndpoint string
    String information for the instance's private network connection address.
    ProjectName string
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    ReadOnlyNodeNumber int
    Number of read-only nodes in the instance
    ReclaimTime string
    Scheduled recycle time for the instance (UTC)
    ShardNumber int
    Number of shards in the sharded cluster. Range: 2–32.
    Shards []InstanceShardArgs
    StorageSpaceGb int
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    StorageType string
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    SubnetId string
    Subnet ID.
    SuperAccountName string
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    SuperAccountPassword string
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    Tags []InstanceTagArgs
    UpdatedTime string
    Instance update time (UTC).
    VpcId string
    Private network ID.
    ZoneId string
    Availability zone ID where the instance is located.
    allowListIds List<String>
    Allowlist ID list. New instances are bound to the specified allowlist.
    autoRenew Boolean
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    chargeStatus String
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    chargeType String
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    closedTime String
    Scheduled shutdown time (UTC).
    configServerNodeSpec String
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    configServerStorageSpaceGb Integer
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    configServers List<InstanceConfigServer>
    configServersId String
    ConfigServer ID
    createdTime String
    Instance creation time (UTC).
    dbEngine String
    Database engine. The value is fixed as MongoDB
    dbEngineVersion String
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    dbEngineVersionStr String
    Database engine version string
    expiredTime String
    Instance expiration time (UTC).
    instanceCount Integer
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instanceStatus String
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    instanceType String
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongos List<InstanceMongo>
    mongosId String
    Mongos ID.
    mongosNodeNumber Integer
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongosNodeSpec String
    Specification code for Mongos nodes in a sharded cluster.
    nodeAvailabilityZones List<InstanceNodeAvailabilityZone>
    nodeNumber Integer
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    nodeSpec String
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    nodes List<InstanceNode>
    period Integer
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    periodUnit String
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    privateEndpoint String
    String information for the instance's private network connection address.
    projectName String
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    readOnlyNodeNumber Integer
    Number of read-only nodes in the instance
    reclaimTime String
    Scheduled recycle time for the instance (UTC)
    shardNumber Integer
    Number of shards in the sharded cluster. Range: 2–32.
    shards List<InstanceShard>
    storageSpaceGb Integer
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    storageType String
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    subnetId String
    Subnet ID.
    superAccountName String
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    superAccountPassword String
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags List<InstanceTag>
    updatedTime String
    Instance update time (UTC).
    vpcId String
    Private network ID.
    zoneId String
    Availability zone ID where the instance is located.
    allowListIds string[]
    Allowlist ID list. New instances are bound to the specified allowlist.
    autoRenew boolean
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    chargeStatus string
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    chargeType string
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    closedTime string
    Scheduled shutdown time (UTC).
    configServerNodeSpec string
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    configServerStorageSpaceGb number
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    configServers InstanceConfigServer[]
    configServersId string
    ConfigServer ID
    createdTime string
    Instance creation time (UTC).
    dbEngine string
    Database engine. The value is fixed as MongoDB
    dbEngineVersion string
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    dbEngineVersionStr string
    Database engine version string
    expiredTime string
    Instance expiration time (UTC).
    instanceCount number
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instanceId string
    Instance ID.
    instanceName string
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instanceStatus string
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    instanceType string
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongos InstanceMongo[]
    mongosId string
    Mongos ID.
    mongosNodeNumber number
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongosNodeSpec string
    Specification code for Mongos nodes in a sharded cluster.
    nodeAvailabilityZones InstanceNodeAvailabilityZone[]
    nodeNumber number
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    nodeSpec string
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    nodes InstanceNode[]
    period number
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    periodUnit string
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    privateEndpoint string
    String information for the instance's private network connection address.
    projectName string
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    readOnlyNodeNumber number
    Number of read-only nodes in the instance
    reclaimTime string
    Scheduled recycle time for the instance (UTC)
    shardNumber number
    Number of shards in the sharded cluster. Range: 2–32.
    shards InstanceShard[]
    storageSpaceGb number
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    storageType string
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    subnetId string
    Subnet ID.
    superAccountName string
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    superAccountPassword string
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags InstanceTag[]
    updatedTime string
    Instance update time (UTC).
    vpcId string
    Private network ID.
    zoneId string
    Availability zone ID where the instance is located.
    allow_list_ids Sequence[str]
    Allowlist ID list. New instances are bound to the specified allowlist.
    auto_renew bool
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    charge_status str
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    charge_type str
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    closed_time str
    Scheduled shutdown time (UTC).
    config_server_node_spec str
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    config_server_storage_space_gb int
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    config_servers Sequence[InstanceConfigServerArgs]
    config_servers_id str
    ConfigServer ID
    created_time str
    Instance creation time (UTC).
    db_engine str
    Database engine. The value is fixed as MongoDB
    db_engine_version str
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    db_engine_version_str str
    Database engine version string
    expired_time str
    Instance expiration time (UTC).
    instance_count int
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instance_id str
    Instance ID.
    instance_name str
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instance_status str
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    instance_type str
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongos Sequence[InstanceMongoArgs]
    mongos_id str
    Mongos ID.
    mongos_node_number int
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongos_node_spec str
    Specification code for Mongos nodes in a sharded cluster.
    node_availability_zones Sequence[InstanceNodeAvailabilityZoneArgs]
    node_number int
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    node_spec str
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    nodes Sequence[InstanceNodeArgs]
    period int
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    period_unit str
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    private_endpoint str
    String information for the instance's private network connection address.
    project_name str
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    read_only_node_number int
    Number of read-only nodes in the instance
    reclaim_time str
    Scheduled recycle time for the instance (UTC)
    shard_number int
    Number of shards in the sharded cluster. Range: 2–32.
    shards Sequence[InstanceShardArgs]
    storage_space_gb int
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    storage_type str
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    subnet_id str
    Subnet ID.
    super_account_name str
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    super_account_password str
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags Sequence[InstanceTagArgs]
    updated_time str
    Instance update time (UTC).
    vpc_id str
    Private network ID.
    zone_id str
    Availability zone ID where the instance is located.
    allowListIds List<String>
    Allowlist ID list. New instances are bound to the specified allowlist.
    autoRenew Boolean
    Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
    chargeStatus String
    Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
    chargeType String
    Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
    closedTime String
    Scheduled shutdown time (UTC).
    configServerNodeSpec String
    ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
    configServerStorageSpaceGb Number
    ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
    configServers List<Property Map>
    configServersId String
    ConfigServer ID
    createdTime String
    Instance creation time (UTC).
    dbEngine String
    Database engine. The value is fixed as MongoDB
    dbEngineVersion String
    Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
    dbEngineVersionStr String
    Database engine version string
    expiredTime String
    Instance expiration time (UTC).
    instanceCount Number
    Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
    instanceStatus String
    Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
    instanceType String
    MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
    mongos List<Property Map>
    mongosId String
    Mongos ID.
    mongosNodeNumber Number
    Number of Mongos nodes in the sharded cluster. Range: 2~32.
    mongosNodeSpec String
    Specification code for Mongos nodes in a sharded cluster.
    nodeAvailabilityZones List<Property Map>
    nodeNumber Number
    Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
    nodeSpec String
    Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
    nodes List<Property Map>
    period Number
    Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
    periodUnit String
    Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
    privateEndpoint String
    String information for the instance's private network connection address.
    projectName String
    Select the project for the instance. If left blank, the new instance will be added to the default project.
    readOnlyNodeNumber Number
    Number of read-only nodes in the instance
    reclaimTime String
    Scheduled recycle time for the instance (UTC)
    shardNumber Number
    Number of shards in the sharded cluster. Range: 2–32.
    shards List<Property Map>
    storageSpaceGb Number
    Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
    storageType String
    Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
    subnetId String
    Subnet ID.
    superAccountName String
    Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
    superAccountPassword String
    Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
    tags List<Property Map>
    updatedTime String
    Instance update time (UTC).
    vpcId String
    Private network ID.
    zoneId String
    Availability zone ID where the instance is located.

    Supporting Types

    InstanceConfigServer, InstanceConfigServerArgs

    ConfigServerNodeId string
    ConfigServer node ID
    NodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
    NodeStatus string
    Node status.
    TotalMemoryGb double
    Total memory. Unit: GiB.
    TotalvCpu double
    Total cores.
    UsedMemoryGb double
    Used memory. Unit: GiB.
    UsedvCpu double
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    ConfigServerNodeId string
    ConfigServer node ID
    NodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
    NodeStatus string
    Node status.
    TotalMemoryGb float64
    Total memory. Unit: GiB.
    TotalvCpu float64
    Total cores.
    UsedMemoryGb float64
    Used memory. Unit: GiB.
    UsedvCpu float64
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    configServerNodeId String
    ConfigServer node ID
    nodeRole String
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
    nodeStatus String
    Node status.
    totalMemoryGb Double
    Total memory. Unit: GiB.
    totalvCpu Double
    Total cores.
    usedMemoryGb Double
    Used memory. Unit: GiB.
    usedvCpu Double
    Used cores.
    zoneId String
    Availability zone ID of the current node.
    configServerNodeId string
    ConfigServer node ID
    nodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
    nodeStatus string
    Node status.
    totalMemoryGb number
    Total memory. Unit: GiB.
    totalvCpu number
    Total cores.
    usedMemoryGb number
    Used memory. Unit: GiB.
    usedvCpu number
    Used cores.
    zoneId string
    Availability zone ID of the current node.
    config_server_node_id str
    ConfigServer node ID
    node_role str
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
    node_status str
    Node status.
    total_memory_gb float
    Total memory. Unit: GiB.
    totalv_cpu float
    Total cores.
    used_memory_gb float
    Used memory. Unit: GiB.
    usedv_cpu float
    Used cores.
    zone_id str
    Availability zone ID of the current node.
    configServerNodeId String
    ConfigServer node ID
    nodeRole String
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
    nodeStatus String
    Node status.
    totalMemoryGb Number
    Total memory. Unit: GiB.
    totalvCpu Number
    Total cores.
    usedMemoryGb Number
    Used memory. Unit: GiB.
    usedvCpu Number
    Used cores.
    zoneId String
    Availability zone ID of the current node.

    InstanceMongo, InstanceMongoArgs

    MongosNodeId string
    Mongos node ID
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status.
    TotalMemoryGb double
    Total memory. Unit: GiB.
    TotalvCpu double
    Total cores.
    UsedMemoryGb double
    Used memory. Unit: GiB.
    UsedvCpu double
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    MongosNodeId string
    Mongos node ID
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status.
    TotalMemoryGb float64
    Total memory. Unit: GiB.
    TotalvCpu float64
    Total cores.
    UsedMemoryGb float64
    Used memory. Unit: GiB.
    UsedvCpu float64
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    mongosNodeId String
    Mongos node ID
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status.
    totalMemoryGb Double
    Total memory. Unit: GiB.
    totalvCpu Double
    Total cores.
    usedMemoryGb Double
    Used memory. Unit: GiB.
    usedvCpu Double
    Used cores.
    zoneId String
    Availability zone ID of the current node.
    mongosNodeId string
    Mongos node ID
    nodeSpec string
    Node specification.
    nodeStatus string
    Node status.
    totalMemoryGb number
    Total memory. Unit: GiB.
    totalvCpu number
    Total cores.
    usedMemoryGb number
    Used memory. Unit: GiB.
    usedvCpu number
    Used cores.
    zoneId string
    Availability zone ID of the current node.
    mongos_node_id str
    Mongos node ID
    node_spec str
    Node specification.
    node_status str
    Node status.
    total_memory_gb float
    Total memory. Unit: GiB.
    totalv_cpu float
    Total cores.
    used_memory_gb float
    Used memory. Unit: GiB.
    usedv_cpu float
    Used cores.
    zone_id str
    Availability zone ID of the current node.
    mongosNodeId String
    Mongos node ID
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status.
    totalMemoryGb Number
    Total memory. Unit: GiB.
    totalvCpu Number
    Total cores.
    usedMemoryGb Number
    Used memory. Unit: GiB.
    usedvCpu Number
    Used cores.
    zoneId String
    Availability zone ID of the current node.

    InstanceNode, InstanceNodeArgs

    NodeDelayTime int
    Node latency. Unit: seconds.
    NodeId string
    Node ID.
    NodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status.
    TotalMemoryGb double
    Total memory. Unit: GiB.
    TotalStorageGb double
    Total storage space for this node. Unit: GiB.
    TotalvCpu double
    Total cores.
    UsedMemoryGb double
    Used memory. Unit: GiB.
    UsedStorageGb double
    Storage space used by this node. Unit: GiB.
    UsedvCpu double
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    NodeDelayTime int
    Node latency. Unit: seconds.
    NodeId string
    Node ID.
    NodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status.
    TotalMemoryGb float64
    Total memory. Unit: GiB.
    TotalStorageGb float64
    Total storage space for this node. Unit: GiB.
    TotalvCpu float64
    Total cores.
    UsedMemoryGb float64
    Used memory. Unit: GiB.
    UsedStorageGb float64
    Storage space used by this node. Unit: GiB.
    UsedvCpu float64
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    nodeDelayTime Integer
    Node latency. Unit: seconds.
    nodeId String
    Node ID.
    nodeRole String
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status.
    totalMemoryGb Double
    Total memory. Unit: GiB.
    totalStorageGb Double
    Total storage space for this node. Unit: GiB.
    totalvCpu Double
    Total cores.
    usedMemoryGb Double
    Used memory. Unit: GiB.
    usedStorageGb Double
    Storage space used by this node. Unit: GiB.
    usedvCpu Double
    Used cores.
    zoneId String
    Availability zone ID of the current node.
    nodeDelayTime number
    Node latency. Unit: seconds.
    nodeId string
    Node ID.
    nodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    nodeSpec string
    Node specification.
    nodeStatus string
    Node status.
    totalMemoryGb number
    Total memory. Unit: GiB.
    totalStorageGb number
    Total storage space for this node. Unit: GiB.
    totalvCpu number
    Total cores.
    usedMemoryGb number
    Used memory. Unit: GiB.
    usedStorageGb number
    Storage space used by this node. Unit: GiB.
    usedvCpu number
    Used cores.
    zoneId string
    Availability zone ID of the current node.
    node_delay_time int
    Node latency. Unit: seconds.
    node_id str
    Node ID.
    node_role str
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    node_spec str
    Node specification.
    node_status str
    Node status.
    total_memory_gb float
    Total memory. Unit: GiB.
    total_storage_gb float
    Total storage space for this node. Unit: GiB.
    totalv_cpu float
    Total cores.
    used_memory_gb float
    Used memory. Unit: GiB.
    used_storage_gb float
    Storage space used by this node. Unit: GiB.
    usedv_cpu float
    Used cores.
    zone_id str
    Availability zone ID of the current node.
    nodeDelayTime Number
    Node latency. Unit: seconds.
    nodeId String
    Node ID.
    nodeRole String
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status.
    totalMemoryGb Number
    Total memory. Unit: GiB.
    totalStorageGb Number
    Total storage space for this node. Unit: GiB.
    totalvCpu Number
    Total cores.
    usedMemoryGb Number
    Used memory. Unit: GiB.
    usedStorageGb Number
    Storage space used by this node. Unit: GiB.
    usedvCpu Number
    Used cores.
    zoneId String
    Availability zone ID of the current node.

    InstanceNodeAvailabilityZone, InstanceNodeAvailabilityZoneArgs

    NodeNumber int
    Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
    ZoneId string
    Availability zone of the read-only node.
    NodeNumber int
    Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
    ZoneId string
    Availability zone of the read-only node.
    nodeNumber Integer
    Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
    zoneId String
    Availability zone of the read-only node.
    nodeNumber number
    Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
    zoneId string
    Availability zone of the read-only node.
    node_number int
    Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
    zone_id str
    Availability zone of the read-only node.
    nodeNumber Number
    Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
    zoneId String
    Availability zone of the read-only node.

    InstanceShard, InstanceShardArgs

    Nodes []InstanceShardNode
    ShardId string
    Shard node ID.
    nodes InstanceShardNode[]
    shardId string
    Shard node ID.
    nodes List<Property Map>
    shardId String
    Shard node ID.

    InstanceShardNode, InstanceShardNodeArgs

    NodeDelayTime int
    Node latency. Unit: seconds.
    NodeId string
    Node ID.
    NodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status.
    TotalMemoryGb double
    Total memory. Unit: GiB.
    TotalStorageGb double
    Total storage space for this node. Unit: GiB.
    TotalvCpu double
    Total cores.
    UsedMemoryGb double
    Used memory. Unit: GiB.
    UsedStorageGb double
    Storage space used by this node. Unit: GiB.
    UsedvCpu double
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    NodeDelayTime int
    Node latency. Unit: seconds.
    NodeId string
    Node ID.
    NodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    NodeSpec string
    Node specification.
    NodeStatus string
    Node status.
    TotalMemoryGb float64
    Total memory. Unit: GiB.
    TotalStorageGb float64
    Total storage space for this node. Unit: GiB.
    TotalvCpu float64
    Total cores.
    UsedMemoryGb float64
    Used memory. Unit: GiB.
    UsedStorageGb float64
    Storage space used by this node. Unit: GiB.
    UsedvCpu float64
    Used cores.
    ZoneId string
    Availability zone ID of the current node.
    nodeDelayTime Integer
    Node latency. Unit: seconds.
    nodeId String
    Node ID.
    nodeRole String
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status.
    totalMemoryGb Double
    Total memory. Unit: GiB.
    totalStorageGb Double
    Total storage space for this node. Unit: GiB.
    totalvCpu Double
    Total cores.
    usedMemoryGb Double
    Used memory. Unit: GiB.
    usedStorageGb Double
    Storage space used by this node. Unit: GiB.
    usedvCpu Double
    Used cores.
    zoneId String
    Availability zone ID of the current node.
    nodeDelayTime number
    Node latency. Unit: seconds.
    nodeId string
    Node ID.
    nodeRole string
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    nodeSpec string
    Node specification.
    nodeStatus string
    Node status.
    totalMemoryGb number
    Total memory. Unit: GiB.
    totalStorageGb number
    Total storage space for this node. Unit: GiB.
    totalvCpu number
    Total cores.
    usedMemoryGb number
    Used memory. Unit: GiB.
    usedStorageGb number
    Storage space used by this node. Unit: GiB.
    usedvCpu number
    Used cores.
    zoneId string
    Availability zone ID of the current node.
    node_delay_time int
    Node latency. Unit: seconds.
    node_id str
    Node ID.
    node_role str
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    node_spec str
    Node specification.
    node_status str
    Node status.
    total_memory_gb float
    Total memory. Unit: GiB.
    total_storage_gb float
    Total storage space for this node. Unit: GiB.
    totalv_cpu float
    Total cores.
    used_memory_gb float
    Used memory. Unit: GiB.
    used_storage_gb float
    Storage space used by this node. Unit: GiB.
    usedv_cpu float
    Used cores.
    zone_id str
    Availability zone ID of the current node.
    nodeDelayTime Number
    Node latency. Unit: seconds.
    nodeId String
    Node ID.
    nodeRole String
    Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
    nodeSpec String
    Node specification.
    nodeStatus String
    Node status.
    totalMemoryGb Number
    Total memory. Unit: GiB.
    totalStorageGb Number
    Total storage space for this node. Unit: GiB.
    totalvCpu Number
    Total cores.
    usedMemoryGb Number
    Used memory. Unit: GiB.
    usedStorageGb Number
    Storage space used by this node. Unit: GiB.
    usedvCpu Number
    Used cores.
    zoneId String
    Availability zone ID of the current node.

    InstanceTag, InstanceTagArgs

    Key string
    Tag key
    Value string
    Tag value.
    Key string
    Tag key
    Value string
    Tag value.
    key String
    Tag key
    value String
    Tag value.
    key string
    Tag key
    value string
    Tag value.
    key str
    Tag key
    value str
    Tag value.
    key String
    Tag key
    value String
    Tag value.

    Import

    $ pulumi import bytepluscc:mongodb/instance:Instance example "instance_id"

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

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.