1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. MongodbReadonlyInstance
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.MongodbReadonlyInstance

Explore with Pulumi AI

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

    Provide a resource to create a Readonly mongodb instance.

    Example Usage

    Replset readonly instance

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const mongodb = new tencentcloud.MongodbReadonlyInstance("mongodb", {
        availableZone: "ap-guangzhou-3",
        clusterType: "REPLSET",
        engineVersion: "MONGO_44_WT",
        fatherInstanceId: "cmgo-xxxxxx",
        fatherInstanceRegion: "ap-guangzhou",
        instanceName: "tf-mongodb-readonly-test",
        machineType: "HIO10G",
        memory: 4,
        projectId: 0,
        securityGroups: ["sg-xxxxxx"],
        subnetId: "subnet-xxxxxx",
        volume: 100,
        vpcId: "vpc-xxxxxx",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    mongodb = tencentcloud.MongodbReadonlyInstance("mongodb",
        available_zone="ap-guangzhou-3",
        cluster_type="REPLSET",
        engine_version="MONGO_44_WT",
        father_instance_id="cmgo-xxxxxx",
        father_instance_region="ap-guangzhou",
        instance_name="tf-mongodb-readonly-test",
        machine_type="HIO10G",
        memory=4,
        project_id=0,
        security_groups=["sg-xxxxxx"],
        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.NewMongodbReadonlyInstance(ctx, "mongodb", &tencentcloud.MongodbReadonlyInstanceArgs{
    			AvailableZone:        pulumi.String("ap-guangzhou-3"),
    			ClusterType:          pulumi.String("REPLSET"),
    			EngineVersion:        pulumi.String("MONGO_44_WT"),
    			FatherInstanceId:     pulumi.String("cmgo-xxxxxx"),
    			FatherInstanceRegion: pulumi.String("ap-guangzhou"),
    			InstanceName:         pulumi.String("tf-mongodb-readonly-test"),
    			MachineType:          pulumi.String("HIO10G"),
    			Memory:               pulumi.Float64(4),
    			ProjectId:            pulumi.Float64(0),
    			SecurityGroups: pulumi.StringArray{
    				pulumi.String("sg-xxxxxx"),
    			},
    			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.MongodbReadonlyInstance("mongodb", new()
        {
            AvailableZone = "ap-guangzhou-3",
            ClusterType = "REPLSET",
            EngineVersion = "MONGO_44_WT",
            FatherInstanceId = "cmgo-xxxxxx",
            FatherInstanceRegion = "ap-guangzhou",
            InstanceName = "tf-mongodb-readonly-test",
            MachineType = "HIO10G",
            Memory = 4,
            ProjectId = 0,
            SecurityGroups = new[]
            {
                "sg-xxxxxx",
            },
            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.MongodbReadonlyInstance;
    import com.pulumi.tencentcloud.MongodbReadonlyInstanceArgs;
    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 MongodbReadonlyInstance("mongodb", MongodbReadonlyInstanceArgs.builder()
                .availableZone("ap-guangzhou-3")
                .clusterType("REPLSET")
                .engineVersion("MONGO_44_WT")
                .fatherInstanceId("cmgo-xxxxxx")
                .fatherInstanceRegion("ap-guangzhou")
                .instanceName("tf-mongodb-readonly-test")
                .machineType("HIO10G")
                .memory(4)
                .projectId(0)
                .securityGroups("sg-xxxxxx")
                .subnetId("subnet-xxxxxx")
                .volume(100)
                .vpcId("vpc-xxxxxx")
                .build());
    
        }
    }
    
    resources:
      mongodb:
        type: tencentcloud:MongodbReadonlyInstance
        properties:
          availableZone: ap-guangzhou-3
          clusterType: REPLSET
          engineVersion: MONGO_44_WT
          fatherInstanceId: cmgo-xxxxxx
          fatherInstanceRegion: ap-guangzhou
          instanceName: tf-mongodb-readonly-test
          machineType: HIO10G
          memory: 4
          projectId: 0
          securityGroups:
            - sg-xxxxxx
          subnetId: subnet-xxxxxx
          volume: 100
          vpcId: vpc-xxxxxx
    

    Shard readonly instance

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const shardingMongodb = new tencentcloud.MongodbReadonlyInstance("shardingMongodb", {
        availableZone: "ap-guangzhou-3",
        clusterType: "SHARD",
        engineVersion: "MONGO_44_WT",
        fatherInstanceId: "cmgo-xxxxxx",
        fatherInstanceRegion: "ap-guangzhou",
        instanceName: "tf-mongodb-readonly-shard",
        machineType: "HIO10G",
        memory: 4,
        mongosCpu: 1,
        mongosMemory: 2,
        mongosNodeNum: 3,
        projectId: 0,
        securityGroups: ["sg-xxxxxx"],
        subnetId: "subnet-xxxxxx",
        volume: 100,
        vpcId: "vpc-xxxxxx",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    sharding_mongodb = tencentcloud.MongodbReadonlyInstance("shardingMongodb",
        available_zone="ap-guangzhou-3",
        cluster_type="SHARD",
        engine_version="MONGO_44_WT",
        father_instance_id="cmgo-xxxxxx",
        father_instance_region="ap-guangzhou",
        instance_name="tf-mongodb-readonly-shard",
        machine_type="HIO10G",
        memory=4,
        mongos_cpu=1,
        mongos_memory=2,
        mongos_node_num=3,
        project_id=0,
        security_groups=["sg-xxxxxx"],
        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.NewMongodbReadonlyInstance(ctx, "shardingMongodb", &tencentcloud.MongodbReadonlyInstanceArgs{
    			AvailableZone:        pulumi.String("ap-guangzhou-3"),
    			ClusterType:          pulumi.String("SHARD"),
    			EngineVersion:        pulumi.String("MONGO_44_WT"),
    			FatherInstanceId:     pulumi.String("cmgo-xxxxxx"),
    			FatherInstanceRegion: pulumi.String("ap-guangzhou"),
    			InstanceName:         pulumi.String("tf-mongodb-readonly-shard"),
    			MachineType:          pulumi.String("HIO10G"),
    			Memory:               pulumi.Float64(4),
    			MongosCpu:            pulumi.Float64(1),
    			MongosMemory:         pulumi.Float64(2),
    			MongosNodeNum:        pulumi.Float64(3),
    			ProjectId:            pulumi.Float64(0),
    			SecurityGroups: pulumi.StringArray{
    				pulumi.String("sg-xxxxxx"),
    			},
    			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 shardingMongodb = new Tencentcloud.MongodbReadonlyInstance("shardingMongodb", new()
        {
            AvailableZone = "ap-guangzhou-3",
            ClusterType = "SHARD",
            EngineVersion = "MONGO_44_WT",
            FatherInstanceId = "cmgo-xxxxxx",
            FatherInstanceRegion = "ap-guangzhou",
            InstanceName = "tf-mongodb-readonly-shard",
            MachineType = "HIO10G",
            Memory = 4,
            MongosCpu = 1,
            MongosMemory = 2,
            MongosNodeNum = 3,
            ProjectId = 0,
            SecurityGroups = new[]
            {
                "sg-xxxxxx",
            },
            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.MongodbReadonlyInstance;
    import com.pulumi.tencentcloud.MongodbReadonlyInstanceArgs;
    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 shardingMongodb = new MongodbReadonlyInstance("shardingMongodb", MongodbReadonlyInstanceArgs.builder()
                .availableZone("ap-guangzhou-3")
                .clusterType("SHARD")
                .engineVersion("MONGO_44_WT")
                .fatherInstanceId("cmgo-xxxxxx")
                .fatherInstanceRegion("ap-guangzhou")
                .instanceName("tf-mongodb-readonly-shard")
                .machineType("HIO10G")
                .memory(4)
                .mongosCpu(1)
                .mongosMemory(2)
                .mongosNodeNum(3)
                .projectId(0)
                .securityGroups("sg-xxxxxx")
                .subnetId("subnet-xxxxxx")
                .volume(100)
                .vpcId("vpc-xxxxxx")
                .build());
    
        }
    }
    
    resources:
      shardingMongodb:
        type: tencentcloud:MongodbReadonlyInstance
        properties:
          availableZone: ap-guangzhou-3
          clusterType: SHARD
          engineVersion: MONGO_44_WT
          fatherInstanceId: cmgo-xxxxxx
          fatherInstanceRegion: ap-guangzhou
          instanceName: tf-mongodb-readonly-shard
          machineType: HIO10G
          memory: 4
          mongosCpu: 1
          mongosMemory: 2
          mongosNodeNum: 3
          projectId: 0
          securityGroups:
            - sg-xxxxxx
          subnetId: subnet-xxxxxx
          volume: 100
          vpcId: vpc-xxxxxx
    

    Create MongodbReadonlyInstance Resource

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

    Constructor syntax

    new MongodbReadonlyInstance(name: string, args: MongodbReadonlyInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def MongodbReadonlyInstance(resource_name: str,
                                args: MongodbReadonlyInstanceArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def MongodbReadonlyInstance(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                machine_type: Optional[str] = None,
                                available_zone: Optional[str] = None,
                                volume: Optional[float] = None,
                                cluster_type: Optional[str] = None,
                                engine_version: Optional[str] = None,
                                father_instance_id: Optional[str] = None,
                                father_instance_region: Optional[str] = None,
                                memory: Optional[float] = None,
                                instance_name: Optional[str] = None,
                                mongos_cpu: Optional[float] = None,
                                nodes_per_shard: Optional[float] = None,
                                mongodb_readonly_instance_id: Optional[str] = None,
                                auto_renew_flag: Optional[float] = None,
                                mongos_memory: Optional[float] = None,
                                mongos_node_num: Optional[float] = None,
                                node_num: Optional[float] = None,
                                in_maintenance: Optional[float] = None,
                                prepaid_period: Optional[float] = None,
                                project_id: Optional[float] = None,
                                security_groups: Optional[Sequence[str]] = None,
                                shard_quantity: Optional[float] = None,
                                subnet_id: Optional[str] = None,
                                tags: Optional[Mapping[str, str]] = None,
                                charge_type: Optional[str] = None,
                                vpc_id: Optional[str] = None)
    func NewMongodbReadonlyInstance(ctx *Context, name string, args MongodbReadonlyInstanceArgs, opts ...ResourceOption) (*MongodbReadonlyInstance, error)
    public MongodbReadonlyInstance(string name, MongodbReadonlyInstanceArgs args, CustomResourceOptions? opts = null)
    public MongodbReadonlyInstance(String name, MongodbReadonlyInstanceArgs args)
    public MongodbReadonlyInstance(String name, MongodbReadonlyInstanceArgs args, CustomResourceOptions options)
    
    type: tencentcloud:MongodbReadonlyInstance
    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 MongodbReadonlyInstanceArgs
    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 MongodbReadonlyInstanceArgs
    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 MongodbReadonlyInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MongodbReadonlyInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MongodbReadonlyInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AvailableZone string
    The available zone of the Mongodb.
    ClusterType string
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    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.
    FatherInstanceId string
    Indicates the main instance ID of readonly instances.
    FatherInstanceRegion string
    Indicates the region of main instance.
    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.
    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.
    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.
    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.
    MongodbReadonlyInstanceId string
    ID of the resource.
    MongosCpu double
    Number of mongos cpu.
    MongosMemory double
    Mongos memory size in GB.
    MongosNodeNum double
    Number of mongos.
    NodeNum double
    The number of nodes in each replica set. Default value: 3.
    NodesPerShard double
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    SecurityGroups List<string>
    ID of the security group.
    ShardQuantity double
    Number of sharding.
    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.
    ClusterType string
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    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.
    FatherInstanceId string
    Indicates the main instance ID of readonly instances.
    FatherInstanceRegion string
    Indicates the region of main instance.
    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.
    AutoRenewFlag float64
    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.
    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.
    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.
    MongodbReadonlyInstanceId string
    ID of the resource.
    MongosCpu float64
    Number of mongos cpu.
    MongosMemory float64
    Mongos memory size in GB.
    MongosNodeNum float64
    Number of mongos.
    NodeNum float64
    The number of nodes in each replica set. Default value: 3.
    NodesPerShard float64
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    SecurityGroups []string
    ID of the security group.
    ShardQuantity float64
    Number of sharding.
    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.
    clusterType String
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    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.
    fatherInstanceId String
    Indicates the main instance ID of readonly instances.
    fatherInstanceRegion String
    Indicates the region of main instance.
    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.
    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.
    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.
    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.
    mongodbReadonlyInstanceId String
    ID of the resource.
    mongosCpu Double
    Number of mongos cpu.
    mongosMemory Double
    Mongos memory size in GB.
    mongosNodeNum Double
    Number of mongos.
    nodeNum Double
    The number of nodes in each replica set. Default value: 3.
    nodesPerShard Double
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    securityGroups List<String>
    ID of the security group.
    shardQuantity Double
    Number of sharding.
    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.
    clusterType string
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    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.
    fatherInstanceId string
    Indicates the main instance ID of readonly instances.
    fatherInstanceRegion string
    Indicates the region of main instance.
    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.
    autoRenewFlag number
    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.
    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.
    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.
    mongodbReadonlyInstanceId string
    ID of the resource.
    mongosCpu number
    Number of mongos cpu.
    mongosMemory number
    Mongos memory size in GB.
    mongosNodeNum number
    Number of mongos.
    nodeNum number
    The number of nodes in each replica set. Default value: 3.
    nodesPerShard number
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    securityGroups string[]
    ID of the security group.
    shardQuantity number
    Number of sharding.
    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.
    cluster_type str
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    engine_version str
    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.
    father_instance_id str
    Indicates the main instance ID of readonly instances.
    father_instance_region str
    Indicates the region of main instance.
    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.
    auto_renew_flag float
    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.
    charge_type str
    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.
    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.
    mongodb_readonly_instance_id str
    ID of the resource.
    mongos_cpu float
    Number of mongos cpu.
    mongos_memory float
    Mongos memory size in GB.
    mongos_node_num float
    Number of mongos.
    node_num float
    The number of nodes in each replica set. Default value: 3.
    nodes_per_shard float
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    security_groups Sequence[str]
    ID of the security group.
    shard_quantity float
    Number of sharding.
    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.
    clusterType String
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    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.
    fatherInstanceId String
    Indicates the main instance ID of readonly instances.
    fatherInstanceRegion String
    Indicates the region of main instance.
    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.
    autoRenewFlag Number
    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.
    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.
    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.
    mongodbReadonlyInstanceId String
    ID of the resource.
    mongosCpu Number
    Number of mongos cpu.
    mongosMemory Number
    Mongos memory size in GB.
    mongosNodeNum Number
    Number of mongos.
    nodeNum Number
    The number of nodes in each replica set. Default value: 3.
    nodesPerShard Number
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    securityGroups List<String>
    ID of the security group.
    shardQuantity Number
    Number of sharding.
    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 MongodbReadonlyInstance 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.
    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.
    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.
    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.
    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.
    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.
    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 MongodbReadonlyInstance Resource

    Get an existing MongodbReadonlyInstance 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?: MongodbReadonlyInstanceState, opts?: CustomResourceOptions): MongodbReadonlyInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_renew_flag: Optional[float] = None,
            available_zone: Optional[str] = None,
            charge_type: Optional[str] = None,
            cluster_type: Optional[str] = None,
            create_time: Optional[str] = None,
            engine_version: Optional[str] = None,
            father_instance_id: Optional[str] = None,
            father_instance_region: Optional[str] = None,
            in_maintenance: Optional[float] = None,
            instance_name: Optional[str] = None,
            machine_type: Optional[str] = None,
            memory: Optional[float] = None,
            mongodb_readonly_instance_id: Optional[str] = None,
            mongos_cpu: Optional[float] = None,
            mongos_memory: Optional[float] = None,
            mongos_node_num: Optional[float] = None,
            node_num: Optional[float] = None,
            nodes_per_shard: Optional[float] = None,
            prepaid_period: Optional[float] = None,
            project_id: Optional[float] = None,
            security_groups: Optional[Sequence[str]] = None,
            shard_quantity: Optional[float] = 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) -> MongodbReadonlyInstance
    func GetMongodbReadonlyInstance(ctx *Context, name string, id IDInput, state *MongodbReadonlyInstanceState, opts ...ResourceOption) (*MongodbReadonlyInstance, error)
    public static MongodbReadonlyInstance Get(string name, Input<string> id, MongodbReadonlyInstanceState? state, CustomResourceOptions? opts = null)
    public static MongodbReadonlyInstance get(String name, Output<String> id, MongodbReadonlyInstanceState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:MongodbReadonlyInstance    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:
    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.
    AvailableZone string
    The available zone of the Mongodb.
    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.
    ClusterType string
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    CreateTime string
    Creation time of the Mongodb instance.
    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.
    FatherInstanceId string
    Indicates the main instance ID of readonly instances.
    FatherInstanceRegion string
    Indicates the region of main instance.
    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).
    Memory double
    Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
    MongodbReadonlyInstanceId string
    ID of the resource.
    MongosCpu double
    Number of mongos cpu.
    MongosMemory double
    Mongos memory size in GB.
    MongosNodeNum double
    Number of mongos.
    NodeNum double
    The number of nodes in each replica set. Default value: 3.
    NodesPerShard double
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    SecurityGroups List<string>
    ID of the security group.
    ShardQuantity double
    Number of sharding.
    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.
    AutoRenewFlag float64
    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.
    AvailableZone string
    The available zone of the Mongodb.
    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.
    ClusterType string
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    CreateTime string
    Creation time of the Mongodb instance.
    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.
    FatherInstanceId string
    Indicates the main instance ID of readonly instances.
    FatherInstanceRegion string
    Indicates the region of main instance.
    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).
    Memory float64
    Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
    MongodbReadonlyInstanceId string
    ID of the resource.
    MongosCpu float64
    Number of mongos cpu.
    MongosMemory float64
    Mongos memory size in GB.
    MongosNodeNum float64
    Number of mongos.
    NodeNum float64
    The number of nodes in each replica set. Default value: 3.
    NodesPerShard float64
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    SecurityGroups []string
    ID of the security group.
    ShardQuantity float64
    Number of sharding.
    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.
    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.
    availableZone String
    The available zone of the Mongodb.
    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.
    clusterType String
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    createTime String
    Creation time of the Mongodb instance.
    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.
    fatherInstanceId String
    Indicates the main instance ID of readonly instances.
    fatherInstanceRegion String
    Indicates the region of main instance.
    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).
    memory Double
    Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
    mongodbReadonlyInstanceId String
    ID of the resource.
    mongosCpu Double
    Number of mongos cpu.
    mongosMemory Double
    Mongos memory size in GB.
    mongosNodeNum Double
    Number of mongos.
    nodeNum Double
    The number of nodes in each replica set. Default value: 3.
    nodesPerShard Double
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    securityGroups List<String>
    ID of the security group.
    shardQuantity Double
    Number of sharding.
    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.
    autoRenewFlag number
    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.
    availableZone string
    The available zone of the Mongodb.
    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.
    clusterType string
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    createTime string
    Creation time of the Mongodb instance.
    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.
    fatherInstanceId string
    Indicates the main instance ID of readonly instances.
    fatherInstanceRegion string
    Indicates the region of main instance.
    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).
    memory number
    Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
    mongodbReadonlyInstanceId string
    ID of the resource.
    mongosCpu number
    Number of mongos cpu.
    mongosMemory number
    Mongos memory size in GB.
    mongosNodeNum number
    Number of mongos.
    nodeNum number
    The number of nodes in each replica set. Default value: 3.
    nodesPerShard number
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    securityGroups string[]
    ID of the security group.
    shardQuantity number
    Number of sharding.
    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.
    auto_renew_flag float
    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.
    available_zone str
    The available zone of the Mongodb.
    charge_type str
    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.
    cluster_type str
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    create_time str
    Creation time of the Mongodb instance.
    engine_version str
    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.
    father_instance_id str
    Indicates the main instance ID of readonly instances.
    father_instance_region str
    Indicates the region of main instance.
    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).
    memory float
    Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
    mongodb_readonly_instance_id str
    ID of the resource.
    mongos_cpu float
    Number of mongos cpu.
    mongos_memory float
    Mongos memory size in GB.
    mongos_node_num float
    Number of mongos.
    node_num float
    The number of nodes in each replica set. Default value: 3.
    nodes_per_shard float
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    security_groups Sequence[str]
    ID of the security group.
    shard_quantity float
    Number of sharding.
    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.
    autoRenewFlag Number
    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.
    availableZone String
    The available zone of the Mongodb.
    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.
    clusterType String
    Instance schema type. - REPLSET: Replset cluster; - SHARD: Shard cluster.
    createTime String
    Creation time of the Mongodb instance.
    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.
    fatherInstanceId String
    Indicates the main instance ID of readonly instances.
    fatherInstanceRegion String
    Indicates the region of main instance.
    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).
    memory Number
    Memory size. The minimum value is 2, and unit is GB. Memory and volume must be upgraded or degraded simultaneously.
    mongodbReadonlyInstanceId String
    ID of the resource.
    mongosCpu Number
    Number of mongos cpu.
    mongosMemory Number
    Mongos memory size in GB.
    mongosNodeNum Number
    Number of mongos.
    nodeNum Number
    The number of nodes in each replica set. Default value: 3.
    nodesPerShard Number
    Number of nodes per shard, at least 3(one master and two slaves).
    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.
    securityGroups List<String>
    ID of the security group.
    shardQuantity Number
    Number of sharding.
    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.

    Import

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

    $ pulumi import tencentcloud:index/mongodbReadonlyInstance:MongodbReadonlyInstance mongodb cmgo-xxxxxx
    

    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 logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack