tencentcloud 1.81.189, Apr 30 25

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.MongodbInstance

Explore with Pulumi AI

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

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

const mongodb = new tencentcloud.MongodbInstance("mongodb", {
    availableZone: "ap-guangzhou-2",
    engineVersion: "MONGO_36_WT",
    instanceName: "mongodb",
    machineType: "HIO10G",
    memory: 4,
    password: "password1234",
    projectId: 0,
    subnetId: "subnet-xxxxxx",
    volume: 100,
    vpcId: "vpc-xxxxxx",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

mongodb = tencentcloud.MongodbInstance("mongodb",
    available_zone="ap-guangzhou-2",
    engine_version="MONGO_36_WT",
    instance_name="mongodb",
    machine_type="HIO10G",
    memory=4,
    password="password1234",
    project_id=0,
    subnet_id="subnet-xxxxxx",
    volume=100,
    vpc_id="vpc-xxxxxx")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewMongodbInstance(ctx, "mongodb", &tencentcloud.MongodbInstanceArgs{
			AvailableZone: pulumi.String("ap-guangzhou-2"),
			EngineVersion: pulumi.String("MONGO_36_WT"),
			InstanceName:  pulumi.String("mongodb"),
			MachineType:   pulumi.String("HIO10G"),
			Memory:        pulumi.Float64(4),
			Password:      pulumi.String("password1234"),
			ProjectId:     pulumi.Float64(0),
			SubnetId:      pulumi.String("subnet-xxxxxx"),
			Volume:        pulumi.Float64(100),
			VpcId:         pulumi.String("vpc-xxxxxx"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var mongodb = new Tencentcloud.MongodbInstance("mongodb", new()
    {
        AvailableZone = "ap-guangzhou-2",
        EngineVersion = "MONGO_36_WT",
        InstanceName = "mongodb",
        MachineType = "HIO10G",
        Memory = 4,
        Password = "password1234",
        ProjectId = 0,
        SubnetId = "subnet-xxxxxx",
        Volume = 100,
        VpcId = "vpc-xxxxxx",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.MongodbInstance;
import com.pulumi.tencentcloud.MongodbInstanceArgs;
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 mongodb = new MongodbInstance("mongodb", MongodbInstanceArgs.builder()
            .availableZone("ap-guangzhou-2")
            .engineVersion("MONGO_36_WT")
            .instanceName("mongodb")
            .machineType("HIO10G")
            .memory(4)
            .password("password1234")
            .projectId(0)
            .subnetId("subnet-xxxxxx")
            .volume(100)
            .vpcId("vpc-xxxxxx")
            .build());

    }
}

resources:
  mongodb:
    type: tencentcloud:MongodbInstance
    properties:
      availableZone: ap-guangzhou-2
      engineVersion: MONGO_36_WT
      instanceName: mongodb
      machineType: HIO10G
      memory: 4
      password: password1234
      projectId: 0
      subnetId: subnet-xxxxxx
      volume: 100
      vpcId: vpc-xxxxxx

Create MongodbInstance Resource

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

Constructor syntax

new MongodbInstance(name: string, args: MongodbInstanceArgs, opts?: CustomResourceOptions);

@overload
def MongodbInstance(resource_name: str,
                    args: MongodbInstanceArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def MongodbInstance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    instance_name: Optional[str] = None,
                    volume: Optional[float] = None,
                    memory: Optional[float] = None,
                    available_zone: Optional[str] = None,
                    machine_type: Optional[str] = None,
                    engine_version: Optional[str] = None,
                    hidden_zone: Optional[str] = None,
                    password: Optional[str] = None,
                    add_node_lists: Optional[Sequence[MongodbInstanceAddNodeListArgs]] = None,
                    charge_type: Optional[str] = None,
                    maintenance_end: Optional[str] = None,
                    maintenance_start: Optional[str] = None,
                    availability_zone_lists: Optional[Sequence[str]] = None,
                    mongodb_instance_id: Optional[str] = None,
                    node_num: Optional[float] = None,
                    in_maintenance: Optional[float] = None,
                    prepaid_period: Optional[float] = None,
                    project_id: Optional[float] = None,
                    remove_node_lists: Optional[Sequence[MongodbInstanceRemoveNodeListArgs]] = None,
                    security_groups: Optional[Sequence[str]] = None,
                    subnet_id: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    auto_renew_flag: Optional[float] = None,
                    vpc_id: Optional[str] = None)

func NewMongodbInstance(ctx *Context, name string, args MongodbInstanceArgs, opts ...ResourceOption) (*MongodbInstance, error)

public MongodbInstance(string name, MongodbInstanceArgs args, CustomResourceOptions? opts = null)

public MongodbInstance(String name, MongodbInstanceArgs args)
public MongodbInstance(String name, MongodbInstanceArgs args, CustomResourceOptions options)

type: tencentcloud:MongodbInstance
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 MongodbInstanceArgs: 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 MongodbInstanceArgs: 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 MongodbInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MongodbInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MongodbInstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

MongodbInstance 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 MongodbInstance resource accepts the following input properties:

AvailableZone string

The available zone of the Mongodb.

EngineVersion string

Version of the Mongodb, and available values include MONGO_36_WT (MongoDB 3.6 WiredTiger Edition), MONGO_40_WT (MongoDB 4.0 WiredTiger Edition) and MONGO_42_WT (MongoDB 4.2 WiredTiger Edition). NOTE: MONGO_3_WT (MongoDB 3.2 WiredTiger Edition) and MONGO_3_ROCKS (MongoDB 3.2 RocksDB Edition) will deprecated.

InstanceName string

Name of the Mongodb instance.

MachineType string

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

Memory double

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

Volume double

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

AddNodeLists List<MongodbInstanceAddNodeList>

Add node attribute list.

AutoRenewFlag double

Auto renew flag. Valid values are 0(NOTIFY_AND_MANUAL_RENEW), 1(NOTIFY_AND_AUTO_RENEW) and 2(DISABLE_NOTIFY_AND_MANUAL_RENEW). Default value is 0. Note: only works for PREPAID instance. Only supports0 and 1 for creation.

AvailabilityZoneLists List<string>

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

ChargeType string

The charge type of instance. Valid values are PREPAID and POSTPAID_BY_HOUR. Default value is POSTPAID_BY_HOUR. Note: TencentCloud International only supports POSTPAID_BY_HOUR. Caution that update operation on this field will delete old instances and create new one with new charge type.

HiddenZone string

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

InMaintenance double

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

MaintenanceEnd string

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

MaintenanceStart string

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

MongodbInstanceId string

ID of the resource.

NodeNum double

The number of nodes in each replica set. Default value: 3.

Password string

Password of this Mongodb account.

PrepaidPeriod double

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

ProjectId double

ID of the project which the instance belongs.

RemoveNodeLists List<MongodbInstanceRemoveNodeList>

Add node attribute list.

SecurityGroups List<string>

ID of the security group.

SubnetId string

ID of the subnet within this VPC. The value is required if vpc_id is set.

Tags Dictionary<string, string>

The tags of the Mongodb. Key name project is system reserved and can't be used.

VpcId string

ID of the VPC.

AvailableZone string

The available zone of the Mongodb.

EngineVersion string

InstanceName string

Name of the Mongodb instance.

MachineType string

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

Memory float64

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

Volume float64

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

AddNodeLists []MongodbInstanceAddNodeListArgs

Add node attribute list.

AutoRenewFlag float64

AvailabilityZoneLists []string

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

ChargeType string

HiddenZone string

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

InMaintenance float64

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

MaintenanceEnd string

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

MaintenanceStart string

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

MongodbInstanceId string

ID of the resource.

NodeNum float64

The number of nodes in each replica set. Default value: 3.

Password string

Password of this Mongodb account.

PrepaidPeriod float64

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

ProjectId float64

ID of the project which the instance belongs.

RemoveNodeLists []MongodbInstanceRemoveNodeListArgs

Add node attribute list.

SecurityGroups []string

ID of the security group.

SubnetId string

ID of the subnet within this VPC. The value is required if vpc_id is set.

Tags map[string]string

The tags of the Mongodb. Key name project is system reserved and can't be used.

VpcId string

ID of the VPC.

availableZone String

The available zone of the Mongodb.

engineVersion String

instanceName String

Name of the Mongodb instance.

machineType String

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

memory Double

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

volume Double

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

addNodeLists List<MongodbInstanceAddNodeList>

Add node attribute list.

autoRenewFlag Double

availabilityZoneLists List<String>

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

chargeType String

hiddenZone String

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

inMaintenance Double

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

maintenanceEnd String

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenanceStart String

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

mongodbInstanceId String

ID of the resource.

nodeNum Double

The number of nodes in each replica set. Default value: 3.

password String

Password of this Mongodb account.

prepaidPeriod Double

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

projectId Double

ID of the project which the instance belongs.

removeNodeLists List<MongodbInstanceRemoveNodeList>

Add node attribute list.

securityGroups List<String>

ID of the security group.

subnetId String

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags Map<String,String>

The tags of the Mongodb. Key name project is system reserved and can't be used.

vpcId String

ID of the VPC.

availableZone string

The available zone of the Mongodb.

engineVersion string

instanceName string

Name of the Mongodb instance.

machineType string

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

memory number

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

volume number

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

addNodeLists MongodbInstanceAddNodeList[]

Add node attribute list.

autoRenewFlag number

availabilityZoneLists string[]

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

chargeType string

hiddenZone string

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

inMaintenance number

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

maintenanceEnd string

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenanceStart string

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

mongodbInstanceId string

ID of the resource.

nodeNum number

The number of nodes in each replica set. Default value: 3.

password string

Password of this Mongodb account.

prepaidPeriod number

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

projectId number

ID of the project which the instance belongs.

removeNodeLists MongodbInstanceRemoveNodeList[]

Add node attribute list.

securityGroups string[]

ID of the security group.

subnetId string

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags {[key: string]: string}

The tags of the Mongodb. Key name project is system reserved and can't be used.

vpcId string

ID of the VPC.

available_zone str

The available zone of the Mongodb.

engine_version str

instance_name str

Name of the Mongodb instance.

machine_type str

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

memory float

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

volume float

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

add_node_lists Sequence[MongodbInstanceAddNodeListArgs]

Add node attribute list.

auto_renew_flag float

availability_zone_lists Sequence[str]

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

charge_type str

hidden_zone str

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

in_maintenance float

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

maintenance_end str

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenance_start str

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

mongodb_instance_id str

ID of the resource.

node_num float

The number of nodes in each replica set. Default value: 3.

password str

Password of this Mongodb account.

prepaid_period float

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

project_id float

ID of the project which the instance belongs.

remove_node_lists Sequence[MongodbInstanceRemoveNodeListArgs]

Add node attribute list.

security_groups Sequence[str]

ID of the security group.

subnet_id str

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags Mapping[str, str]

The tags of the Mongodb. Key name project is system reserved and can't be used.

vpc_id str

ID of the VPC.

availableZone String

The available zone of the Mongodb.

engineVersion String

instanceName String

Name of the Mongodb instance.

machineType String

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

memory Number

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

volume Number

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

addNodeLists List<Property Map>

Add node attribute list.

autoRenewFlag Number

availabilityZoneLists List<String>

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

chargeType String

hiddenZone String

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

inMaintenance Number

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

maintenanceEnd String

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenanceStart String

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

mongodbInstanceId String

ID of the resource.

nodeNum Number

The number of nodes in each replica set. Default value: 3.

password String

Password of this Mongodb account.

prepaidPeriod Number

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

projectId Number

ID of the project which the instance belongs.

removeNodeLists List<Property Map>

Add node attribute list.

securityGroups List<String>

ID of the security group.

subnetId String

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags Map<String>

The tags of the Mongodb. Key name project is system reserved and can't be used.

vpcId String

ID of the VPC.

Outputs

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

CreateTime string: Creation time of the Mongodb instance.
Id string: The provider-assigned unique ID for this managed resource.
StandbyInstanceLists List<MongodbInstanceStandbyInstanceList>: List of standby instances' info.
Status double: Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
Vip string: IP of the Mongodb instance.
Vport double: IP port of the Mongodb instance.

CreateTime string: Creation time of the Mongodb instance.
Id string: The provider-assigned unique ID for this managed resource.
StandbyInstanceLists []MongodbInstanceStandbyInstanceList: List of standby instances' info.
Status float64: Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
Vip string: IP of the Mongodb instance.
Vport float64: IP port of the Mongodb instance.

createTime String: Creation time of the Mongodb instance.
id String: The provider-assigned unique ID for this managed resource.
standbyInstanceLists List<MongodbInstanceStandbyInstanceList>: List of standby instances' info.
status Double: Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
vip String: IP of the Mongodb instance.
vport Double: IP port of the Mongodb instance.

createTime string: Creation time of the Mongodb instance.
id string: The provider-assigned unique ID for this managed resource.
standbyInstanceLists MongodbInstanceStandbyInstanceList[]: List of standby instances' info.
status number: Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
vip string: IP of the Mongodb instance.
vport number: IP port of the Mongodb instance.

create_time str: Creation time of the Mongodb instance.
id str: The provider-assigned unique ID for this managed resource.
standby_instance_lists Sequence[MongodbInstanceStandbyInstanceList]: List of standby instances' info.
status float: Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
vip str: IP of the Mongodb instance.
vport float: IP port of the Mongodb instance.

createTime String: Creation time of the Mongodb instance.
id String: The provider-assigned unique ID for this managed resource.
standbyInstanceLists List<Property Map>: List of standby instances' info.
status Number: Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).
vip String: IP of the Mongodb instance.
vport Number: IP port of the Mongodb instance.

Look up Existing MongodbInstance Resource

Get an existing MongodbInstance 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?: MongodbInstanceState, opts?: CustomResourceOptions): MongodbInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        add_node_lists: Optional[Sequence[MongodbInstanceAddNodeListArgs]] = None,
        auto_renew_flag: Optional[float] = None,
        availability_zone_lists: Optional[Sequence[str]] = None,
        available_zone: Optional[str] = None,
        charge_type: Optional[str] = None,
        create_time: Optional[str] = None,
        engine_version: Optional[str] = None,
        hidden_zone: Optional[str] = None,
        in_maintenance: Optional[float] = None,
        instance_name: Optional[str] = None,
        machine_type: Optional[str] = None,
        maintenance_end: Optional[str] = None,
        maintenance_start: Optional[str] = None,
        memory: Optional[float] = None,
        mongodb_instance_id: Optional[str] = None,
        node_num: Optional[float] = None,
        password: Optional[str] = None,
        prepaid_period: Optional[float] = None,
        project_id: Optional[float] = None,
        remove_node_lists: Optional[Sequence[MongodbInstanceRemoveNodeListArgs]] = None,
        security_groups: Optional[Sequence[str]] = None,
        standby_instance_lists: Optional[Sequence[MongodbInstanceStandbyInstanceListArgs]] = None,
        status: Optional[float] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        vip: Optional[str] = None,
        volume: Optional[float] = None,
        vpc_id: Optional[str] = None,
        vport: Optional[float] = None) -> MongodbInstance

func GetMongodbInstance(ctx *Context, name string, id IDInput, state *MongodbInstanceState, opts ...ResourceOption) (*MongodbInstance, error)

public static MongodbInstance Get(string name, Input<string> id, MongodbInstanceState? state, CustomResourceOptions? opts = null)

public static MongodbInstance get(String name, Output<String> id, MongodbInstanceState state, CustomResourceOptions options)

resources:  _:    type: tencentcloud:MongodbInstance    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:

AddNodeLists List<MongodbInstanceAddNodeList>

Add node attribute list.

AutoRenewFlag double

AvailabilityZoneLists List<string>

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

AvailableZone string

The available zone of the Mongodb.

ChargeType string

CreateTime string

Creation time of the Mongodb instance.

EngineVersion string

HiddenZone string

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

InMaintenance double

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

InstanceName string

Name of the Mongodb instance.

MachineType string

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

MaintenanceEnd string

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

MaintenanceStart string

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

Memory double

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

MongodbInstanceId string

ID of the resource.

NodeNum double

The number of nodes in each replica set. Default value: 3.

Password string

Password of this Mongodb account.

PrepaidPeriod double

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

ProjectId double

ID of the project which the instance belongs.

RemoveNodeLists List<MongodbInstanceRemoveNodeList>

Add node attribute list.

SecurityGroups List<string>

ID of the security group.

StandbyInstanceLists List<MongodbInstanceStandbyInstanceList>

List of standby instances' info.

Status double

Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).

SubnetId string

ID of the subnet within this VPC. The value is required if vpc_id is set.

Tags Dictionary<string, string>

The tags of the Mongodb. Key name project is system reserved and can't be used.

Vip string

IP of the Mongodb instance.

Volume double

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

VpcId string

ID of the VPC.

Vport double

IP port of the Mongodb instance.

AddNodeLists []MongodbInstanceAddNodeListArgs

Add node attribute list.

AutoRenewFlag float64

AvailabilityZoneLists []string

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

AvailableZone string

The available zone of the Mongodb.

ChargeType string

CreateTime string

Creation time of the Mongodb instance.

EngineVersion string

HiddenZone string

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

InMaintenance float64

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

InstanceName string

Name of the Mongodb instance.

MachineType string

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

MaintenanceEnd string

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

MaintenanceStart string

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

Memory float64

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

MongodbInstanceId string

ID of the resource.

NodeNum float64

The number of nodes in each replica set. Default value: 3.

Password string

Password of this Mongodb account.

PrepaidPeriod float64

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

ProjectId float64

ID of the project which the instance belongs.

RemoveNodeLists []MongodbInstanceRemoveNodeListArgs

Add node attribute list.

SecurityGroups []string

ID of the security group.

StandbyInstanceLists []MongodbInstanceStandbyInstanceListArgs

List of standby instances' info.

Status float64

Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).

