pulumi-alicloud-kotlin/com.pulumi.alicloud.ecs.kotlin/EcsFunctions/getInstances

getInstances

suspend fun getInstances(argument: GetInstancesPlainArgs): GetInstancesResult

The Instances data source list ECS instance resources according to their ID, name regex, image id, status and other fields.

NOTE: Available since v1.7.0.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const instancesDs = alicloud.ecs.getInstances({
    nameRegex: "web_server",
    status: "Running",
});
export const firstInstanceId = instancesDs.then(instancesDs => instancesDs.instances?.[0]?.id);
export const instanceIds = instancesDs.then(instancesDs => instancesDs.ids);
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
instances_ds = alicloud.ecs.get_instances(name_regex="web_server",
    status="Running")
pulumi.export("firstInstanceId", instances_ds.instances[0].id)
pulumi.export("instanceIds", instances_ds.ids)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
    var instancesDs = AliCloud.Ecs.GetInstances.Invoke(new()
    {
        NameRegex = "web_server",
        Status = "Running",
    });
    return new Dictionary<string, object?>
    {
        ["firstInstanceId"] = instancesDs&#46;Apply(getInstancesResult => getInstancesResult&#46;Instances[0]?.Id),
        ["instanceIds"] = instancesDs.Apply(getInstancesResult => getInstancesResult.Ids),
    };
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instancesDs, err := ecs.GetInstances(ctx, &ecs.GetInstancesArgs{
			NameRegex: pulumi.StringRef("web_server"),
			Status:    pulumi.StringRef("Running"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstInstanceId", instancesDs.Instances[0].Id)
		ctx.Export("instanceIds", instancesDs.Ids)
		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.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.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 = EcsFunctions.getInstances(GetInstancesArgs.builder()
            .nameRegex("web_server")
            .status("Running")
            .build());
        ctx.export("firstInstanceId", instancesDs.instances()[0].id());
        ctx.export("instanceIds", instancesDs.ids());
    }
}
Content copied to clipboard
variables:
  instancesDs:
    fn::invoke:
      function: alicloud:ecs:getInstances
      arguments:
        nameRegex: web_server
        status: Running
outputs:
  firstInstanceId: ${instancesDs.instances[0].id}
  instanceIds: ${instancesDs.ids}
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, enableDetails: Boolean? = null, ids: List<String>? = null, imageId: String? = null, instanceName: String? = null, nameRegex: String? = null, outputFile: String? = null, pageNumber: Int? = null, pageSize: Int? = null, ramRoleName: String? = null, resourceGroupId: String? = null, status: String? = null, tags: Map<String, String>? = null, vpcId: String? = null, vswitchId: String? = null): GetInstancesResult

Return

A collection of values returned by getInstances.

Parameters

availabilityZone

Availability zone where instances are located.

enableDetails

Default to true. If false, the attributes ram_role_name and disk_device_mappings will not be fetched and output.

ids

A list of ECS instance IDs.

imageId

The image ID of some ECS instance used.

instanceName

The name of the instance. Fuzzy search with the asterisk (*) wildcard characters is supported.

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
ramRoleName

The RAM role name which the instance attaches.

resourceGroupId

The ID of resource group which the instance belongs.

status

Instance status. Valid values: "Creating", "Starting", "Running", "Stopping" and "Stopped". If undefined, all statuses are considered.

tags

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

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const taggedInstances = alicloud.ecs.getInstances({
    tags: {
        tagKey1: "tagValue1",
        tagKey2: "tagValue2",
    },
});
Content copied to clipboard
import pulumi
import pulumi_alicloud as alicloud
tagged_instances = alicloud.ecs.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 taggedInstances = AliCloud.Ecs.GetInstances.Invoke(new()
    {
        Tags =
        {
            { "tagKey1", "tagValue1" },
            { "tagKey2", "tagValue2" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecs.GetInstances(ctx, &ecs.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.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.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 taggedInstances = EcsFunctions.getInstances(GetInstancesArgs.builder()
            .tags(Map.ofEntries(
                Map.entry("tagKey1", "tagValue1"),
                Map.entry("tagKey2", "tagValue2")
            ))
            .build());
    }
}
Content copied to clipboard
variables:
  taggedInstances:
    fn::invoke:
      function: alicloud:ecs:getInstances
      arguments:
        tags:
          tagKey1: tagValue1
          tagKey2: tagValue2
Content copied to clipboard
vpcId

ID of the VPC linked to the instances.

vswitchId

ID of the vSwitch linked to the instances.

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

See also

.