Skip to content

Modify the auto-placement setting of a Dedicated Host

Description

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.

You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only.

Usage

ec2_modify_hosts(HostRecovery, InstanceType, InstanceFamily,
  HostMaintenance, HostIds, AutoPlacement)

Arguments

  • HostRecovery

    Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.

  • InstanceType

    Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.

    If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

  • InstanceFamily

    Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.

    If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

  • HostMaintenance

    Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.

  • HostIds

    [required] The IDs of the Dedicated Hosts to modify.

  • AutoPlacement

    Specify whether to enable or disable auto-placement.

Value

A list with the following syntax:

list(
  Successful = list(
    "string"
  ),
  Unsuccessful = list(
    list(
      Error = list(
        Code = "string",
        Message = "string"
      ),
      ResourceId = "string"
    )
  )
)

Request syntax

svc$modify_hosts(
  HostRecovery = "on"|"off",
  InstanceType = "string",
  InstanceFamily = "string",
  HostMaintenance = "on"|"off",
  HostIds = list(
    "string"
  ),
  AutoPlacement = "on"|"off"
)