SubnetId string

ID of the subnet within this VPC. The value is required if vpc_id is set.

Tags map[string]string

The tags of the Mongodb. Key name project is system reserved and can't be used.

Vip string

IP of the Mongodb instance.

Volume float64

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

VpcId string

ID of the VPC.

Vport float64

IP port of the Mongodb instance.

addNodeLists List<MongodbInstanceAddNodeList>

Add node attribute list.

autoRenewFlag Double

availabilityZoneLists List<String>

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

availableZone String

The available zone of the Mongodb.

chargeType String

createTime String

Creation time of the Mongodb instance.

engineVersion String

hiddenZone String

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

inMaintenance Double

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

instanceName String

Name of the Mongodb instance.

machineType String

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

maintenanceEnd String

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenanceStart String

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

memory Double

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

mongodbInstanceId String

ID of the resource.

nodeNum Double

The number of nodes in each replica set. Default value: 3.

password String

Password of this Mongodb account.

prepaidPeriod Double

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

projectId Double

ID of the project which the instance belongs.

removeNodeLists List<MongodbInstanceRemoveNodeList>

Add node attribute list.

securityGroups List<String>

ID of the security group.

standbyInstanceLists List<MongodbInstanceStandbyInstanceList>

List of standby instances' info.

status Double

Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).

subnetId String

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags Map<String,String>

The tags of the Mongodb. Key name project is system reserved and can't be used.

vip String

IP of the Mongodb instance.

volume Double

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

vpcId String

ID of the VPC.

vport Double

IP port of the Mongodb instance.

addNodeLists MongodbInstanceAddNodeList[]

Add node attribute list.

autoRenewFlag number

availabilityZoneLists string[]

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

availableZone string

The available zone of the Mongodb.

chargeType string

createTime string

Creation time of the Mongodb instance.

engineVersion string

hiddenZone string

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

inMaintenance number

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

instanceName string

Name of the Mongodb instance.

machineType string

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

maintenanceEnd string

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenanceStart string

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

memory number

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

mongodbInstanceId string

ID of the resource.

nodeNum number

The number of nodes in each replica set. Default value: 3.

password string

Password of this Mongodb account.

prepaidPeriod number

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

projectId number

ID of the project which the instance belongs.

removeNodeLists MongodbInstanceRemoveNodeList[]

Add node attribute list.

securityGroups string[]

ID of the security group.

standbyInstanceLists MongodbInstanceStandbyInstanceList[]

List of standby instances' info.

status number

Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).

subnetId string

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags {[key: string]: string}

The tags of the Mongodb. Key name project is system reserved and can't be used.

