AWS Classic v5.28.0, Jan 23 23

aws.ec2.getDedicatedHost

Use this data source to get information about an EC2 Dedicated Host.

Example Usage

Filter Example

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Ec2.GetDedicatedHost.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetDedicatedHostFilterInputArgs
            {
                Name = "instance-type",
                Values = new[]
                {
                    "c5.18xlarge",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.LookupDedicatedHost(ctx, &ec2.LookupDedicatedHostArgs{
			Filters: []ec2.GetDedicatedHostFilter{
				{
					Name: "instance-type",
					Values: []string{
						"c5.18xlarge",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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.GetDedicatedHostArgs;
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 test = Ec2Functions.getDedicatedHost(GetDedicatedHostArgs.builder()
            .filters(GetDedicatedHostFilterArgs.builder()
                .name("instance-type")
                .values("c5.18xlarge")
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.ec2.get_dedicated_host(filters=[aws.ec2.GetDedicatedHostFilterArgs(
    name="instance-type",
    values=["c5.18xlarge"],
)])

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

const test = aws.ec2.getDedicatedHost({
    filters: [{
        name: "instance-type",
        values: ["c5.18xlarge"],
    }],
});

variables:
  test:
    fn::invoke:
      Function: aws:ec2:getDedicatedHost
      Arguments:
        filters:
          - name: instance-type
            values:
              - c5.18xlarge

Using getDedicatedHost

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDedicatedHost(args: GetDedicatedHostArgs, opts?: InvokeOptions): Promise<GetDedicatedHostResult>
function getDedicatedHostOutput(args: GetDedicatedHostOutputArgs, opts?: InvokeOptions): Output<GetDedicatedHostResult>

def get_dedicated_host(filters: Optional[Sequence[GetDedicatedHostFilter]] = None,
                       host_id: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDedicatedHostResult
def get_dedicated_host_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDedicatedHostFilterArgs]]]] = None,
                       host_id: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDedicatedHostResult]

func LookupDedicatedHost(ctx *Context, args *LookupDedicatedHostArgs, opts ...InvokeOption) (*LookupDedicatedHostResult, error)
func LookupDedicatedHostOutput(ctx *Context, args *LookupDedicatedHostOutputArgs, opts ...InvokeOption) LookupDedicatedHostResultOutput

> Note: This function is named LookupDedicatedHost in the Go SDK.

public static class GetDedicatedHost 
{
    public static Task<GetDedicatedHostResult> InvokeAsync(GetDedicatedHostArgs args, InvokeOptions? opts = null)
    public static Output<GetDedicatedHostResult> Invoke(GetDedicatedHostInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDedicatedHostResult> getDedicatedHost(GetDedicatedHostArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws:ec2/getDedicatedHost:getDedicatedHost
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<Pulumi.Aws.Ec2.Inputs.GetDedicatedHostFilter>: Configuration block. Detailed below.
HostId string: ID of the Dedicated Host.
Tags Dictionary<string, string>

Filters []GetDedicatedHostFilter: Configuration block. Detailed below.
HostId string: ID of the Dedicated Host.
Tags map[string]string

filters List<GetDedicatedHostFilter>: Configuration block. Detailed below.
hostId String: ID of the Dedicated Host.
tags Map<String,String>

filters GetDedicatedHostFilter[]: Configuration block. Detailed below.
hostId string: ID of the Dedicated Host.
tags {[key: string]: string}

filters Sequence[GetDedicatedHostFilter]: Configuration block. Detailed below.
host_id str: ID of the Dedicated Host.
tags Mapping[str, str]

filters List<Property Map>: Configuration block. Detailed below.
hostId String: ID of the Dedicated Host.
tags Map<String>

getDedicatedHost Result

The following output properties are available:

Arn string: ARN of the Dedicated Host.
AutoPlacement string: Whether auto-placement is on or off.
AvailabilityZone string: Availability Zone of the Dedicated Host.
Cores int: Number of cores on the Dedicated Host.
HostId string
HostRecovery string: Whether host recovery is enabled or disabled for the Dedicated Host.
Id string: The provider-assigned unique ID for this managed resource.
InstanceFamily string: Instance family supported by the Dedicated Host. For example, "m5".
InstanceType string: Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
OutpostArn string: ARN of the AWS Outpost on which the Dedicated Host is allocated.
OwnerId string: ID of the AWS account that owns the Dedicated Host.
Sockets int: Number of sockets on the Dedicated Host.
Tags Dictionary<string, string>
TotalVcpus int: Total number of vCPUs on the Dedicated Host.
Filters List<Pulumi.Aws.Ec2.Outputs.GetDedicatedHostFilter>

Arn string: ARN of the Dedicated Host.
AutoPlacement string: Whether auto-placement is on or off.
AvailabilityZone string: Availability Zone of the Dedicated Host.
Cores int: Number of cores on the Dedicated Host.
HostId string
HostRecovery string: Whether host recovery is enabled or disabled for the Dedicated Host.
Id string: The provider-assigned unique ID for this managed resource.
InstanceFamily string: Instance family supported by the Dedicated Host. For example, "m5".
InstanceType string: Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
OutpostArn string: ARN of the AWS Outpost on which the Dedicated Host is allocated.
OwnerId string: ID of the AWS account that owns the Dedicated Host.
Sockets int: Number of sockets on the Dedicated Host.
Tags map[string]string
TotalVcpus int: Total number of vCPUs on the Dedicated Host.
Filters []GetDedicatedHostFilter

arn String: ARN of the Dedicated Host.
autoPlacement String: Whether auto-placement is on or off.
availabilityZone String: Availability Zone of the Dedicated Host.
cores Integer: Number of cores on the Dedicated Host.
hostId String
hostRecovery String: Whether host recovery is enabled or disabled for the Dedicated Host.
id String: The provider-assigned unique ID for this managed resource.
instanceFamily String: Instance family supported by the Dedicated Host. For example, "m5".
instanceType String: Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
outpostArn String: ARN of the AWS Outpost on which the Dedicated Host is allocated.
ownerId String: ID of the AWS account that owns the Dedicated Host.
sockets Integer: Number of sockets on the Dedicated Host.
tags Map<String,String>
totalVcpus Integer: Total number of vCPUs on the Dedicated Host.
filters List<GetDedicatedHostFilter>

arn string: ARN of the Dedicated Host.
autoPlacement string: Whether auto-placement is on or off.
availabilityZone string: Availability Zone of the Dedicated Host.
cores number: Number of cores on the Dedicated Host.
hostId string
hostRecovery string: Whether host recovery is enabled or disabled for the Dedicated Host.
id string: The provider-assigned unique ID for this managed resource.
instanceFamily string: Instance family supported by the Dedicated Host. For example, "m5".
instanceType string: Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
outpostArn string: ARN of the AWS Outpost on which the Dedicated Host is allocated.
ownerId string: ID of the AWS account that owns the Dedicated Host.
sockets number: Number of sockets on the Dedicated Host.
tags {[key: string]: string}
totalVcpus number: Total number of vCPUs on the Dedicated Host.
filters GetDedicatedHostFilter[]

arn str: ARN of the Dedicated Host.
auto_placement str: Whether auto-placement is on or off.
availability_zone str: Availability Zone of the Dedicated Host.
cores int: Number of cores on the Dedicated Host.
host_id str
host_recovery str: Whether host recovery is enabled or disabled for the Dedicated Host.
id str: The provider-assigned unique ID for this managed resource.
instance_family str: Instance family supported by the Dedicated Host. For example, "m5".
instance_type str: Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
outpost_arn str: ARN of the AWS Outpost on which the Dedicated Host is allocated.
owner_id str: ID of the AWS account that owns the Dedicated Host.
sockets int: Number of sockets on the Dedicated Host.
tags Mapping[str, str]
total_vcpus int: Total number of vCPUs on the Dedicated Host.
filters Sequence[GetDedicatedHostFilter]

arn String: ARN of the Dedicated Host.
autoPlacement String: Whether auto-placement is on or off.
availabilityZone String: Availability Zone of the Dedicated Host.
cores Number: Number of cores on the Dedicated Host.
hostId String
hostRecovery String: Whether host recovery is enabled or disabled for the Dedicated Host.
id String: The provider-assigned unique ID for this managed resource.
instanceFamily String: Instance family supported by the Dedicated Host. For example, "m5".
instanceType String: Instance type supported by the Dedicated Host. For example, "m5.large". If the host supports multiple instance types, no instanceType is returned.
outpostArn String: ARN of the AWS Outpost on which the Dedicated Host is allocated.
ownerId String: ID of the AWS account that owns the Dedicated Host.
sockets Number: Number of sockets on the Dedicated Host.
tags Map<String>
totalVcpus Number: Total number of vCPUs on the Dedicated Host.
filters List<Property Map>

Supporting Types

GetDedicatedHostFilter

Name string: Name of the field to filter by, as defined by the underlying AWS API.
Values List<string>: Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.

Name string: Name of the field to filter by, as defined by the underlying AWS API.
Values []string: Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.

name String: Name of the field to filter by, as defined by the underlying AWS API.
values List<String>: Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.

name string: Name of the field to filter by, as defined by the underlying AWS API.
values string[]: Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.

name str: Name of the field to filter by, as defined by the underlying AWS API.
values Sequence[str]: Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.

name String: Name of the field to filter by, as defined by the underlying AWS API.
values List<String>: Set of values that are accepted for the given field. A host will be selected if any one of the given values matches.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.