Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
published on Tuesday, Oct 27, 2026 by ucloud
ucloud
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
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 dictionarydata "ucloud_get_umongodb_instance" "name" {
# arguments
}The following arguments are supported:
- Cluster
Id string - Cluster ID.
- Availability
Zone string - Availability zone. Read fills this when it is omitted.
- Cluster
Type string ReplicaSetorSharedCluster. 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 ReplicaSetorSharedCluster. 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 ReplicaSetorSharedCluster. 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 ReplicaSetorSharedCluster. 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 ReplicaSetorSharedCluster. 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 ReplicaSetorSharedCluster. Read fills this when it is omitted.- id str
- cluster
Id String - Cluster ID.
- availability
Zone String - Availability zone. Read fills this when it is omitted.
- cluster
Type String ReplicaSetorSharedCluster. Read fills this when it is omitted.- id String
getUmongodbInstance Result
The following output properties are available:
- Availability
Zone string - Cluster
Id string - Cluster
Type string - Connect
Url string - Connection address.
- Create
Time double - Creation time as a Unix timestamp.
- Db
Version string - MongoDB version.
- Disk
Space double - Data disk size in GB.
- Id string
- Machine
Type stringId - Data node machine type.
- Mongos
Count double - Mongos count. Zero for a replica set.
- Name string
- Cluster name.
- Node
Count double - Node count, or node count per shard for a sharded cluster.
- double
- 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.
- Availability
Zone string - Cluster
Id string - Cluster
Type string - Connect
Url string - Connection address.
- Create
Time float64 - Creation time as a Unix timestamp.
- Db
Version string - MongoDB version.
- Disk
Space float64 - Data disk size in GB.
- Id string
- Machine
Type stringId - Data node machine type.
- Mongos
Count float64 - Mongos count. Zero for a replica set.
- Name string
- Cluster name.
- Node
Count float64 - Node count, or node count per shard for a sharded cluster.
- float64
- 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.
- 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_ stringid - 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.
- 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.
- availability
Zone String - cluster
Id String - cluster
Type String - connect
Url String - Connection address.
- create
Time Double - Creation time as a Unix timestamp.
- db
Version String - MongoDB version.
- disk
Space Double - Data disk size in GB.
- id String
- machine
Type StringId - Data node machine type.
- mongos
Count Double - Mongos count. Zero for a replica set.
- name String
- Cluster name.
- node
Count Double - Node count, or node count per shard for a sharded cluster.
- Double
- 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.
- 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 stringId - 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.
- 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.
- 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_ strid - 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.
- 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.
- 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 StringId - 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.
- 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.
Package Details
- Repository
- ucloud ucloud/terraform-provider-ucloud
- License
- Notes
- This Pulumi package is based on the
ucloudTerraform Provider.
ucloud
Viewing docs for ucloud 1.49.0
published on Tuesday, Oct 27, 2026 by ucloud
published on Tuesday, Oct 27, 2026 by ucloud