vip string

IP of the Mongodb instance.

volume number

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

vpcId string

ID of the VPC.

vport number

IP port of the Mongodb instance.

add_node_lists Sequence[MongodbInstanceAddNodeListArgs]

Add node attribute list.

auto_renew_flag float

availability_zone_lists Sequence[str]

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

available_zone str

The available zone of the Mongodb.

charge_type str

create_time str

Creation time of the Mongodb instance.

engine_version str

hidden_zone str

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

in_maintenance float

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

instance_name str

Name of the Mongodb instance.

machine_type str

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

maintenance_end str

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenance_start str

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

memory float

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

mongodb_instance_id str

ID of the resource.

node_num float

The number of nodes in each replica set. Default value: 3.

password str

Password of this Mongodb account.

prepaid_period float

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

project_id float

ID of the project which the instance belongs.

remove_node_lists Sequence[MongodbInstanceRemoveNodeListArgs]

Add node attribute list.

security_groups Sequence[str]

ID of the security group.

standby_instance_lists Sequence[MongodbInstanceStandbyInstanceListArgs]

List of standby instances' info.

status float

Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).

subnet_id str

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags Mapping[str, str]

The tags of the Mongodb. Key name project is system reserved and can't be used.

vip str

IP of the Mongodb instance.

volume float

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

