pulumi-alicloud-kotlin/com.pulumi.alicloud.ocean.kotlin/OceanFunctions/getBaseInstances

getBaseInstances

suspend fun getBaseInstances(argument: GetBaseInstancesPlainArgs): GetBaseInstancesResult

This data source provides the Ocean Base Instances of the current Alibaba Cloud user.

NOTE: Available in v1.203.0+.

Example Usage

Basic Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ocean.OceanFunctions;
import com.pulumi.alicloud.ocean.inputs.GetBaseInstancesArgs;
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 ids = OceanFunctions.getBaseInstances();
        ctx.export("oceanBaseInstanceId1", ids.applyValue(getBaseInstancesResult -> getBaseInstancesResult.instances()[0].id()));
        final var nameRegex = OceanFunctions.getBaseInstances(GetBaseInstancesArgs.builder()
            .nameRegex("^my-Instance")
            .build());
        ctx.export("oceanBaseInstanceId2", nameRegex.applyValue(getBaseInstancesResult -> getBaseInstancesResult.instances()[0].id()));
    }
}
Content copied to clipboard

Return

A collection of values returned by getBaseInstances.

Parameters

argument

A collection of arguments for invoking getBaseInstances.

suspend fun getBaseInstances(enableDetails: Boolean? = null, ids: List<String>? = null, instanceId: String? = null, instanceName: String? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, resourceGroupId: String? = null, searchKey: String? = null, status: String? = null): GetBaseInstancesResult

Return

A collection of values returned by getBaseInstances.

See also

Parameters

enableDetails
ids

A list of Instance IDs.

instanceId

OceanBase cluster ID.

instanceName

OceanBase cluster name.

nameRegex

A regex string to filter results by Instance name.

outputFile

File name where to save data source results (after running pulumi preview).

pageNumber
pageSize
resourceGroupId

The ID of the enterprise resource group to which the instance resides.

searchKey

The filter keyword for the query list.

status

The status of the resource.

suspend fun getBaseInstances(argument: suspend GetBaseInstancesPlainArgsBuilder.() -> Unit): GetBaseInstancesResult

Return

A collection of values returned by getBaseInstances.

See also

Parameters

argument

Builder for com.pulumi.alicloud.ocean.kotlin.inputs.GetBaseInstancesPlainArgs.