pulumi-alicloud-kotlin/com.pulumi.alicloud.tsdb.kotlin/TsdbFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

This data source provides the Time Series Database (TSDB) Instances of the current Alibaba Cloud user.

NOTE: Available in v1.112.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.tsdb.TsdbFunctions;
import com.pulumi.alicloud.tsdb.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 example = TsdbFunctions.getInstances(GetInstancesArgs.builder()
            .ids("example_value")
            .build());
        ctx.export("firstTsdbInstanceId", example.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
    }
}
Content copied to clipboard

Return

A collection of values returned by getInstances.

Parameters

argument

A collection of arguments for invoking getInstances.

suspend fun getInstances(appKey: String? = null, enableDetails: Boolean? = null, engineType: String? = null, ids: List<String>? = null, outputFile: String? = null, queryStr: String? = null, status: String? = null, statusList: String? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

See also

Parameters

appKey

The app key.

enableDetails

Default to false. Set it to true can output more details about resource attributes.

engineType

The engine type of instance. Enumerative: tsdb_tsdb refers to TSDB, tsdb_influxdb refers to TSDB for InfluxDB️.

ids

A list of Instance IDs.

outputFile

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

queryStr

The query str.

status

Instance status, enumerative: ACTIVATION,DELETED, CREATING,CLASS_CHANGING,LOCKED.

statusList

The status list.

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.tsdb.kotlin.inputs.GetInstancesPlainArgs.