1. Registry
  2. Packages
  3. Ucloud Provider
  4. API Docs
  5. getUmongodbInstance
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
ucloud
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud

    Reads one UMongoDB replica set or sharded cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ucloud from "@pulumi/ucloud";
    
    const example = ucloud.getUmongodbInstance({
        clusterId: exampleUcloudUmongodbReplicaset.id,
    });
    
    import pulumi
    import pulumi_ucloud as ucloud
    
    example = ucloud.get_umongodb_instance(cluster_id=example_ucloud_umongodb_replicaset["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.GetUmongodbInstance(ctx, &ucloud.GetUmongodbInstanceArgs{
    			ClusterId: exampleUcloudUmongodbReplicaset.Id,
    		}, nil)
    		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 = Ucloud.GetUmongodbInstance.Invoke(new()
        {
            ClusterId = exampleUcloudUmongodbReplicaset.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ucloud.UcloudFunctions;
    import com.pulumi.ucloud.inputs.GetUmongodbInstanceArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = UcloudFunctions.getUmongodbInstance(GetUmongodbInstanceArgs.builder()
                .clusterId(exampleUcloudUmongodbReplicaset.id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ucloud:getUmongodbInstance
          arguments:
            clusterId: ${exampleUcloudUmongodbReplicaset.id}
    
    Example coming soon!
    

    Using getUmongodbInstance

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUmongodbInstance(args: GetUmongodbInstanceArgs, opts?: InvokeOptions): Promise<GetUmongodbInstanceResult>
    function getUmongodbInstanceOutput(args: GetUmongodbInstanceOutputArgs, opts?: InvokeOutputOptions): Output<GetUmongodbInstanceResult>
    def get_umongodb_instance(availability_zone: Optional[str] = None,
                              cluster_id: Optional[str] = None,
                              cluster_type: Optional[str] = None,
                              id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetUmongodbInstanceResult
    def get_umongodb_instance_output(availability_zone: pulumi.Input[Optional[str]] = None,
                              cluster_id: pulumi.Input[Optional[str]] = None,
                              cluster_type: pulumi.Input[Optional[str]] = None,
                              id: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetUmongodbInstanceResult]
    func GetUmongodbInstance(ctx *Context, args *GetUmongodbInstanceArgs, opts ...InvokeOption) (*GetUmongodbInstanceResult, error)
    func GetUmongodbInstanceOutput(ctx *Context, args *GetUmongodbInstanceOutputArgs, opts ...InvokeOption) GetUmongodbInstanceResultOutput

    > Note: This function is named GetUmongodbInstance in the Go SDK.

    public static class GetUmongodbInstance 
    {
        public static Task<GetUmongodbInstanceResult> InvokeAsync(GetUmongodbInstanceArgs args, InvokeOptions? opts = null)
        public static Output<GetUmongodbInstanceResult> Invoke(GetUmongodbInstanceInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetUmongodbInstanceResult> Invoke(GetUmongodbInstanceInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetUmongodbInstanceResult> getUmongodbInstance(GetUmongodbInstanceArgs args, InvokeOptions options)
    public static Output<GetUmongodbInstanceResult> getUmongodbInstance(GetUmongodbInstanceArgs args, InvokeOptions options)
    public static Output<GetUmongodbInstanceResult> getUmongodbInstance(GetUmongodbInstanceArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: ucloud:index/getUmongodbInstance:getUmongodbInstance
      arguments:
        # arguments dictionary
    data "ucloud_get_umongodb_instance" "name" {
        # arguments
    }

    The following arguments are supported:

    ClusterId string
    Cluster ID.
    AvailabilityZone string
    Availability zone. Read fills this when it is omitted.
    ClusterType string
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    Id string
    ClusterId string
    Cluster ID.
    AvailabilityZone string
    Availability zone. Read fills this when it is omitted.
    ClusterType string
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    Id string
    cluster_id string
    Cluster ID.
    availability_zone string
    Availability zone. Read fills this when it is omitted.
    cluster_type string
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    id string
    clusterId String
    Cluster ID.
    availabilityZone String
    Availability zone. Read fills this when it is omitted.
    clusterType String
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    id String
    clusterId string
    Cluster ID.
    availabilityZone string
    Availability zone. Read fills this when it is omitted.
    clusterType string
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    id string
    cluster_id str
    Cluster ID.
    availability_zone str
    Availability zone. Read fills this when it is omitted.
    cluster_type str
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    id str
    clusterId String
    Cluster ID.
    availabilityZone String
    Availability zone. Read fills this when it is omitted.
    clusterType String
    ReplicaSet or SharedCluster. Read fills this when it is omitted.
    id String

    getUmongodbInstance Result

    The following output properties are available:

    AvailabilityZone string
    ClusterId string
    ClusterType string
    ConnectUrl string
    Connection address.
    CreateTime double
    Creation time as a Unix timestamp.
    DbVersion string
    MongoDB version.
    DiskSpace double
    Data disk size in GB.
    Id string
    MachineTypeId string
    Data node machine type.
    MongosCount double
    Mongos count. Zero for a replica set.
    Name string
    Cluster name.
    NodeCount double
    Node count, or node count per shard for a sharded cluster.
    ShardCount double
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    State string
    Cluster state.
    SubnetId string
    Subnet ID.
    Tag string
    Business group.
    VpcId string
    VPC ID.
    AvailabilityZone string
    ClusterId string
    ClusterType string
    ConnectUrl string
    Connection address.
    CreateTime float64
    Creation time as a Unix timestamp.
    DbVersion string
    MongoDB version.
    DiskSpace float64
    Data disk size in GB.
    Id string
    MachineTypeId string
    Data node machine type.
    MongosCount float64
    Mongos count. Zero for a replica set.
    Name string
    Cluster name.
    NodeCount float64
    Node count, or node count per shard for a sharded cluster.
    ShardCount float64
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    State string
    Cluster state.
    SubnetId string
    Subnet ID.
    Tag string
    Business group.
    VpcId string
    VPC ID.
    availability_zone string
    cluster_id string
    cluster_type string
    connect_url string
    Connection address.
    create_time number
    Creation time as a Unix timestamp.
    db_version string
    MongoDB version.
    disk_space number
    Data disk size in GB.
    id string
    machine_type_id string
    Data node machine type.
    mongos_count number
    Mongos count. Zero for a replica set.
    name string
    Cluster name.
    node_count number
    Node count, or node count per shard for a sharded cluster.
    shard_count number
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    state string
    Cluster state.
    subnet_id string
    Subnet ID.
    tag string
    Business group.
    vpc_id string
    VPC ID.
    availabilityZone String
    clusterId String
    clusterType String
    connectUrl String
    Connection address.
    createTime Double
    Creation time as a Unix timestamp.
    dbVersion String
    MongoDB version.
    diskSpace Double
    Data disk size in GB.
    id String
    machineTypeId String
    Data node machine type.
    mongosCount Double
    Mongos count. Zero for a replica set.
    name String
    Cluster name.
    nodeCount Double
    Node count, or node count per shard for a sharded cluster.
    shardCount Double
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    state String
    Cluster state.
    subnetId String
    Subnet ID.
    tag String
    Business group.
    vpcId String
    VPC ID.
    availabilityZone string
    clusterId string
    clusterType string
    connectUrl string
    Connection address.
    createTime number
    Creation time as a Unix timestamp.
    dbVersion string
    MongoDB version.
    diskSpace number
    Data disk size in GB.
    id string
    machineTypeId string
    Data node machine type.
    mongosCount number
    Mongos count. Zero for a replica set.
    name string
    Cluster name.
    nodeCount number
    Node count, or node count per shard for a sharded cluster.
    shardCount number
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    state string
    Cluster state.
    subnetId string
    Subnet ID.
    tag string
    Business group.
    vpcId string
    VPC ID.
    availability_zone str
    cluster_id str
    cluster_type str
    connect_url str
    Connection address.
    create_time float
    Creation time as a Unix timestamp.
    db_version str
    MongoDB version.
    disk_space float
    Data disk size in GB.
    id str
    machine_type_id str
    Data node machine type.
    mongos_count float
    Mongos count. Zero for a replica set.
    name str
    Cluster name.
    node_count float
    Node count, or node count per shard for a sharded cluster.
    shard_count float
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    state str
    Cluster state.
    subnet_id str
    Subnet ID.
    tag str
    Business group.
    vpc_id str
    VPC ID.
    availabilityZone String
    clusterId String
    clusterType String
    connectUrl String
    Connection address.
    createTime Number
    Creation time as a Unix timestamp.
    dbVersion String
    MongoDB version.
    diskSpace Number
    Data disk size in GB.
    id String
    machineTypeId String
    Data node machine type.
    mongosCount Number
    Mongos count. Zero for a replica set.
    name String
    Cluster name.
    nodeCount Number
    Node count, or node count per shard for a sharded cluster.
    shardCount Number
    Shard count. Describe sets this from the data replica list, so a replica set is usually 1.
    state String
    Cluster state.
    subnetId String
    Subnet ID.
    tag String
    Business group.
    vpcId String
    VPC ID.

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial