instance_types

Creates, updates, deletes, gets or lists an instance_types resource.

Overview

Name	instance_types
Type	Resource
Id	aws.ec2.instance_types

Fields

The following fields are returned by SELECT queries:

get_instance_types_from_instance_requirements

Name	Datatype	Description
instance_type	string	The matching instance type.

describe_instance_type_offerings

Name	Datatype	Description
instance_type	string	The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
location	string	The identifier for the location. This depends on the location type. For example, if the location type is region, the location is the Region code (for example, us-east-2.)
location_type	string	The location type.

describe_instance_types

Name	Datatype	Description
auto_recovery_supported	boolean	Indicates whether Amazon CloudWatch action based recovery is supported.
bare_metal	boolean	Indicates whether the instance is a bare metal instance type.
burstable_performance_supported	boolean	Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances.
current_generation	boolean	Indicates whether the instance type is current generation.
dedicated_hosts_supported	boolean	Indicates whether Dedicated Hosts are supported on the instance type.
ebs_info	string	Describes the Amazon EBS settings for the instance type.
fpga_info	string	Describes the FPGA accelerator settings for the instance type.
free_tier_eligible	boolean	Indicates whether the instance type is eligible for the free tier.
gpu_info	string	Describes the GPU accelerator settings for the instance type.
hibernation_supported	boolean	Indicates whether On-Demand hibernation is supported.
hypervisor	string	The hypervisor for the instance type.
inference_accelerator_info	string	Describes the Inference accelerator settings for the instance type.
instance_storage_info	string	Describes the instance storage for the instance type.
instance_storage_supported	boolean	Indicates whether instance storage is supported.
instance_type	string	The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
media_accelerator_info	string	Describes the media accelerator settings for the instance type.
memory_info	string	Describes the memory for the instance type.
network_info	string	Describes the network settings for the instance type.
neuron_info	string	Describes the Neuron accelerator settings for the instance type.
nitro_enclaves_support	string	Indicates whether Nitro Enclaves is supported.
nitro_tpm_info	string	Describes the supported NitroTPM versions for the instance type.
nitro_tpm_support	string	Indicates whether NitroTPM is supported.
phc_support	string	Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.
placement_group_info	string	Describes the placement group settings for the instance type.
processor_info	string	Describes the processor.
reboot_migration_support	string	Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled system-reboot event. For more information, see Enable or disable reboot migration in the Amazon EC2 User Guide.
supported_boot_modes	string	The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.
supported_in_region	boolean	Indicates whether the instance type is supported in the current Region.
supported_root_device_types	string	The supported root device types.
supported_usage_classes	string	Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.
supported_virtualization_types	string	The supported virtualization types.
v_cpu_info	string	Describes the vCPU configurations for the instance type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_instance_types_from_instance_requirements	select	ArchitectureType, VirtualizationType, InstanceRequirements, region	DryRun, MaxResults, NextToken, Context	Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity. When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values. For more information, see Preview instance types with specified attributes, Specify attributes for instance type selection for EC2 Fleet or Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating mixed instance groups using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.
describe_instance_type_offerings	select	LocationType, region	DryRun, Filter, MaxResults, NextToken	Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.
describe_instance_types	select	region	DryRun, InstanceType, Filter, MaxResults, NextToken, IncludeUnsupportedInRegion	Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results. To include instance types that are not supported in the current Region, set IncludeUnsupportedInRegion to true.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ArchitectureType	array	The processor architecture type.
InstanceRequirements	object	The attributes required for the instance types.
LocationType	string	The location type. availability-zone - The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region. availability-zone-id - The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region. outpost - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region. region - The current Region. If you specify a location filter, it must match the current Region.
VirtualizationType	array	The virtualization type.
region	string	AWS region (default: us-east-1)
Context	string	Reserved.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	One or more filters. Filter names and values are case-sensitive. auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false). bare-metal - Indicates whether it is a bare metal instance type (true | false). burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false). current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false). dedicated-hosts-supported - Indicates whether the instance type supports Dedicated Hosts. (true | false) ebs-info.attachment-limit-type - The type of Amazon EBS volume attachment limit (shared | dedicated). ebs-info.maximum-ebs-attachments - The maximum number of Amazon EBS volumes that can be attached to the instance type. ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type. ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type. ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s. ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default). ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported). ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported). free-tier-eligible - A Boolean that indicates whether this instance type can be used under the Amazon Web Services Free Tier (true | false). hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false). hypervisor - The hypervisor (nitro | xen). instance-storage-info.disk.count - The number of local disks. instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB. instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd). instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported). instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported). instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB. instance-storage-supported - Indicates whether the instance type has local instance storage (true | false). instance-type - The instance type (for example c5.2xlarge or c5*). memory-info.size-in-mib - The memory size. network-info.bandwidth-weightings - For instances that support bandwidth weighting to boost performance (default, vpc-1, ebs-1). network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance. network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false). network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported). network-info.flexible-ena-queues-support - Indicates whether an instance supports flexible ENA queues (supported | unsupported). network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false). network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface. network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface. network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false). network-info.maximum-network-cards - The maximum number of network cards per instance. network-info.maximum-network-interfaces - The maximum number of network interfaces per instance. network-info.network-performance - The network performance (for example, "25 Gigabit"). nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported). nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported). nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0). processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64). processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz. processor-info.supported-features - The supported CPU features (amd-sev-snp). reboot-migration-support - Indicates whether enabling reboot migration is supported (supported | unsupported). supported-boot-mode - The boot mode (legacy-bios | uefi). supported-root-device-type - The root device type (ebs | instance-store). supported-usage-class - The usage class (on-demand | spot | capacity-block). supported-virtualization-type - The virtualization type (hvm | paravirtual). vcpu-info.default-cores - The default number of cores for the instance type. vcpu-info.default-threads-per-core - The default number of threads per core for the instance type. vcpu-info.default-vcpus - The default number of vCPUs for the instance type. vcpu-info.valid-cores - The number of cores that can be configured for the instance type. vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
IncludeUnsupportedInRegion	boolean	If true, the response includes instance types that are not supported in the current Region, in addition to the supported types. Default: false.
InstanceType	array	The instance types.
MaxResults	integer	The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
NextToken	string	The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

