ec2_allocate_hosts: Allocate Hosts

In aws.ecx: Communicating with AWS EC2 and ECS using AWS REST APIs

Description

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

Usage

ec2_allocate_hosts(
  AvailabilityZone,
  Quantity,
  AutoPlacement = NULL,
  ClientToken = NULL,
  InstanceType = NULL,
  InstanceFamily = NULL,
  TagSpecification = NULL,
  HostRecovery = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

AvailabilityZone	Character. The Availability Zone in which to allocate the Dedicated Host.
Quantity	Integer. The number of Dedicated Hosts to allocate to your account with these parameters.
AutoPlacement	Character. Indicates whether the host accepts any untargeted instance launches that match its instance type...[optional]
ClientToken	Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional]
InstanceType	Character. Specifies the instance type to be supported by the Dedicated Hosts.[optional]
InstanceFamily	Character. Specifies the instance family to be supported by the Dedicated Hosts.[optional]
TagSpecification	List. The tags to apply to the Dedicated Host during creation.[optional]
HostRecovery	Character. Indicates whether to enable or disable host recovery for the Dedicated Host.[optional]
simplify	Logical. Whether to simplify the result and handle nextToken in the response[optional]
others	Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]
print_on_error	Logical. Whether to show an error message when a network error occurs.
retry_time	Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.
network_timeout	Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.
region	Character. The region of the AWS service.

Value

A list object or a character vector

AvailabilityZone

The Availability Zone in which to allocate the Dedicated Host.

Quantity

The number of Dedicated Hosts to allocate to your account with these parameters.

AutoPlacement

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. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

InstanceType

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.

If you want the Dedicated Hosts to support multiple instance types in a specific 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 Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

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

TagSpecification

The tags to apply to the Dedicated Host during creation.

HostRecovery

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

Default: off

aws.ecx documentation built on Jan. 27, 2022, 1:10 a.m.