getInstances function
Use this data source to get IDs or IPs of Amazon EC2 instances to be referenced elsewhere, e.g., to allow easier migration from another management solution or to make it easier for an operator to connect through bastion host(s).
> Note: It's strongly discouraged to use this data source for querying ephemeral
instances (e.g., managed via autoscaling group), as the output may change at any time
and you'd need to re-run apply every time an instance comes up or dies.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.ec2.getInstances({
filters: [{
name: "instance.group-id",
values: ["sg-12345678"],
}],
instanceTags: {
Role: "HardWorker",
},
instanceStateNames: [
"running",
"stopped",
],
});
const testEip: aws.ec2.Eip[] = [];
test.then(test => test.ids).length.apply(rangeBody => {
for (let range = 0; range < rangeBody; range++) {
testEip.push(new aws.ec2.Eip(`test-${range}`, {instance: test.then(test => test.ids[range])}));
}
});
import pulumi
from typing import Any
import pulumi_aws as aws
test = aws.ec2.get_instances(filters=[{
"name": "instance.group-id",
"values": ["sg-12345678"],
}],
instance_tags={
"Role": "HardWorker",
},
instance_state_names=[
"running",
"stopped",
])
test_eip: list[aws.ec2.Eip] = []
def create_test(range_body):
for test_eip_range in [{"value": i} for i in range(0, range_body)]:
test_eip.append(aws.ec2.Eip(f"test-{test_eip_range['value']}", instance=test.ids[test_eip_range["value"]]))
(len(test.ids)).apply(create_test)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = Aws.Ec2.GetInstances.Invoke(new()
{
Filters = new[]
{
new Aws.Ec2.Inputs.GetInstancesFilterInputArgs
{
Name = "instance.group-id",
Values = new[]
{
"sg-12345678",
},
},
},
InstanceTags =
{
{ "Role", "HardWorker" },
},
InstanceStateNames = new[]
{
"running",
"stopped",
},
});
var testEip = new List<Aws.Ec2.Eip>();
test.Apply(getInstancesResult => getInstancesResult.Ids).Length().Apply(rangeBody =>
{
for (var rangeIndex = 0; rangeIndex < rangeBody; rangeIndex++)
{
var range = new { Value = rangeIndex };
testEip.Add(new Aws.Ec2.Eip($"test-{range.Value}", new()
{
Instance = test.Apply(getInstancesResult => getInstancesResult.Ids)[range.Value],
}));
}
return 0;
});
});
package main
import (
"fmt"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
test, err := ec2.GetInstances(ctx, &ec2.GetInstancesArgs{
Filters: []ec2.GetInstancesFilter{
{
Name: "instance.group-id",
Values: []string{
"sg-12345678",
},
},
},
InstanceTags: map[string]string{
"Role": "HardWorker",
},
InstanceStateNames: []string{
"running",
"stopped",
},
}, nil)
if err != nil {
return err
}
var testEip []*ec2.Eip
for index := 0; index < int(len(test.Ids)); index++ {
key0 := index
val0 := index
__res, err := ec2.NewEip(ctx, fmt.Sprintf("test-%v", key0), &ec2.EipArgs{
Instance: pulumi.String(test.Ids[val0]),
})
if err != nil {
return err
}
testEip = append(testEip, __res)
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ec2_getinstances" "test" {
filters {
name = "instance.group-id"
values = ["sg-12345678"]
}
instance_tags = {
"Role" = "HardWorker"
}
instance_state_names = ["running", "stopped"]
}
resource "aws_ec2_eip" "test" {
count = length(data.aws_ec2_getinstances.test.ids)
instance = data.aws_ec2_getinstances.test.ids[count.index]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetInstancesArgs;
import com.pulumi.aws.ec2.inputs.GetInstancesFilterArgs;
import com.pulumi.aws.ec2.Eip;
import com.pulumi.aws.ec2.EipArgs;
import com.pulumi.codegen.internal.KeyedValue;
import java.util.ArrayList;
import java.util.Arrays;
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 test = Ec2Functions.getInstances(GetInstancesArgs.builder()
.filters(GetInstancesFilterArgs.builder()
.name("instance.group-id")
.values("sg-12345678")
.build())
.instanceTags(Map.of("Role", "HardWorker"))
.instanceStateNames(
"running",
"stopped")
.build());
for (var i = 0; i < test.ids().size(); i++) {
new Eip("testEip-" + i, EipArgs.builder()
.instance(test.ids()[range.value()])
.build());
}
}
}
args Arguments passed to this invoke. Arguments for getInstances.
options Invoke options controlling this call.
Implementation
Future<GetInstancesResult> getInstances(
GetInstancesArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:ec2/getInstances:getInstances',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetInstancesResult.fromMap(result);
}