getHosts function

Future<GetHostsResult> getHosts(
  1. GetHostsArgs args, {
  2. InvokeOptions? options,
})

Provides a list of EC2 Dedicated Host IDs matching the provided filters. More information about Dedicated Hosts can be found in the EC2 User Guide.

Example Usage

Filter by instance type

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.ec2.getHosts({
    filters: [
        {
            name: "instance-type",
            values: ["c5.large"],
        },
        {
            name: "state",
            values: ["available"],
        },
    ],
});
import pulumi
import pulumi_aws as aws

example = aws.ec2.get_hosts(filters=[
    {
        "name": "instance-type",
        "values": ["c5.large"],
    },
    {
        "name": "state",
        "values": ["available"],
    },
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Ec2.GetHosts.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetHostsFilterInputArgs
            {
                Name = "instance-type",
                Values = new[]
                {
                    "c5.large",
                },
            },
            new Aws.Ec2.Inputs.GetHostsFilterInputArgs
            {
                Name = "state",
                Values = new[]
                {
                    "available",
                },
            },
        },
    });

});
package main

import (
	"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 {
		_, err := ec2.GetHosts(ctx, &ec2.GetHostsArgs{
			Filters: []ec2.GetHostsFilter{
				{
					Name: "instance-type",
					Values: []string{
						"c5.large",
					},
				},
				{
					Name: "state",
					Values: []string{
						"available",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_gethosts" "example" {
  filters {
    name   = "instance-type"
    values = ["c5.large"]
  }
  filters {
    name   = "state"
    values = ["available"]
  }
}
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.GetHostsArgs;
import com.pulumi.aws.ec2.inputs.GetHostsFilterArgs;
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 example = Ec2Functions.getHosts(GetHostsArgs.builder()
            .filters(
                GetHostsFilterArgs.builder()
                    .name("instance-type")
                    .values("c5.large")
                    .build(),
                GetHostsFilterArgs.builder()
                    .name("state")
                    .values("available")
                    .build())
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:ec2:getHosts
      arguments:
        filters:
          - name: instance-type
            values:
              - c5.large
          - name: state
            values:
              - available

Filter by Outpost ARN

The outpostArn argument applies a client-side filter because the DescribeHosts API does not support outpost-arn as a server-side filter.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const outpost = aws.ec2.getHosts({
    filters: [{
        name: "state",
        values: ["available"],
    }],
    outpostArn: example.arn,
});
import pulumi
import pulumi_aws as aws

outpost = aws.ec2.get_hosts(filters=[{
        "name": "state",
        "values": ["available"],
    }],
    outpost_arn=example["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var outpost = Aws.Ec2.GetHosts.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetHostsFilterInputArgs
            {
                Name = "state",
                Values = new[]
                {
                    "available",
                },
            },
        },
        OutpostArn = example.Arn,
    });

});
package main

import (
	"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 {
		_, err := ec2.GetHosts(ctx, &ec2.GetHostsArgs{
			Filters: []ec2.GetHostsFilter{
				{
					Name: "state",
					Values: []string{
						"available",
					},
				},
			},
			OutpostArn: pulumi.StringRef(example.Arn),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_gethosts" "outpost" {
  filters {
    name   = "state"
    values = ["available"]
  }
  outpost_arn = example.arn
}
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.GetHostsArgs;
import com.pulumi.aws.ec2.inputs.GetHostsFilterArgs;
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 outpost = Ec2Functions.getHosts(GetHostsArgs.builder()
            .filters(GetHostsFilterArgs.builder()
                .name("state")
                .values("available")
                .build())
            .outpostArn(example.arn())
            .build());

    }
}
variables:
  outpost:
    fn::invoke:
      function: aws:ec2:getHosts
      arguments:
        filters:
          - name: state
            values:
              - available
        outpostArn: ${example.arn}

args Arguments passed to this invoke. Arguments for getHosts. options Invoke options controlling this call.

Implementation

Future<GetHostsResult> getHosts(
  GetHostsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ec2/getHosts:getHosts',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetHostsResult.fromMap(result);
}