vpc_id str

ID of the VPC.

vport float

IP port of the Mongodb instance.

addNodeLists List<Property Map>

Add node attribute list.

autoRenewFlag Number

availabilityZoneLists List<String>

If cloud database instances are deployed in multiple availability zones, specify a list of multiple availability zones.

To deploy an instance with multiple availability zones, the parameter Zone specifies the primary availability zone information of the instance; Availability ZoneList specifies all availability zone information, including the primary availability zone. The input format is as follows: [ap-Guangzhou-2,ap-Guangzhou-3,ap-Guangzhou-4].
You can obtain availability zone information planned in different regions of the cloud database through the interface DescribeSpecInfo, so as to specify effective availability zones.
Multiple availability zone deployment nodes can only be deployed in 3 different availability zones. Deploying most nodes of a cluster in the same availability zone is not supported. For example, a 3-node cluster does not support 2 nodes deployed in the same zone.

availableZone String

The available zone of the Mongodb.

chargeType String

createTime String

Creation time of the Mongodb instance.

engineVersion String

hiddenZone String

The availability zone to which the Hidden node belongs. This parameter is required in cross-AZ instance deployment.

inMaintenance Number

Switch time for instance configuration changes.

0: When the adjustment is completed, perform the configuration task immediately. Default is 0.
1: Perform reconfiguration tasks within the maintenance time window. Note: Adjusting the number of nodes and slices does not support changes within the maintenance window.

