pulumi-alicloud-kotlin/com.pulumi.alicloud.ots.kotlin/OtsFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

This data source provides the ots instances of the current Alibaba Cloud user.

NOTE: Available since v1.40.0.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const instancesDs = alicloud.ots.getInstances({
    outputFile: "instances.txt",
});
export const firstInstanceId = instancesDs.then(instancesDs => instancesDs.instances?.[0]?.id);
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
instances_ds = alicloud.ots.get_instances(output_file="instances.txt")
pulumi.export("firstInstanceId", instances_ds.instances[0].id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
    var instancesDs = AliCloud.Ots.GetInstances.Invoke(new()
    {
        OutputFile = "instances.txt",
    });
    return new Dictionary<string, object?>
    {
        ["firstInstanceId"] = instancesDs&#46;Apply(getInstancesResult => getInstancesResult&#46;Instances[0]?.Id),
    };
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instancesDs, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
			OutputFile: pulumi.StringRef("instances.txt"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstInstanceId", instancesDs.Instances[0].Id)
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ots.OtsFunctions;
import com.pulumi.alicloud.ots.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 instancesDs = OtsFunctions.getInstances(GetInstancesArgs.builder()
            .outputFile("instances.txt")
            .build());
        ctx.export("firstInstanceId", instancesDs.instances()[0].id());
    }
}
Content copied to clipboard
variables:
  instancesDs:
    fn::invoke:
      function: alicloud:ots:getInstances
      arguments:
        outputFile: instances.txt
outputs:
  firstInstanceId: ${instancesDs.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(ids: List<String>? = null, nameRegex: String? = null, outputFile: String? = null, tags: Map<String, String>? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

Parameters

ids

A list of instance IDs.

nameRegex

A regex string to filter results by instance name.

outputFile

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

tags

A map of tags assigned to the instance. It must be in the format:

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const instancesDs = alicloud.ots.getInstances({
    tags: {
        tagKey1: "tagValue1",
        tagKey2: "tagValue2",
    },
});
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
instances_ds = alicloud.ots.get_instances(tags={
    "tagKey1": "tagValue1",
    "tagKey2": "tagValue2",
})
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
    var instancesDs = AliCloud.Ots.GetInstances.Invoke(new()
    {
        Tags =
        {
            { "tagKey1", "tagValue1" },
            { "tagKey2", "tagValue2" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ots.GetInstances(ctx, &ots.GetInstancesArgs{
			Tags: map[string]interface{}{
				"tagKey1": "tagValue1",
				"tagKey2": "tagValue2",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ots.OtsFunctions;
import com.pulumi.alicloud.ots.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 instancesDs = OtsFunctions.getInstances(GetInstancesArgs.builder()
            .tags(Map.ofEntries(
                Map.entry("tagKey1", "tagValue1"),
                Map.entry("tagKey2", "tagValue2")
            ))
            .build());
    }
}
Content copied to clipboard
variables:
  instancesDs:
    fn::invoke:
      function: alicloud:ots:getInstances
      arguments:
        tags:
          tagKey1: tagValue1
          tagKey2: tagValue2
Content copied to clipboard

See also

.

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

Return

A collection of values returned by getInstances.

Parameters

argument

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

See also

.