SELECT examples

get_instance_types_from_instance_requirements

Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity. When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values. For more information, see Preview instance types with specified attributes, Specify attributes for instance type selection for EC2 Fleet or Spot Fleet, and Spot placement score in the Amazon EC2 User Guide, and Creating mixed instance groups using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.

SELECT
instance_type
FROM aws.ec2.instance_types
WHERE ArchitectureType = '{{ ArchitectureType }}' -- required
AND VirtualizationType = '{{ VirtualizationType }}' -- required
AND InstanceRequirements = '{{ InstanceRequirements }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND Context = '{{ Context }}'
;

describe_instance_type_offerings

Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region.

SELECT
instance_type,
location,
location_type
FROM aws.ec2.instance_types
WHERE LocationType = '{{ LocationType }}' -- required
AND region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

describe_instance_types

Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results. To include instance types that are not supported in the current Region, set IncludeUnsupportedInRegion to true.

SELECT
auto_recovery_supported,
bare_metal,
burstable_performance_supported,
current_generation,
dedicated_hosts_supported,
ebs_info,
fpga_info,
free_tier_eligible,
gpu_info,
hibernation_supported,
hypervisor,
inference_accelerator_info,
instance_storage_info,
instance_storage_supported,
instance_type,
media_accelerator_info,
memory_info,
network_info,
neuron_info,
nitro_enclaves_support,
nitro_tpm_info,
nitro_tpm_support,
phc_support,
placement_group_info,
processor_info,
reboot_migration_support,
supported_boot_modes,
supported_in_region,
supported_root_device_types,
supported_usage_classes,
supported_virtualization_types,
v_cpu_info
FROM aws.ec2.instance_types
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND InstanceType = '{{ InstanceType }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND IncludeUnsupportedInRegion = '{{ IncludeUnsupportedInRegion }}'
;