Skip to main content

host

Gets or updates an individual host resource, use hosts to retrieve a list of resources or to create or delete a resource.

Overview

Namehost
TypeResource
DescriptionResource Type definition for AWS::EC2::Host
Idaws.ec2.host

Fields

NameDatatypeDescription
host_idstringID of the host created.
auto_placementstringIndicates 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.
availability_zonestringThe Availability Zone in which to allocate the Dedicated Host.
host_recoverystringIndicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default.
instance_typestringSpecifies 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.
instance_familystringSpecifies 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.
outpost_arnstringThe Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate the Dedicated Host.
host_maintenancestringAutomatically allocates a new dedicated host and moves your instances on to it if a degradation is detected on your current host.
asset_idstringThe ID of the Outpost hardware asset.
regionstringAWS region.

Methods

NameAccessible byRequired Params
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
get_resourceSELECTdata__Identifier, region

SELECT Example

SELECT
region,
host_id,
auto_placement,
availability_zone,
host_recovery,
instance_type,
instance_family,
outpost_arn,
host_maintenance,
asset_id
FROM aws.ec2.host
WHERE region = 'us-east-1' AND data__Identifier = '<HostId>';

Permissions

To operate on the host resource, the following permissions are required:

Read

ec2:DescribeHosts

Update

ec2:ModifyHosts,
ec2:DescribeHosts