instanceName String

Name of the Mongodb instance.

machineType String

Type of Mongodb instance, and available values include HIO(or GIO which will be deprecated, represents high IO) and HIO10G(or TGIO which will be deprecated, represents 10-gigabit high IO).

maintenanceEnd String

Maintenance window end time.

The value range is any full point or half point from 00:00-23:00, and the maintenance time duration is at least 30 minutes and at most 3 hours.
The end time must be based on the start time backwards.

maintenanceStart String

Maintenance window start time. The value range is any full point or half point from 00:00-23:00, such as 00:00 or 00:30.

memory Number

Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

mongodbInstanceId String

ID of the resource.

nodeNum Number

The number of nodes in each replica set. Default value: 3.

password String

Password of this Mongodb account.

prepaidPeriod Number

The tenancy (time unit is month) of the prepaid instance. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36. NOTE: it only works when charge_type is set to PREPAID.

projectId Number

ID of the project which the instance belongs.

removeNodeLists List<Property Map>

Add node attribute list.

securityGroups List<String>

ID of the security group.

standbyInstanceLists List<Property Map>

List of standby instances' info.

status Number

Status of the Mongodb instance, and available values include pending initialization(expressed with 0), processing(expressed with 1), running(expressed with 2) and expired(expressed with -2).

subnetId String

ID of the subnet within this VPC. The value is required if vpc_id is set.

tags Map<String>

The tags of the Mongodb. Key name project is system reserved and can't be used.

vip String

IP of the Mongodb instance.

volume Number

Disk size. The minimum value is 25, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.

vpcId String

ID of the VPC.

vport Number

IP port of the Mongodb instance.

Supporting Types

MongodbInstanceAddNodeList, MongodbInstanceAddNodeListArgs

Role string

The node role that needs to be added.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

Zone string

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

Role string

The node role that needs to be added.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

Zone string

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

role String

The node role that needs to be added.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone String

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

role string

The node role that needs to be added.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone string

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

role str

The node role that needs to be added.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone str

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

role String

The node role that needs to be added.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone String

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

MongodbInstanceRemoveNodeList, MongodbInstanceRemoveNodeListArgs

NodeName string

The node ID to delete. The shard cluster must specify the name of the node to be deleted by a group of shards, and the rest of the shards should be grouped and aligned.

Role string

The node role that needs to be deleted.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

Zone string

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

NodeName string

The node ID to delete. The shard cluster must specify the name of the node to be deleted by a group of shards, and the rest of the shards should be grouped and aligned.

Role string

The node role that needs to be deleted.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

Zone string

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

nodeName String

The node ID to delete. The shard cluster must specify the name of the node to be deleted by a group of shards, and the rest of the shards should be grouped and aligned.

role String

The node role that needs to be deleted.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone String

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

nodeName string

The node ID to delete. The shard cluster must specify the name of the node to be deleted by a group of shards, and the rest of the shards should be grouped and aligned.

role string

The node role that needs to be deleted.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone string

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

node_name str

The node ID to delete. The shard cluster must specify the name of the node to be deleted by a group of shards, and the rest of the shards should be grouped and aligned.

role str

The node role that needs to be deleted.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone str

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

nodeName String

The node ID to delete. The shard cluster must specify the name of the node to be deleted by a group of shards, and the rest of the shards should be grouped and aligned.

role String

The node role that needs to be deleted.

SECONDARY: Mongod node;
READONLY: read-only node;
MONGOS: Mongos node.

zone String

The availability zone corresponding to the node.

single availability zone, where all nodes are in the same availability zone;
multiple availability zones: the current standard specification is the distribution of three availability zones, and the master and slave nodes are not in the same availability zone. You should pay attention to configuring the availability zone corresponding to the new node, and the rule that the number of nodes in any two availability zones is greater than the third availability zone must be met after the addition.

MongodbInstanceStandbyInstanceList, MongodbInstanceStandbyInstanceListArgs

StandbyInstanceId string: Indicates the ID of standby instance.
StandbyInstanceRegion string: Indicates the region of standby instance.

StandbyInstanceId string: Indicates the ID of standby instance.
StandbyInstanceRegion string: Indicates the region of standby instance.

standbyInstanceId String: Indicates the ID of standby instance.
standbyInstanceRegion String: Indicates the region of standby instance.

standbyInstanceId string: Indicates the ID of standby instance.
standbyInstanceRegion string: Indicates the region of standby instance.

standby_instance_id str: Indicates the ID of standby instance.
standby_instance_region str: Indicates the region of standby instance.

standbyInstanceId String: Indicates the ID of standby instance.
standbyInstanceRegion String: Indicates the region of standby instance.

Import

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

$ pulumi import tencentcloud:index/mongodbInstance:MongodbInstance mongodb cmgo-41s6jwy4

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

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.MongodbInstance

On this page

On this page

Example Usage

Create MongodbInstance Resource

Constructor syntax

Parameters

MongodbInstance Resource Properties

Inputs

Outputs

Look up Existing MongodbInstance Resource

Supporting Types

MongodbInstanceAddNodeList, MongodbInstanceAddNodeListArgs

MongodbInstanceRemoveNodeList, MongodbInstanceRemoveNodeListArgs

MongodbInstanceStandbyInstanceList, MongodbInstanceStandbyInstanceListArgs

Import

Package Details

On this page

On this page