Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Ucloud Provider
  4. API Docs
  5. UmongodbShardedCluster
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
Schema (JSON)
ucloud/terraform-provider-ucloud

ucloud.UmongodbShardedCluster

ucloud
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
Schema (JSON)
ucloud/terraform-provider-ucloud

    Provides a UMongoDB sharded cluster. Shard count and node count replace the cluster. Disk space and machine type resize it in place.

    Example Usage

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

const example = new ucloud.UmongodbShardedCluster("example", {
    availabilityZone: "cn-bj2-05",
    name: "tf-umongodb-sc",
    dbVersion: "MongoDB 4.2",
    adminPassword: adminPassword,
    diskSpace: 20,
    machineTypeId: "o.mongo2m.medium",
    nodeCount: 3,
    shardCount: 2,
    mongosNodeCount: 2,
    vpcId: defaultUcloudVpc.id,
    subnetId: _default.id,
});

    import pulumi
import pulumi_ucloud as ucloud

example = ucloud.UmongodbShardedCluster("example",
    availability_zone="cn-bj2-05",
    name="tf-umongodb-sc",
    db_version="MongoDB 4.2",
    admin_password=admin_password,
    disk_space=20,
    machine_type_id="o.mongo2m.medium",
    node_count=3,
    shard_count=2,
    mongos_node_count=2,
    vpc_id=default_ucloud_vpc["id"],
    subnet_id=default["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ucloud.NewUmongodbShardedCluster(ctx, "example", &ucloud.UmongodbShardedClusterArgs{
			AvailabilityZone: pulumi.String("cn-bj2-05"),
			Name:             pulumi.String("tf-umongodb-sc"),
			DbVersion:        pulumi.String("MongoDB 4.2"),
			AdminPassword:    pulumi.Any(adminPassword),
			DiskSpace:        pulumi.Float64(20),
			MachineTypeId:    pulumi.String("o.mongo2m.medium"),
			NodeCount:        pulumi.Float64(3),
			ShardCount:       pulumi.Float64(2),
			MongosNodeCount:  pulumi.Float64(2),
			VpcId:            pulumi.Any(defaultUcloudVpc.Id),
			SubnetId:         pulumi.Any(_default.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Ucloud.UmongodbShardedCluster("example", new()
    {
        AvailabilityZone = "cn-bj2-05",
        Name = "tf-umongodb-sc",
        DbVersion = "MongoDB 4.2",
        AdminPassword = adminPassword,
        DiskSpace = 20,
        MachineTypeId = "o.mongo2m.medium",
        NodeCount = 3,
        ShardCount = 2,
        MongosNodeCount = 2,
        VpcId = defaultUcloudVpc.Id,
        SubnetId = @default.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ucloud.UmongodbShardedCluster;
import com.pulumi.ucloud.UmongodbShardedClusterArgs;
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 example = new UmongodbShardedCluster("example", UmongodbShardedClusterArgs.builder()
            .availabilityZone("cn-bj2-05")
            .name("tf-umongodb-sc")
            .dbVersion("MongoDB 4.2")
            .adminPassword(adminPassword)
            .diskSpace(20.0)
            .machineTypeId("o.mongo2m.medium")
            .nodeCount(3.0)
            .shardCount(2.0)
            .mongosNodeCount(2.0)
            .vpcId(defaultUcloudVpc.id())
            .subnetId(default_.id())
            .build());

    }
}

    resources:
  example:
    type: ucloud:UmongodbShardedCluster
    properties:
      availabilityZone: cn-bj2-05
      name: tf-umongodb-sc
      dbVersion: MongoDB 4.2
      adminPassword: ${adminPassword}
      diskSpace: 20
      machineTypeId: o.mongo2m.medium
      nodeCount: 3
      shardCount: 2
      mongosNodeCount: 2
      vpcId: ${defaultUcloudVpc.id}
      subnetId: ${default.id}

    Example coming soon!

    Create UmongodbShardedCluster Resource

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

    Constructor syntax

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

@overload
def UmongodbShardedCluster(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           mongos_node_count: Optional[float] = None,
                           machine_type_id: Optional[str] = None,
                           shard_count: Optional[float] = None,
                           availability_zone: Optional[str] = None,
                           admin_password: Optional[str] = None,
                           node_count: Optional[float] = None,
                           db_version: Optional[str] = None,
                           disk_space: Optional[float] = None,
                           tag: Optional[str] = None,
                           sec_groups: Optional[Sequence[UmongodbShardedClusterSecGroupArgs]] = None,
                           labels: Optional[Sequence[UmongodbShardedClusterLabelArgs]] = None,
                           mongos_machine_type_id: Optional[str] = None,
                           auto_backup_time: Optional[str] = None,
                           charge_type: Optional[str] = None,
                           backup_disabled: Optional[bool] = None,
                           quantity: Optional[float] = None,
                           restart_trigger: Optional[str] = None,
                           listen_port: Optional[float] = None,
                           auto_backup_week: Optional[str] = None,
                           status: Optional[str] = None,
                           subnet_id: Optional[str] = None,
                           name: Optional[str] = None,
                           timeouts: Optional[UmongodbShardedClusterTimeoutsArgs] = None,
                           umongodb_sharded_cluster_id: Optional[str] = None,
                           vpc_id: Optional[str] = None)
    func NewUmongodbShardedCluster(ctx *Context, name string, args UmongodbShardedClusterArgs, opts ...ResourceOption) (*UmongodbShardedCluster, error)
    public UmongodbShardedCluster(string name, UmongodbShardedClusterArgs args, CustomResourceOptions? opts = null)
    public UmongodbShardedCluster(String name, UmongodbShardedClusterArgs args)
public UmongodbShardedCluster(String name, UmongodbShardedClusterArgs args, CustomResourceOptions options)

    type: ucloud:UmongodbShardedCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "ucloud_umongodb_sharded_cluster" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UmongodbShardedClusterArgs
    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 UmongodbShardedClusterArgs
    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 UmongodbShardedClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UmongodbShardedClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UmongodbShardedClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var umongodbShardedClusterResource = new Ucloud.UmongodbShardedCluster("umongodbShardedClusterResource", new()
{
    MongosNodeCount = 0.0,
    MachineTypeId = "string",
    ShardCount = 0.0,
    AvailabilityZone = "string",
    AdminPassword = "string",
    NodeCount = 0.0,
    DbVersion = "string",
    DiskSpace = 0.0,
    Tag = "string",
    SecGroups = new[]
    {
        new Ucloud.Inputs.UmongodbShardedClusterSecGroupArgs
        {
            Id = "string",
            Priority = 0.0,
        },
    },
    Labels = new[]
    {
        new Ucloud.Inputs.UmongodbShardedClusterLabelArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    MongosMachineTypeId = "string",
    AutoBackupTime = "string",
    ChargeType = "string",
    BackupDisabled = false,
    Quantity = 0.0,
    RestartTrigger = "string",
    ListenPort = 0.0,
    AutoBackupWeek = "string",
    Status = "string",
    SubnetId = "string",
    Name = "string",
    Timeouts = new Ucloud.Inputs.UmongodbShardedClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    UmongodbShardedClusterId = "string",
    VpcId = "string",
});

    example, err := ucloud.NewUmongodbShardedCluster(ctx, "umongodbShardedClusterResource", &ucloud.UmongodbShardedClusterArgs{
	MongosNodeCount:  pulumi.Float64(0),
	MachineTypeId:    pulumi.String("string"),
	ShardCount:       pulumi.Float64(0),
	AvailabilityZone: pulumi.String("string"),
	AdminPassword:    pulumi.String("string"),
	NodeCount:        pulumi.Float64(0),
	DbVersion:        pulumi.String("string"),
	DiskSpace:        pulumi.Float64(0),
	Tag:              pulumi.String("string"),
	SecGroups: ucloud.UmongodbShardedClusterSecGroupArray{
		&ucloud.UmongodbShardedClusterSecGroupArgs{
			Id:       pulumi.String("string"),
			Priority: pulumi.Float64(0),
		},
	},
	Labels: ucloud.UmongodbShardedClusterLabelArray{
		&ucloud.UmongodbShardedClusterLabelArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	MongosMachineTypeId: pulumi.String("string"),
	AutoBackupTime:      pulumi.String("string"),
	ChargeType:          pulumi.String("string"),
	BackupDisabled:      pulumi.Bool(false),
	Quantity:            pulumi.Float64(0),
	RestartTrigger:      pulumi.String("string"),
	ListenPort:          pulumi.Float64(0),
	AutoBackupWeek:      pulumi.String("string"),
	Status:              pulumi.String("string"),
	SubnetId:            pulumi.String("string"),
	Name:                pulumi.String("string"),
	Timeouts: &ucloud.UmongodbShardedClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	UmongodbShardedClusterId: pulumi.String("string"),
	VpcId:                    pulumi.String("string"),
})

    resource "ucloud_umongodb_sharded_cluster" "umongodbShardedClusterResource" {
  lifecycle {
    create_before_destroy = true
  }
  mongos_node_count = 0
  machine_type_id   = "string"
  shard_count       = 0
  availability_zone = "string"
  admin_password    = "string"
  node_count        = 0
  db_version        = "string"
  disk_space        = 0
  tag               = "string"
  sec_groups {
    id       = "string"
    priority = 0
  }
  labels {
    key   = "string"
    value = "string"
  }
  mongos_machine_type_id = "string"
  auto_backup_time       = "string"
  charge_type            = "string"
  backup_disabled        = false
  quantity               = 0
  restart_trigger        = "string"
  listen_port            = 0
  auto_backup_week       = "string"
  status                 = "string"
  subnet_id              = "string"
  name                   = "string"
  _ {
    timeouts = {
      create = "string"
      delete = "string"
      update = "string"
    }
  }
  umongodb_sharded_cluster_id = "string"
  vpc_id                      = "string"
}

    var umongodbShardedClusterResource = new UmongodbShardedCluster("umongodbShardedClusterResource", UmongodbShardedClusterArgs.builder()
    .mongosNodeCount(0.0)
    .machineTypeId("string")
    .shardCount(0.0)
    .availabilityZone("string")
    .adminPassword("string")
    .nodeCount(0.0)
    .dbVersion("string")
    .diskSpace(0.0)
    .tag("string")
    .secGroups(UmongodbShardedClusterSecGroupArgs.builder()
        .id("string")
        .priority(0.0)
        .build())
    .labels(UmongodbShardedClusterLabelArgs.builder()
        .key("string")
        .value("string")
        .build())
    .mongosMachineTypeId("string")
    .autoBackupTime("string")
    .chargeType("string")
    .backupDisabled(false)
    .quantity(0.0)
    .restartTrigger("string")
    .listenPort(0.0)
    .autoBackupWeek("string")
    .status("string")
    .subnetId("string")
    .name("string")
    .timeouts(UmongodbShardedClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .umongodbShardedClusterId("string")
    .vpcId("string")
    .build());

    umongodb_sharded_cluster_resource = ucloud.UmongodbShardedCluster("umongodbShardedClusterResource",
    mongos_node_count=float(0),
    machine_type_id="string",
    shard_count=float(0),
    availability_zone="string",
    admin_password="string",
    node_count=float(0),
    db_version="string",
    disk_space=float(0),
    tag="string",
    sec_groups=[{
        "id": "string",
        "priority": float(0),
    }],
    labels=[{
        "key": "string",
        "value": "string",
    }],
    mongos_machine_type_id="string",
    auto_backup_time="string",
    charge_type="string",
    backup_disabled=False,
    quantity=float(0),
    restart_trigger="string",
    listen_port=float(0),
    auto_backup_week="string",
    status="string",
    subnet_id="string",
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    umongodb_sharded_cluster_id="string",
    vpc_id="string")

    const umongodbShardedClusterResource = new ucloud.UmongodbShardedCluster("umongodbShardedClusterResource", {
    mongosNodeCount: 0,
    machineTypeId: "string",
    shardCount: 0,
    availabilityZone: "string",
    adminPassword: "string",
    nodeCount: 0,
    dbVersion: "string",
    diskSpace: 0,
    tag: "string",
    secGroups: [{
        id: "string",
        priority: 0,
    }],
    labels: [{
        key: "string",
        value: "string",
    }],
    mongosMachineTypeId: "string",
    autoBackupTime: "string",
    chargeType: "string",
    backupDisabled: false,
    quantity: 0,
    restartTrigger: "string",
    listenPort: 0,
    autoBackupWeek: "string",
    status: "string",
    subnetId: "string",
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    umongodbShardedClusterId: "string",
    vpcId: "string",
});

    type: ucloud:UmongodbShardedCluster
properties:
    adminPassword: string
    autoBackupTime: string
    autoBackupWeek: string
    availabilityZone: string
    backupDisabled: false
    chargeType: string
    dbVersion: string
    diskSpace: 0
    labels:
        - key: string
          value: string
    listenPort: 0
    machineTypeId: string
    mongosMachineTypeId: string
    mongosNodeCount: 0
    name: string
    nodeCount: 0
    quantity: 0
    restartTrigger: string
    secGroups:
        - id: string
          priority: 0
    shardCount: 0
    status: string
    subnetId: string
    tag: string
    timeouts:
        create: string
        delete: string
        update: string
    umongodbShardedClusterId: string
    vpcId: string

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

    AdminPassword string
    AvailabilityZone string
    DbVersion string
    DiskSpace double
    MachineTypeId string
    MongosNodeCount double
    Number of mongos nodes. From 2 to 5.
    NodeCount double
    Node count in each shard. Only 3, 5, or 7.
    ShardCount double
    Number of shards. From 2 to 9.
    AutoBackupTime string
    AutoBackupWeek string
    BackupDisabled bool
    ChargeType string
    Labels List<UmongodbShardedClusterLabel>
    ListenPort double
    MongosMachineTypeId string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    Name string
    Quantity double
    RestartTrigger string
    SecGroups List<UmongodbShardedClusterSecGroup>
    Status string
    SubnetId string
    Tag string
    Timeouts UmongodbShardedClusterTimeouts
    UmongodbShardedClusterId string
    VpcId string
    AdminPassword string
    AvailabilityZone string
    DbVersion string
    DiskSpace float64
    MachineTypeId string
    MongosNodeCount float64
    Number of mongos nodes. From 2 to 5.
    NodeCount float64
    Node count in each shard. Only 3, 5, or 7.
    ShardCount float64
    Number of shards. From 2 to 9.
    AutoBackupTime string
    AutoBackupWeek string
    BackupDisabled bool
    ChargeType string
    Labels []UmongodbShardedClusterLabelArgs
    ListenPort float64
    MongosMachineTypeId string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    Name string
    Quantity float64
    RestartTrigger string
    SecGroups []UmongodbShardedClusterSecGroupArgs
    Status string
    SubnetId string
    Tag string
    Timeouts UmongodbShardedClusterTimeoutsArgs
    UmongodbShardedClusterId string
    VpcId string
    admin_password string
    availability_zone string
    db_version string
    disk_space number
    machine_type_id string
    mongos_node_count number
    Number of mongos nodes. From 2 to 5.
    node_count number
    Node count in each shard. Only 3, 5, or 7.
    shard_count number
    Number of shards. From 2 to 9.
    auto_backup_time string
    auto_backup_week string
    backup_disabled bool
    charge_type string
    labels list(object)
    listen_port number
    mongos_machine_type_id string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    name string
    quantity number
    restart_trigger string
    sec_groups list(object)
    status string
    subnet_id string
    tag string
    timeouts object
    umongodb_sharded_cluster_id string
    vpc_id string
    adminPassword String
    availabilityZone String
    dbVersion String
    diskSpace Double
    machineTypeId String
    mongosNodeCount Double
    Number of mongos nodes. From 2 to 5.
    nodeCount Double
    Node count in each shard. Only 3, 5, or 7.
    shardCount Double
    Number of shards. From 2 to 9.
    autoBackupTime String
    autoBackupWeek String
    backupDisabled Boolean
    chargeType String
    labels List<UmongodbShardedClusterLabel>
    listenPort Double
    mongosMachineTypeId String
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    name String
    quantity Double
    restartTrigger String
    secGroups List<UmongodbShardedClusterSecGroup>
    status String
    subnetId String
    tag String
    timeouts UmongodbShardedClusterTimeouts
    umongodbShardedClusterId String
    vpcId String
    adminPassword string
    availabilityZone string
    dbVersion string
    diskSpace number
    machineTypeId string
    mongosNodeCount number
    Number of mongos nodes. From 2 to 5.
    nodeCount number
    Node count in each shard. Only 3, 5, or 7.
    shardCount number
    Number of shards. From 2 to 9.
    autoBackupTime string
    autoBackupWeek string
    backupDisabled boolean
    chargeType string
    labels UmongodbShardedClusterLabel[]
    listenPort number
    mongosMachineTypeId string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    name string
    quantity number
    restartTrigger string
    secGroups UmongodbShardedClusterSecGroup[]
    status string
    subnetId string
    tag string
    timeouts UmongodbShardedClusterTimeouts
    umongodbShardedClusterId string
    vpcId string
    adminPassword String
    availabilityZone String
    dbVersion String
    diskSpace Number
    machineTypeId String
    mongosNodeCount Number
    Number of mongos nodes. From 2 to 5.
    nodeCount Number
    Node count in each shard. Only 3, 5, or 7.
    shardCount Number
    Number of shards. From 2 to 9.
    autoBackupTime String
    autoBackupWeek String
    backupDisabled Boolean
    chargeType String
    labels List<Property Map>
    listenPort Number
    mongosMachineTypeId String
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    name String
    quantity Number
    restartTrigger String
    secGroups List<Property Map>
    status String
    subnetId String
    tag String
    timeouts Property Map
    umongodbShardedClusterId String
    vpcId String

    Outputs

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

    ConnectUrl string
    CreateTime double
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    ConnectUrl string
    CreateTime float64
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    connect_url string
    create_time number
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    connectUrl String
    createTime Double
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    connectUrl string
    createTime number
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    connect_url str
    create_time float
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    connectUrl String
    createTime Number
    id String
    The provider-assigned unique ID for this managed resource.
    state String

    Look up Existing UmongodbShardedCluster Resource

    Get an existing UmongodbShardedCluster 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?: UmongodbShardedClusterState, opts?: CustomResourceOptions): UmongodbShardedCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_password: Optional[str] = None,
        auto_backup_time: Optional[str] = None,
        auto_backup_week: Optional[str] = None,
        availability_zone: Optional[str] = None,
        backup_disabled: Optional[bool] = None,
        charge_type: Optional[str] = None,
        connect_url: Optional[str] = None,
        create_time: Optional[float] = None,
        db_version: Optional[str] = None,
        disk_space: Optional[float] = None,
        labels: Optional[Sequence[UmongodbShardedClusterLabelArgs]] = None,
        listen_port: Optional[float] = None,
        machine_type_id: Optional[str] = None,
        mongos_machine_type_id: Optional[str] = None,
        mongos_node_count: Optional[float] = None,
        name: Optional[str] = None,
        node_count: Optional[float] = None,
        quantity: Optional[float] = None,
        restart_trigger: Optional[str] = None,
        sec_groups: Optional[Sequence[UmongodbShardedClusterSecGroupArgs]] = None,
        shard_count: Optional[float] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tag: Optional[str] = None,
        timeouts: Optional[UmongodbShardedClusterTimeoutsArgs] = None,
        umongodb_sharded_cluster_id: Optional[str] = None,
        vpc_id: Optional[str] = None) -> UmongodbShardedCluster
    func GetUmongodbShardedCluster(ctx *Context, name string, id IDInput, state *UmongodbShardedClusterState, opts ...ResourceOption) (*UmongodbShardedCluster, error)
    public static UmongodbShardedCluster Get(string name, Input<string> id, UmongodbShardedClusterState? state, CustomResourceOptions? opts = null)
    public static UmongodbShardedCluster get(String name, Output<String> id, UmongodbShardedClusterState state, CustomResourceOptions options)
    resources:  _:    type: ucloud:UmongodbShardedCluster    get:      id: ${id}
    import {
  to = ucloud_umongodb_sharded_cluster.example
  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:
    AdminPassword string
    AutoBackupTime string
    AutoBackupWeek string
    AvailabilityZone string
    BackupDisabled bool
    ChargeType string
    ConnectUrl string
    CreateTime double
    DbVersion string
    DiskSpace double
    Labels List<UmongodbShardedClusterLabel>
    ListenPort double
    MachineTypeId string
    MongosMachineTypeId string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    MongosNodeCount double
    Number of mongos nodes. From 2 to 5.
    Name string
    NodeCount double
    Node count in each shard. Only 3, 5, or 7.
    Quantity double
    RestartTrigger string
    SecGroups List<UmongodbShardedClusterSecGroup>
    ShardCount double
    Number of shards. From 2 to 9.
    State string
    Status string
    SubnetId string
    Tag string
    Timeouts UmongodbShardedClusterTimeouts
    UmongodbShardedClusterId string
    VpcId string
    AdminPassword string
    AutoBackupTime string
    AutoBackupWeek string
    AvailabilityZone string
    BackupDisabled bool
    ChargeType string
    ConnectUrl string
    CreateTime float64
    DbVersion string
    DiskSpace float64
    Labels []UmongodbShardedClusterLabelArgs
    ListenPort float64
    MachineTypeId string
    MongosMachineTypeId string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    MongosNodeCount float64
    Number of mongos nodes. From 2 to 5.
    Name string
    NodeCount float64
    Node count in each shard. Only 3, 5, or 7.
    Quantity float64
    RestartTrigger string
    SecGroups []UmongodbShardedClusterSecGroupArgs
    ShardCount float64
    Number of shards. From 2 to 9.
    State string
    Status string
    SubnetId string
    Tag string
    Timeouts UmongodbShardedClusterTimeoutsArgs
    UmongodbShardedClusterId string
    VpcId string
    admin_password string
    auto_backup_time string
    auto_backup_week string
    availability_zone string
    backup_disabled bool
    charge_type string
    connect_url string
    create_time number
    db_version string
    disk_space number
    labels list(object)
    listen_port number
    machine_type_id string
    mongos_machine_type_id string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    mongos_node_count number
    Number of mongos nodes. From 2 to 5.
    name string
    node_count number
    Node count in each shard. Only 3, 5, or 7.
    quantity number
    restart_trigger string
    sec_groups list(object)
    shard_count number
    Number of shards. From 2 to 9.
    state string
    status string
    subnet_id string
    tag string
    timeouts object
    umongodb_sharded_cluster_id string
    vpc_id string
    adminPassword String
    autoBackupTime String
    autoBackupWeek String
    availabilityZone String
    backupDisabled Boolean
    chargeType String
    connectUrl String
    createTime Double
    dbVersion String
    diskSpace Double
    labels List<UmongodbShardedClusterLabel>
    listenPort Double
    machineTypeId String
    mongosMachineTypeId String
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    mongosNodeCount Double
    Number of mongos nodes. From 2 to 5.
    name String
    nodeCount Double
    Node count in each shard. Only 3, 5, or 7.
    quantity Double
    restartTrigger String
    secGroups List<UmongodbShardedClusterSecGroup>
    shardCount Double
    Number of shards. From 2 to 9.
    state String
    status String
    subnetId String
    tag String
    timeouts UmongodbShardedClusterTimeouts
    umongodbShardedClusterId String
    vpcId String
    adminPassword string
    autoBackupTime string
    autoBackupWeek string
    availabilityZone string
    backupDisabled boolean
    chargeType string
    connectUrl string
    createTime number
    dbVersion string
    diskSpace number
    labels UmongodbShardedClusterLabel[]
    listenPort number
    machineTypeId string
    mongosMachineTypeId string
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    mongosNodeCount number
    Number of mongos nodes. From 2 to 5.
    name string
    nodeCount number
    Node count in each shard. Only 3, 5, or 7.
    quantity number
    restartTrigger string
    secGroups UmongodbShardedClusterSecGroup[]
    shardCount number
    Number of shards. From 2 to 9.
    state string
    status string
    subnetId string
    tag string
    timeouts UmongodbShardedClusterTimeouts
    umongodbShardedClusterId string
    vpcId string
    adminPassword String
    autoBackupTime String
    autoBackupWeek String
    availabilityZone String
    backupDisabled Boolean
    chargeType String
    connectUrl String
    createTime Number
    dbVersion String
    diskSpace Number
    labels List<Property Map>
    listenPort Number
    machineTypeId String
    mongosMachineTypeId String
    Mongos machine type. Changes call ResizeUMongoDBInstance.
    mongosNodeCount Number
    Number of mongos nodes. From 2 to 5.
    name String
    nodeCount Number
    Node count in each shard. Only 3, 5, or 7.
    quantity Number
    restartTrigger String
    secGroups List<Property Map>
    shardCount Number
    Number of shards. From 2 to 9.
    state String
    status String
    subnetId String
    tag String
    timeouts Property Map
    umongodbShardedClusterId String
    vpcId String

    Supporting Types

    UmongodbShardedClusterLabel, UmongodbShardedClusterLabelArgs

    Key string
    Value string
    Key string
    Value string
    key string
    value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    UmongodbShardedClusterSecGroup, UmongodbShardedClusterSecGroupArgs

    Id string
    Priority double
    Id string
    Priority float64
    id string
    priority number
    id String
    priority Double
    id string
    priority number
    id str
    priority float
    id String
    priority Number

    UmongodbShardedClusterTimeouts, UmongodbShardedClusterTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create string
    delete string
    update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    $ pulumi import ucloud:index/umongodbShardedCluster:UmongodbShardedCluster example umongodb-sc-abc

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

    Package Details

    Repository
    ucloud ucloud/terraform-provider-ucloud
    License
    Notes
    This Pulumi package is based on the ucloud Terraform Provider.
    ucloud
    Viewing docs for ucloud 1.49.0
    published on Tuesday, Oct 27, 2026 by ucloud
    Schema (JSON)
    ucloud/terraform-provider-ucloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial