DedicatedHost class

Provides an EC2 Host resource. This allows Dedicated Hosts to be allocated, modified, and released.

Example Usage

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

// Create a new host with instance type of c5.18xlarge with Auto Placement
// and Host Recovery enabled.
const test = new aws.ec2.DedicatedHost("test", {
    instanceType: "c5.18xlarge",
    availabilityZone: "us-west-2a",
    hostRecovery: "on",
    autoPlacement: "on",
});
import pulumi
import pulumi_aws as aws

# Create a new host with instance type of c5.18xlarge with Auto Placement
# and Host Recovery enabled.
test = aws.ec2.DedicatedHost("test",
    instance_type="c5.18xlarge",
    availability_zone="us-west-2a",
    host_recovery="on",
    auto_placement="on")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    // Create a new host with instance type of c5.18xlarge with Auto Placement
    // and Host Recovery enabled.
    var test = new Aws.Ec2.DedicatedHost("test", new()
    {
        InstanceType = "c5.18xlarge",
        AvailabilityZone = "us-west-2a",
        HostRecovery = "on",
        AutoPlacement = "on",
    });

});
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 {
		// Create a new host with instance type of c5.18xlarge with Auto Placement
		// and Host Recovery enabled.
		_, err := ec2.NewDedicatedHost(ctx, "test", &ec2.DedicatedHostArgs{
			InstanceType:     pulumi.String("c5.18xlarge"),
			AvailabilityZone: pulumi.String("us-west-2a"),
			HostRecovery:     pulumi.String("on"),
			AutoPlacement:    pulumi.String("on"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

# Create a new host with instance type of c5.18xlarge with Auto Placement
# and Host Recovery enabled.
resource "aws_ec2_dedicatedhost" "test" {
  instance_type     = "c5.18xlarge"
  availability_zone = "us-west-2a"
  host_recovery     = "on"
  auto_placement    = "on"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.DedicatedHost;
import com.pulumi.aws.ec2.DedicatedHostArgs;
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) {
        // Create a new host with instance type of c5.18xlarge with Auto Placement
        // and Host Recovery enabled.
        var test = new DedicatedHost("test", DedicatedHostArgs.builder()
            .instanceType("c5.18xlarge")
            .availabilityZone("us-west-2a")
            .hostRecovery("on")
            .autoPlacement("on")
            .build());

    }
}
resources:
  # Create a new host with instance type of c5.18xlarge with Auto Placement
  # and Host Recovery enabled.
  test:
    type: aws:ec2:DedicatedHost
    properties:
      instanceType: c5.18xlarge
      availabilityZone: us-west-2a
      hostRecovery: on
      autoPlacement: on

Import

Using pulumi import, import hosts using the host id. For example:

$ pulumi import aws:ec2/dedicatedHost:DedicatedHost example h-0385a99d0e4b20cbb

Constructors

DedicatedHost(String name, {DedicatedHostArgs? args, CustomResourceOptions? options})
Creates a new DedicatedHost. name The Pulumi resource name. args Arguments used to configure this DedicatedHost. The set of arguments for DedicatedHost. options Resource options controlling this resource's behavior.
DedicatedHost.reference(String urn)
Creates a typed reference to an existing DedicatedHost resource.

Properties

arn ↔ Output<String>
The ARN of the Dedicated Host.
latefinal
assetId ↔ Output<String>
The ID of the Outpost hardware asset on which to allocate the Dedicated Hosts. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter.
latefinal
autoPlacement ↔ Output<String?>
Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. Valid values: on, off. Default: on.
latefinal
availabilityZone ↔ Output<String>
The Availability Zone in which to allocate the Dedicated Host.
latefinal
childResources Set<Resource>
finalinherited
completionSources Map<String, IOutputCompletionSource>
latefinalinherited
hashCode int
The hash code for this object.
no setterinherited
hostRecovery ↔ Output<String?>
Indicates whether to enable or disable host recovery for the Dedicated Host. Valid values: on, off. Default: off.
latefinal
id ↔ Output<String>
getter/setter pairinherited
instanceFamily ↔ Output<String?>
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. Exactly one of instanceFamily or instanceType must be specified.
latefinal
instanceType ↔ Output<String?>
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. Exactly one of instanceFamily or instanceType must be specified.
latefinal
isCustom bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference bool
Whether this instance represents a resource value returned over RPC.
finalinherited
outpostArn ↔ Output<String?>
ARN of the AWS Outpost on which to allocate the Dedicated Host.
latefinal
ownerId ↔ Output<String>
The ID of the AWS account that owns the Dedicated Host.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Map of tags to assign to this resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() String
Returns this resource's logical name.
inherited
getResourceType() String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DedicatedHostState? state, CustomResourceOptions? options}) DedicatedHost
Gets an existing DedicatedHost resource's state with the given name and id.