pulumi-alicloud-kotlin/com.pulumi.alicloud.mongodb.kotlin/MongodbFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

The alicloud.mongodb.getInstances data source provides a collection of MongoDB instances available in Alicloud account. Filters support regular expression for the instance name, engine or instance type.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.mongodb.MongodbFunctions;
import com.pulumi.alicloud.mongodb.inputs.GetInstancesArgs;
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 mongo = MongodbFunctions.getInstances(GetInstancesArgs.builder()
            .availabilityZone("eu-central-1a")
            .instanceClass("dds.mongo.mid")
            .instanceType("replicate")
            .nameRegex("dds-.+\\d+")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getInstances.

Parameters

argument

A collection of arguments for invoking getInstances.

suspend fun getInstances(availabilityZone: String? = null, ids: List<String>? = null, instanceClass: String? = null, instanceType: String? = null, nameRegex: String? = null, outputFile: String? = null, tags: Map<String, Any>? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

availabilityZone

Instance availability zone.

ids

The ids list of MongoDB instances

instanceClass

Sizing of the instance to be queried.

instanceType

Type of the instance to be queried. If it is set to sharding, the sharded cluster instances are listed. If it is set to replicate, replica set instances are listed. Default value replicate.

nameRegex

A regex string to apply to the instance name.

outputFile

The name of file that can save the collection of instances after running pulumi preview.

tags

A mapping of tags to assign to the resource.

suspend fun getInstances(argument: suspend GetInstancesPlainArgsBuilder.() -> Unit): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

argument

Builder for com.pulumi.alicloud.mongodb.kotlin.inputs.GetInstancesPlainArgs.