Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see EC2 Fleet in the Amazon EC2 User Guide .
See also: AWS API Documentation
create-fleet
[--dry-run | --no-dry-run]
[--client-token <value>]
[--spot-options <value>]
[--on-demand-options <value>]
[--excess-capacity-termination-policy <value>]
--launch-template-configs <value>
--target-capacity-specification <value>
[--terminate-instances-with-expiration | --no-terminate-instances-with-expiration]
[--type <value>]
[--valid-from <value>]
[--valid-until <value>]
[--replace-unhealthy-instances | --no-replace-unhealthy-instances]
[--tag-specifications <value>]
[--context <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--dry-run
| --no-dry-run
(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 isUnauthorizedOperation
.
--client-token
(string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency .
--spot-options
(structure)
Describes the configuration of Spot Instances in an EC2 Fleet.
AllocationStrategy -> (string)
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide .
price-capacity-optimized (recommended)
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
capacity-optimized
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use
capacity-optimized-prioritized
. Set a priority for each instance type by using thePriority
parameter forLaunchTemplateOverrides
. You can assign the same priority to differentLaunchTemplateOverrides
. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first.capacity-optimized-prioritized
is supported only if your EC2 Fleet uses a launch template. Note that if the On-DemandAllocationStrategy
is set toprioritized
, the same priority is applied when fulfilling On-Demand capacity.diversified
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
lowest-price
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn’t have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default:
lowest-price
MaintenanceStrategies -> (structure)
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
CapacityRebalance -> (structure)
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
ReplacementStrategy -> (string)
The replacement strategy to use. Only available for fleets of type
maintain
.
launch
- EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate
- EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (inTerminationDelay
), terminates the instances that received a rebalance notification.TerminationDelay -> (integer)
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when
ReplacementStrategy
is set tolaunch-before-terminate
.Not valid when
ReplacementStrategy
is set tolaunch
.Valid values: Minimum value of
120
seconds. Maximum value of7200
seconds.InstanceInterruptionBehavior -> (string)
The behavior when a Spot Instance is interrupted.
Default:
terminate
InstancePoolsToUseCount -> (integer)
The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot
AllocationStrategy
is set tolowest-price
. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
SingleInstanceType -> (boolean)
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type
instant
.SingleAvailabilityZone -> (boolean)
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type
instant
.MinTargetCapacity -> (integer)
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type
instant
.At least one of the following must be specified:
SingleAvailabilityZone
|SingleInstanceType
MaxTotalPrice -> (string)
The maximum amount per hour for Spot Instances that you’re willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
Warning
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
Shorthand Syntax:
AllocationStrategy=string,MaintenanceStrategies={CapacityRebalance={ReplacementStrategy=string,TerminationDelay=integer}},InstanceInterruptionBehavior=string,InstancePoolsToUseCount=integer,SingleInstanceType=boolean,SingleAvailabilityZone=boolean,MinTargetCapacity=integer,MaxTotalPrice=stringJSON Syntax:
{ "AllocationStrategy": "lowest-price"|"diversified"|"capacity-optimized"|"capacity-optimized-prioritized"|"price-capacity-optimized", "MaintenanceStrategies": { "CapacityRebalance": { "ReplacementStrategy": "launch"|"launch-before-terminate", "TerminationDelay": integer } }, "InstanceInterruptionBehavior": "hibernate"|"stop"|"terminate", "InstancePoolsToUseCount": integer, "SingleInstanceType": true|false, "SingleAvailabilityZone": true|false, "MinTargetCapacity": integer, "MaxTotalPrice": "string" }
--on-demand-options
(structure)Describes the configuration of On-Demand Instances in an EC2 Fleet.
AllocationStrategy -> (string)
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price
- EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized
- EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.Default:
lowest-price
CapacityReservationOptions -> (structure)
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type
instant
.UsageStrategy -> (string)
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
If you specify
use-capacity-reservations-first
, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (lowest-price
orprioritized
) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
orprioritized
).If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
SingleInstanceType -> (boolean)
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type
instant
.SingleAvailabilityZone -> (boolean)
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type
instant
.MinTargetCapacity -> (integer)
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type
instant
.At least one of the following must be specified:
SingleAvailabilityZone
|SingleInstanceType
MaxTotalPrice -> (string)
The maximum amount per hour for On-Demand Instances that you’re willing to pay.
Shorthand Syntax:
AllocationStrategy=string,CapacityReservationOptions={UsageStrategy=string},SingleInstanceType=boolean,SingleAvailabilityZone=boolean,MinTargetCapacity=integer,MaxTotalPrice=stringJSON Syntax:
{ "AllocationStrategy": "lowest-price"|"prioritized", "CapacityReservationOptions": { "UsageStrategy": "use-capacity-reservations-first" }, "SingleInstanceType": true|false, "SingleAvailabilityZone": true|false, "MinTargetCapacity": integer, "MaxTotalPrice": "string" }
--excess-capacity-termination-policy
(string)Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Possible values:
no-termination
termination
--launch-template-configs
(list)The configuration for the EC2 Fleet.
(structure)
Describes a launch template and overrides.
LaunchTemplateSpecification -> (structure)
The launch template to use. You must specify either the launch template ID or launch template name in the request.
LaunchTemplateId -> (string)
The ID of the launch template.
You must specify the
LaunchTemplateId
or theLaunchTemplateName
, but not both.LaunchTemplateName -> (string)
The name of the launch template.
You must specify the
LaunchTemplateName
or theLaunchTemplateId
, but not both.Version -> (string)
The launch template version number,
$Latest
, or$Default
. You must specify a value, otherwise the request fails.If the value is
$Latest
, Amazon EC2 uses the latest version of the launch template.If the value is
$Default
, Amazon EC2 uses the default version of the launch template.Overrides -> (list)
Any parameters that you specify override the same parameters in the launch template.
For fleets of type
request
andmaintain
, a maximum of 300 items is allowed across all launch templates.(structure)
Describes overrides for a launch template.
InstanceType -> (string)
The instance type.
Note
If you specify
InstanceType
, you can’t specifyInstanceRequirements
.MaxPrice -> (string)
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
Warning
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
SubnetId -> (string)
The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example,
subnet-1234abcdeexample1, subnet-0987cdef6example2
). A request of typeinstant
can have only one subnet ID.AvailabilityZone -> (string)
The Availability Zone in which to launch the instances.
WeightedCapacity -> (double)
The number of units provided by the specified instance type.
Priority -> (double)
The priority for the launch template override. The highest priority is launched first.
If the On-Demand
AllocationStrategy
is set toprioritized
, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.If the Spot
AllocationStrategy
is set tocapacity-optimized-prioritized
, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.Valid values are whole numbers starting at
0
. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.Placement -> (structure)
The location where the instance launched, if applicable.
AvailabilityZone -> (string)
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for CreateFleet .
Affinity -> (string)
The affinity setting for the instance on the Dedicated Host.
This parameter is not supported for CreateFleet or ImportInstance .
GroupName -> (string)
The name of the placement group that the instance is in. If you specify
GroupName
, you can’t specifyGroupId
.PartitionNumber -> (integer)
The number of the partition that the instance is in. Valid only if the placement group strategy is set to
partition
.This parameter is not supported for CreateFleet .
HostId -> (string)
The ID of the Dedicated Host on which the instance resides.
This parameter is not supported for CreateFleet or ImportInstance .
Tenancy -> (string)
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of
dedicated
runs on single-tenant hardware.This parameter is not supported for CreateFleet . The
host
tenancy is not supported for ImportInstance or for T3 instances that are configured for theunlimited
CPU credit option.SpreadDomain -> (string)
Reserved for future use.
HostResourceGroupArn -> (string)
The ARN of the host resource group in which to launch the instances.
If you specify this parameter, either omit the Tenancy parameter or set it to
host
.This parameter is not supported for CreateFleet .
GroupId -> (string)
The ID of the placement group that the instance is in. If you specify
GroupId
, you can’t specifyGroupName
.InstanceRequirements -> (structure)
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
Note
If you specify
InstanceRequirements
, you can’t specifyInstanceType
.VCpuCount -> (structure)
The minimum and maximum number of vCPUs.
Min -> (integer)
The minimum number of vCPUs. To specify no minimum limit, specify
0
.Max -> (integer)
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.
MemoryMiB -> (structure)
The minimum and maximum amount of memory, in MiB.
Min -> (integer)
The minimum amount of memory, in MiB. To specify no minimum limit, specify
0
.Max -> (integer)
The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.
CpuManufacturers -> (list)
The CPU manufacturers to include.
For instance types with Intel CPUs, specify
intel
.For instance types with AMD CPUs, specify
amd
.For instance types with Amazon Web Services CPUs, specify
amazon-web-services
.Note
Don’t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
(string)
MemoryGiBPerVCpu -> (structure)
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.
Max -> (double)
The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.
ExcludedInstanceTypes -> (list)
The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to exclude an instance family, type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.Note
If you specify
ExcludedInstanceTypes
, you can’t specifyAllowedInstanceTypes
.Default: No excluded instance types
(string)
InstanceGenerations -> (list)
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide .
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation instance types
(string)
SpotMaxPricePercentageOverLowestPrice -> (integer)
The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements .
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
100
OnDemandMaxPricePercentageOverLowestPrice -> (integer)
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements .
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
20
BareMetal -> (string)
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify
included
.To require only bare metal instance types, specify
required
.To exclude bare metal instance types, specify
excluded
.Default:
excluded
BurstablePerformance -> (string)
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances .
To include burstable performance instance types, specify
included
.To require only burstable performance instance types, specify
required
.To exclude burstable performance instance types, specify
excluded
.Default:
excluded
RequireHibernateSupport -> (boolean)
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores .
Default:
false
NetworkInterfaceCount -> (structure)
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Min -> (integer)
The minimum number of network interfaces. To specify no minimum limit, omit this parameter.
Max -> (integer)
The maximum number of network interfaces. To specify no maximum limit, omit this parameter.
LocalStorage -> (string)
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide .
To include instance types with instance store volumes, specify
included
.To require only instance types with instance store volumes, specify
required
.To exclude instance types with instance store volumes, specify
excluded
.Default:
included
LocalStorageTypes -> (list)
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify
hdd
.For instance types with solid state drive (SSD) storage, specify
ssd
.Default:
hdd
andssd
(string)
TotalLocalStorageGB -> (structure)
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.
Max -> (double)
The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.
BaselineEbsBandwidthMbps -> (structure)
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide .
Default: No minimum or maximum limits
Min -> (integer)
The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.
Max -> (integer)
The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.
AcceleratorTypes -> (list)
The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify
gpu
.To include instance types with FPGA hardware, specify
fpga
.To include instance types with inference hardware, specify
inference
.Default: Any accelerator type
(string)
AcceleratorCount -> (structure)
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set
Max
to0
.Default: No minimum or maximum limits
Min -> (integer)
The minimum number of accelerators. To specify no minimum limit, omit this parameter.
Max -> (integer)
The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set
Max
to0
.AcceleratorManufacturers -> (list)
Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify
nvidia
.For instance types with AMD devices, specify
amd
.For instance types with Amazon Web Services devices, specify
amazon-web-services
.For instance types with Xilinx devices, specify
xilinx
.Default: Any manufacturer
(string)
AcceleratorNames -> (list)
The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify
a100
.For instance types with NVIDIA V100 GPUs, specify
v100
.For instance types with NVIDIA K80 GPUs, specify
k80
.For instance types with NVIDIA T4 GPUs, specify
t4
.For instance types with NVIDIA M60 GPUs, specify
m60
.For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520
.For instance types with Xilinx VU9P FPGAs, specify
vu9p
.For instance types with Amazon Web Services Inferentia chips, specify
inferentia
.For instance types with NVIDIA GRID K520 GPUs, specify
k520
.Default: Any accelerator
(string)
AcceleratorTotalMemoryMiB -> (structure)
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Min -> (integer)
The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.
Max -> (integer)
The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.
NetworkBandwidthGbps -> (structure)
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.
Max -> (double)
The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.
AllowedInstanceTypes -> (list)
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to allow an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.Note
If you specify
AllowedInstanceTypes
, you can’t specifyExcludedInstanceTypes
.Default: All instance types
(string)
ImageId -> (string)
The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.
JSON Syntax:
[ { "LaunchTemplateSpecification": { "LaunchTemplateId": "string", "LaunchTemplateName": "string", "Version": "string" }, "Overrides": [ { "InstanceType": "a1.medium"|"a1.large"|"a1.xlarge"|"a1.2xlarge"|"a1.4xlarge"|"a1.metal"|"c1.medium"|"c1.xlarge"|"c3.large"|"c3.xlarge"|"c3.2xlarge"|"c3.4xlarge"|"c3.8xlarge"|"c4.large"|"c4.xlarge"|"c4.2xlarge"|"c4.4xlarge"|"c4.8xlarge"|"c5.large"|"c5.xlarge"|"c5.2xlarge"|"c5.4xlarge"|"c5.9xlarge"|"c5.12xlarge"|"c5.18xlarge"|"c5.24xlarge"|"c5.metal"|"c5a.large"|"c5a.xlarge"|"c5a.2xlarge"|"c5a.4xlarge"|"c5a.8xlarge"|"c5a.12xlarge"|"c5a.16xlarge"|"c5a.24xlarge"|"c5ad.large"|"c5ad.xlarge"|"c5ad.2xlarge"|"c5ad.4xlarge"|"c5ad.8xlarge"|"c5ad.12xlarge"|"c5ad.16xlarge"|"c5ad.24xlarge"|"c5d.large"|"c5d.xlarge"|"c5d.2xlarge"|"c5d.4xlarge"|"c5d.9xlarge"|"c5d.12xlarge"|"c5d.18xlarge"|"c5d.24xlarge"|"c5d.metal"|"c5n.large"|"c5n.xlarge"|"c5n.2xlarge"|"c5n.4xlarge"|"c5n.9xlarge"|"c5n.18xlarge"|"c5n.metal"|"c6g.medium"|"c6g.large"|"c6g.xlarge"|"c6g.2xlarge"|"c6g.4xlarge"|"c6g.8xlarge"|"c6g.12xlarge"|"c6g.16xlarge"|"c6g.metal"|"c6gd.medium"|"c6gd.large"|"c6gd.xlarge"|"c6gd.2xlarge"|"c6gd.4xlarge"|"c6gd.8xlarge"|"c6gd.12xlarge"|"c6gd.16xlarge"|"c6gd.metal"|"c6gn.medium"|"c6gn.large"|"c6gn.xlarge"|"c6gn.2xlarge"|"c6gn.4xlarge"|"c6gn.8xlarge"|"c6gn.12xlarge"|"c6gn.16xlarge"|"c6i.large"|"c6i.xlarge"|"c6i.2xlarge"|"c6i.4xlarge"|"c6i.8xlarge"|"c6i.12xlarge"|"c6i.16xlarge"|"c6i.24xlarge"|"c6i.32xlarge"|"c6i.metal"|"cc1.4xlarge"|"cc2.8xlarge"|"cg1.4xlarge"|"cr1.8xlarge"|"d2.xlarge"|"d2.2xlarge"|"d2.4xlarge"|"d2.8xlarge"|"d3.xlarge"|"d3.2xlarge"|"d3.4xlarge"|"d3.8xlarge"|"d3en.xlarge"|"d3en.2xlarge"|"d3en.4xlarge"|"d3en.6xlarge"|"d3en.8xlarge"|"d3en.12xlarge"|"dl1.24xlarge"|"f1.2xlarge"|"f1.4xlarge"|"f1.16xlarge"|"g2.2xlarge"|"g2.8xlarge"|"g3.4xlarge"|"g3.8xlarge"|"g3.16xlarge"|"g3s.xlarge"|"g4ad.xlarge"|"g4ad.2xlarge"|"g4ad.4xlarge"|"g4ad.8xlarge"|"g4ad.16xlarge"|"g4dn.xlarge"|"g4dn.2xlarge"|"g4dn.4xlarge"|"g4dn.8xlarge"|"g4dn.12xlarge"|"g4dn.16xlarge"|"g4dn.metal"|"g5.xlarge"|"g5.2xlarge"|"g5.4xlarge"|"g5.8xlarge"|"g5.12xlarge"|"g5.16xlarge"|"g5.24xlarge"|"g5.48xlarge"|"g5g.xlarge"|"g5g.2xlarge"|"g5g.4xlarge"|"g5g.8xlarge"|"g5g.16xlarge"|"g5g.metal"|"hi1.4xlarge"|"hpc6a.48xlarge"|"hs1.8xlarge"|"h1.2xlarge"|"h1.4xlarge"|"h1.8xlarge"|"h1.16xlarge"|"i2.xlarge"|"i2.2xlarge"|"i2.4xlarge"|"i2.8xlarge"|"i3.large"|"i3.xlarge"|"i3.2xlarge"|"i3.4xlarge"|"i3.8xlarge"|"i3.16xlarge"|"i3.metal"|"i3en.large"|"i3en.xlarge"|"i3en.2xlarge"|"i3en.3xlarge"|"i3en.6xlarge"|"i3en.12xlarge"|"i3en.24xlarge"|"i3en.metal"|"im4gn.large"|"im4gn.xlarge"|"im4gn.2xlarge"|"im4gn.4xlarge"|"im4gn.8xlarge"|"im4gn.16xlarge"|"inf1.xlarge"|"inf1.2xlarge"|"inf1.6xlarge"|"inf1.24xlarge"|"is4gen.medium"|"is4gen.large"|"is4gen.xlarge"|"is4gen.2xlarge"|"is4gen.4xlarge"|"is4gen.8xlarge"|"m1.small"|"m1.medium"|"m1.large"|"m1.xlarge"|"m2.xlarge"|"m2.2xlarge"|"m2.4xlarge"|"m3.medium"|"m3.large"|"m3.xlarge"|"m3.2xlarge"|"m4.large"|"m4.xlarge"|"m4.2xlarge"|"m4.4xlarge"|"m4.10xlarge"|"m4.16xlarge"|"m5.large"|"m5.xlarge"|"m5.2xlarge"|"m5.4xlarge"|"m5.8xlarge"|"m5.12xlarge"|"m5.16xlarge"|"m5.24xlarge"|"m5.metal"|"m5a.large"|"m5a.xlarge"|"m5a.2xlarge"|"m5a.4xlarge"|"m5a.8xlarge"|"m5a.12xlarge"|"m5a.16xlarge"|"m5a.24xlarge"|"m5ad.large"|"m5ad.xlarge"|"m5ad.2xlarge"|"m5ad.4xlarge"|"m5ad.8xlarge"|"m5ad.12xlarge"|"m5ad.16xlarge"|"m5ad.24xlarge"|"m5d.large"|"m5d.xlarge"|"m5d.2xlarge"|"m5d.4xlarge"|"m5d.8xlarge"|"m5d.12xlarge"|"m5d.16xlarge"|"m5d.24xlarge"|"m5d.metal"|"m5dn.large"|"m5dn.xlarge"|"m5dn.2xlarge"|"m5dn.4xlarge"|"m5dn.8xlarge"|"m5dn.12xlarge"|"m5dn.16xlarge"|"m5dn.24xlarge"|"m5dn.metal"|"m5n.large"|"m5n.xlarge"|"m5n.2xlarge"|"m5n.4xlarge"|"m5n.8xlarge"|"m5n.12xlarge"|"m5n.16xlarge"|"m5n.24xlarge"|"m5n.metal"|"m5zn.large"|"m5zn.xlarge"|"m5zn.2xlarge"|"m5zn.3xlarge"|"m5zn.6xlarge"|"m5zn.12xlarge"|"m5zn.metal"|"m6a.large"|"m6a.xlarge"|"m6a.2xlarge"|"m6a.4xlarge"|"m6a.8xlarge"|"m6a.12xlarge"|"m6a.16xlarge"|"m6a.24xlarge"|"m6a.32xlarge"|"m6a.48xlarge"|"m6g.metal"|"m6g.medium"|"m6g.large"|"m6g.xlarge"|"m6g.2xlarge"|"m6g.4xlarge"|"m6g.8xlarge"|"m6g.12xlarge"|"m6g.16xlarge"|"m6gd.metal"|"m6gd.medium"|"m6gd.large"|"m6gd.xlarge"|"m6gd.2xlarge"|"m6gd.4xlarge"|"m6gd.8xlarge"|"m6gd.12xlarge"|"m6gd.16xlarge"|"m6i.large"|"m6i.xlarge"|"m6i.2xlarge"|"m6i.4xlarge"|"m6i.8xlarge"|"m6i.12xlarge"|"m6i.16xlarge"|"m6i.24xlarge"|"m6i.32xlarge"|"m6i.metal"|"mac1.metal"|"p2.xlarge"|"p2.8xlarge"|"p2.16xlarge"|"p3.2xlarge"|"p3.8xlarge"|"p3.16xlarge"|"p3dn.24xlarge"|"p4d.24xlarge"|"r3.large"|"r3.xlarge"|"r3.2xlarge"|"r3.4xlarge"|"r3.8xlarge"|"r4.large"|"r4.xlarge"|"r4.2xlarge"|"r4.4xlarge"|"r4.8xlarge"|"r4.16xlarge"|"r5.large"|"r5.xlarge"|"r5.2xlarge"|"r5.4xlarge"|"r5.8xlarge"|"r5.12xlarge"|"r5.16xlarge"|"r5.24xlarge"|"r5.metal"|"r5a.large"|"r5a.xlarge"|"r5a.2xlarge"|"r5a.4xlarge"|"r5a.8xlarge"|"r5a.12xlarge"|"r5a.16xlarge"|"r5a.24xlarge"|"r5ad.large"|"r5ad.xlarge"|"r5ad.2xlarge"|"r5ad.4xlarge"|"r5ad.8xlarge"|"r5ad.12xlarge"|"r5ad.16xlarge"|"r5ad.24xlarge"|"r5b.large"|"r5b.xlarge"|"r5b.2xlarge"|"r5b.4xlarge"|"r5b.8xlarge"|"r5b.12xlarge"|"r5b.16xlarge"|"r5b.24xlarge"|"r5b.metal"|"r5d.large"|"r5d.xlarge"|"r5d.2xlarge"|"r5d.4xlarge"|"r5d.8xlarge"|"r5d.12xlarge"|"r5d.16xlarge"|"r5d.24xlarge"|"r5d.metal"|"r5dn.large"|"r5dn.xlarge"|"r5dn.2xlarge"|"r5dn.4xlarge"|"r5dn.8xlarge"|"r5dn.12xlarge"|"r5dn.16xlarge"|"r5dn.24xlarge"|"r5dn.metal"|"r5n.large"|"r5n.xlarge"|"r5n.2xlarge"|"r5n.4xlarge"|"r5n.8xlarge"|"r5n.12xlarge"|"r5n.16xlarge"|"r5n.24xlarge"|"r5n.metal"|"r6g.medium"|"r6g.large"|"r6g.xlarge"|"r6g.2xlarge"|"r6g.4xlarge"|"r6g.8xlarge"|"r6g.12xlarge"|"r6g.16xlarge"|"r6g.metal"|"r6gd.medium"|"r6gd.large"|"r6gd.xlarge"|"r6gd.2xlarge"|"r6gd.4xlarge"|"r6gd.8xlarge"|"r6gd.12xlarge"|"r6gd.16xlarge"|"r6gd.metal"|"r6i.large"|"r6i.xlarge"|"r6i.2xlarge"|"r6i.4xlarge"|"r6i.8xlarge"|"r6i.12xlarge"|"r6i.16xlarge"|"r6i.24xlarge"|"r6i.32xlarge"|"r6i.metal"|"t1.micro"|"t2.nano"|"t2.micro"|"t2.small"|"t2.medium"|"t2.large"|"t2.xlarge"|"t2.2xlarge"|"t3.nano"|"t3.micro"|"t3.small"|"t3.medium"|"t3.large"|"t3.xlarge"|"t3.2xlarge"|"t3a.nano"|"t3a.micro"|"t3a.small"|"t3a.medium"|"t3a.large"|"t3a.xlarge"|"t3a.2xlarge"|"t4g.nano"|"t4g.micro"|"t4g.small"|"t4g.medium"|"t4g.large"|"t4g.xlarge"|"t4g.2xlarge"|"u-6tb1.56xlarge"|"u-6tb1.112xlarge"|"u-9tb1.112xlarge"|"u-12tb1.112xlarge"|"u-6tb1.metal"|"u-9tb1.metal"|"u-12tb1.metal"|"u-18tb1.metal"|"u-24tb1.metal"|"vt1.3xlarge"|"vt1.6xlarge"|"vt1.24xlarge"|"x1.16xlarge"|"x1.32xlarge"|"x1e.xlarge"|"x1e.2xlarge"|"x1e.4xlarge"|"x1e.8xlarge"|"x1e.16xlarge"|"x1e.32xlarge"|"x2iezn.2xlarge"|"x2iezn.4xlarge"|"x2iezn.6xlarge"|"x2iezn.8xlarge"|"x2iezn.12xlarge"|"x2iezn.metal"|"x2gd.medium"|"x2gd.large"|"x2gd.xlarge"|"x2gd.2xlarge"|"x2gd.4xlarge"|"x2gd.8xlarge"|"x2gd.12xlarge"|"x2gd.16xlarge"|"x2gd.metal"|"z1d.large"|"z1d.xlarge"|"z1d.2xlarge"|"z1d.3xlarge"|"z1d.6xlarge"|"z1d.12xlarge"|"z1d.metal"|"x2idn.16xlarge"|"x2idn.24xlarge"|"x2idn.32xlarge"|"x2iedn.xlarge"|"x2iedn.2xlarge"|"x2iedn.4xlarge"|"x2iedn.8xlarge"|"x2iedn.16xlarge"|"x2iedn.24xlarge"|"x2iedn.32xlarge"|"c6a.large"|"c6a.xlarge"|"c6a.2xlarge"|"c6a.4xlarge"|"c6a.8xlarge"|"c6a.12xlarge"|"c6a.16xlarge"|"c6a.24xlarge"|"c6a.32xlarge"|"c6a.48xlarge"|"c6a.metal"|"m6a.metal"|"i4i.large"|"i4i.xlarge"|"i4i.2xlarge"|"i4i.4xlarge"|"i4i.8xlarge"|"i4i.16xlarge"|"i4i.32xlarge"|"i4i.metal"|"x2idn.metal"|"x2iedn.metal"|"c7g.medium"|"c7g.large"|"c7g.xlarge"|"c7g.2xlarge"|"c7g.4xlarge"|"c7g.8xlarge"|"c7g.12xlarge"|"c7g.16xlarge"|"mac2.metal"|"c6id.large"|"c6id.xlarge"|"c6id.2xlarge"|"c6id.4xlarge"|"c6id.8xlarge"|"c6id.12xlarge"|"c6id.16xlarge"|"c6id.24xlarge"|"c6id.32xlarge"|"c6id.metal"|"m6id.large"|"m6id.xlarge"|"m6id.2xlarge"|"m6id.4xlarge"|"m6id.8xlarge"|"m6id.12xlarge"|"m6id.16xlarge"|"m6id.24xlarge"|"m6id.32xlarge"|"m6id.metal"|"r6id.large"|"r6id.xlarge"|"r6id.2xlarge"|"r6id.4xlarge"|"r6id.8xlarge"|"r6id.12xlarge"|"r6id.16xlarge"|"r6id.24xlarge"|"r6id.32xlarge"|"r6id.metal"|"r6a.large"|"r6a.xlarge"|"r6a.2xlarge"|"r6a.4xlarge"|"r6a.8xlarge"|"r6a.12xlarge"|"r6a.16xlarge"|"r6a.24xlarge"|"r6a.32xlarge"|"r6a.48xlarge"|"r6a.metal"|"p4de.24xlarge"|"u-3tb1.56xlarge"|"u-18tb1.112xlarge"|"u-24tb1.112xlarge"|"trn1.2xlarge"|"trn1.32xlarge"|"hpc6id.32xlarge"|"c6in.large"|"c6in.xlarge"|"c6in.2xlarge"|"c6in.4xlarge"|"c6in.8xlarge"|"c6in.12xlarge"|"c6in.16xlarge"|"c6in.24xlarge"|"c6in.32xlarge"|"m6in.large"|"m6in.xlarge"|"m6in.2xlarge"|"m6in.4xlarge"|"m6in.8xlarge"|"m6in.12xlarge"|"m6in.16xlarge"|"m6in.24xlarge"|"m6in.32xlarge"|"m6idn.large"|"m6idn.xlarge"|"m6idn.2xlarge"|"m6idn.4xlarge"|"m6idn.8xlarge"|"m6idn.12xlarge"|"m6idn.16xlarge"|"m6idn.24xlarge"|"m6idn.32xlarge"|"r6in.large"|"r6in.xlarge"|"r6in.2xlarge"|"r6in.4xlarge"|"r6in.8xlarge"|"r6in.12xlarge"|"r6in.16xlarge"|"r6in.24xlarge"|"r6in.32xlarge"|"r6idn.large"|"r6idn.xlarge"|"r6idn.2xlarge"|"r6idn.4xlarge"|"r6idn.8xlarge"|"r6idn.12xlarge"|"r6idn.16xlarge"|"r6idn.24xlarge"|"r6idn.32xlarge", "MaxPrice": "string", "SubnetId": "string", "AvailabilityZone": "string", "WeightedCapacity": double, "Priority": double, "Placement": { "AvailabilityZone": "string", "Affinity": "string", "GroupName": "string", "PartitionNumber": integer, "HostId": "string", "Tenancy": "default"|"dedicated"|"host", "SpreadDomain": "string", "HostResourceGroupArn": "string", "GroupId": "string" }, "InstanceRequirements": { "VCpuCount": { "Min": integer, "Max": integer }, "MemoryMiB": { "Min": integer, "Max": integer }, "CpuManufacturers": ["intel"|"amd"|"amazon-web-services", ...], "MemoryGiBPerVCpu": { "Min": double, "Max": double }, "ExcludedInstanceTypes": ["string", ...], "InstanceGenerations": ["current"|"previous", ...], "SpotMaxPricePercentageOverLowestPrice": integer, "OnDemandMaxPricePercentageOverLowestPrice": integer, "BareMetal": "included"|"required"|"excluded", "BurstablePerformance": "included"|"required"|"excluded", "RequireHibernateSupport": true|false, "NetworkInterfaceCount": { "Min": integer, "Max": integer }, "LocalStorage": "included"|"required"|"excluded", "LocalStorageTypes": ["hdd"|"ssd", ...], "TotalLocalStorageGB": { "Min": double, "Max": double }, "BaselineEbsBandwidthMbps": { "Min": integer, "Max": integer }, "AcceleratorTypes": ["gpu"|"fpga"|"inference", ...], "AcceleratorCount": { "Min": integer, "Max": integer }, "AcceleratorManufacturers": ["nvidia"|"amd"|"amazon-web-services"|"xilinx", ...], "AcceleratorNames": ["a100"|"v100"|"k80"|"t4"|"m60"|"radeon-pro-v520"|"vu9p"|"inferentia"|"k520", ...], "AcceleratorTotalMemoryMiB": { "Min": integer, "Max": integer }, "NetworkBandwidthGbps": { "Min": double, "Max": double }, "AllowedInstanceTypes": ["string", ...] }, "ImageId": "string" } ... ] } ... ]
--target-capacity-specification
(structure)The number of units to request.
TotalTargetCapacity -> (integer)
The number of units to request, filled using
DefaultTargetCapacityType
.OnDemandTargetCapacity -> (integer)
The number of On-Demand units to request.
SpotTargetCapacity -> (integer)
The number of Spot units to request.
DefaultTargetCapacityType -> (string)
The default
TotalTargetCapacity
, which is eitherSpot
orOn-Demand
.TargetCapacityUnitType -> (string)
The unit for the target capacity.
TargetCapacityUnitType
can only be specified whenInstanceRequirements
is specified.Default:
units
(translates to number of instances)Shorthand Syntax:
TotalTargetCapacity=integer,OnDemandTargetCapacity=integer,SpotTargetCapacity=integer,DefaultTargetCapacityType=string,TargetCapacityUnitType=stringJSON Syntax:
{ "TotalTargetCapacity": integer, "OnDemandTargetCapacity": integer, "SpotTargetCapacity": integer, "DefaultTargetCapacityType": "spot"|"on-demand", "TargetCapacityUnitType": "vcpu"|"memory-mib"|"units" }
--terminate-instances-with-expiration
|--no-terminate-instances-with-expiration
(boolean)Indicates whether running instances should be terminated when the EC2 Fleet expires.
--type
(string)The fleet type. The default value is
maintain
.
maintain
- The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request
- The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant
- The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.For more information, see EC2 Fleet request types in the Amazon EC2 User Guide .
Possible values:
request
maintain
instant
--valid-from
(timestamp)The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
--valid-until
(timestamp)The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
--replace-unhealthy-instances
|--no-replace-unhealthy-instances
(boolean)Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type
maintain
. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide .
--tag-specifications
(list)The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging your resources .
If the fleet type is
instant
, specify a resource type offleet
to tag the fleet orinstance
to tag the instances at launch.If the fleet type is
maintain
orrequest
, specify a resource type offleet
to tag the fleet. You cannot specify a resource type ofinstance
. To tag instances at launch, specify the tags in a launch template .(structure)
The tags to apply to a resource when the resource is being created.
Note
The
Valid Values
lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.ResourceType -> (string)
The type of resource to tag on creation.
Tags -> (list)
The tags to apply to the resource.
(structure)
Describes a tag.
Key -> (string)
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with
aws:
.Value -> (string)
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Shorthand Syntax:
ResourceType=string,Tags=[{Key=string,Value=string},{Key=string,Value=string}] ...JSON Syntax:
[ { "ResourceType": "capacity-reservation"|"client-vpn-endpoint"|"customer-gateway"|"carrier-gateway"|"coip-pool"|"dedicated-host"|"dhcp-options"|"egress-only-internet-gateway"|"elastic-ip"|"elastic-gpu"|"export-image-task"|"export-instance-task"|"fleet"|"fpga-image"|"host-reservation"|"image"|"import-image-task"|"import-snapshot-task"|"instance"|"instance-event-window"|"internet-gateway"|"ipam"|"ipam-pool"|"ipam-scope"|"ipv4pool-ec2"|"ipv6pool-ec2"|"key-pair"|"launch-template"|"local-gateway"|"local-gateway-route-table"|"local-gateway-virtual-interface"|"local-gateway-virtual-interface-group"|"local-gateway-route-table-vpc-association"|"local-gateway-route-table-virtual-interface-group-association"|"natgateway"|"network-acl"|"network-interface"|"network-insights-analysis"|"network-insights-path"|"network-insights-access-scope"|"network-insights-access-scope-analysis"|"placement-group"|"prefix-list"|"replace-root-volume-task"|"reserved-instances"|"route-table"|"security-group"|"security-group-rule"|"snapshot"|"spot-fleet-request"|"spot-instances-request"|"subnet"|"subnet-cidr-reservation"|"traffic-mirror-filter"|"traffic-mirror-session"|"traffic-mirror-target"|"transit-gateway"|"transit-gateway-attachment"|"transit-gateway-connect-peer"|"transit-gateway-multicast-domain"|"transit-gateway-policy-table"|"transit-gateway-route-table"|"transit-gateway-route-table-announcement"|"volume"|"vpc"|"vpc-endpoint"|"vpc-endpoint-connection"|"vpc-endpoint-service"|"vpc-endpoint-service-permission"|"vpc-peering-connection"|"vpn-connection"|"vpn-gateway"|"vpc-flow-log"|"capacity-reservation-fleet"|"traffic-mirror-filter-rule"|"vpc-endpoint-connection-device-type"|"verified-access-instance"|"verified-access-group"|"verified-access-endpoint"|"verified-access-policy"|"verified-access-trust-provider"|"vpn-connection-device-type"|"vpc-block-public-access-exclusion"|"ipam-resource-discovery"|"ipam-resource-discovery-association", "Tags": [ { "Key": "string", "Value": "string" } ... ] } ... ]
--context
(string)Reserved.
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To create an EC2 Fleet that launches Spot Instances as the default purchasing model
The following
create-fleet
example creates an EC2 Fleet using the minimum parameters required to launch a fleet: a launch template, target capacity, and default purchasing model. The launch template is identified by its launch template ID and version number. The target capacity for the fleet is 2 instances, and the default purchasing model isspot
, which results in the fleet launching 2 Spot Instances.When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch.
aws ec2 create-fleet \ --cli-input-json file://file_name.jsonContents of file_name.json:
{ "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "spot" } }Output:
{ "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" }Example 2: To create an EC2 Fleet that launches On-Demand Instances as the default purchasing model
The following
create-fleet
example creates an EC2 Fleet using the minimum parameters required to launch a fleet: a launch template, target capacity, and default purchasing model. The launch template is identified by its launch template ID and version number. The target capacity for the fleet is 2 instances, and the default purchasing model ison-demand
, which results in the fleet launching 2 On-Demand Instances.When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch.
aws ec2 create-fleet \ --cli-input-json file://file_name.jsonContents of file_name.json:
{ "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "on-demand" } }Output:
{ "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" }Example 3: To create an EC2 Fleet that launches On-Demand Instances as the primary capacity
The following
create-fleet
example creates an EC2 Fleet that specifies the total target capacity of 2 instances for the fleet, and a target capacity of 1 On-Demand Instance. The default purchasing model isspot
. The fleet launches 1 On-Demand Instance as specified, but needs to launch one more instance to fulfil the total target capacity. The purchasing model for the difference is calculated asTotalTargetCapacity
-OnDemandTargetCapacity
=DefaultTargetCapacityType
, which results in the fleet launching 1 Spot Instance.When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch.
aws ec2 create-fleet \ --cli-input-json file://file_name.jsonContents of file_name.json:
{ "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "OnDemandTargetCapacity":1, "DefaultTargetCapacityType": "spot" } }Output:
{ "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" }Example 4: To create an EC2 Fleet that launches Spot Instances using the lowest-price allocation strategy
If the allocation strategy for Spot Instances is not specified, the default allocation strategy, which is
lowest-price
, is used. The followingcreate-fleet
example creates an EC2 Fleet using thelowest-price
allocation strategy. The three launch specifications, which override the launch template, have different instance types but the same weighted capacity and subnet. The total target capacity is 2 instances and the default purchasing model isspot
. The EC2 Fleet launches 2 Spot Instances using the instance type of the launch specification with the lowest price.When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch.
aws ec2 create-fleet \ --cli-input-json file://file_name.jsonContents of file_name.json:: { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" }, "Overrides": [ { "InstanceType": "c4.large", "WeightedCapacity": 1, "SubnetId": "subnet-a4f6c5d3" }, { "InstanceType": "c3.large", "WeightedCapacity": 1, "SubnetId": "subnet-a4f6c5d3" }, { "InstanceType": "c5.large", "WeightedCapacity": 1, "SubnetId": "subnet-a4f6c5d3" } ] } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "spot" } }Output:
{ "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" }Output¶
FleetId -> (string)
The ID of the EC2 Fleet.
Errors -> (list)
Information about the instances that could not be launched by the fleet. Supported only for fleets of type
instant
.(structure)
Describes the instances that could not be launched by the fleet.
LaunchTemplateAndOverrides -> (structure)
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification -> (structure)
The launch template.
LaunchTemplateId -> (string)
The ID of the launch template.
You must specify the
LaunchTemplateId
or theLaunchTemplateName
, but not both.LaunchTemplateName -> (string)
The name of the launch template.
You must specify the
LaunchTemplateName
or theLaunchTemplateId
, but not both.Version -> (string)
The launch template version number,
$Latest
, or$Default
. You must specify a value, otherwise the request fails.If the value is
$Latest
, Amazon EC2 uses the latest version of the launch template.If the value is
$Default
, Amazon EC2 uses the default version of the launch template.Overrides -> (structure)
Any parameters that you specify override the same parameters in the launch template.
InstanceType -> (string)
The instance type.
Note
If you specify
InstanceType
, you can’t specifyInstanceRequirements
.MaxPrice -> (string)
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
Warning
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
SubnetId -> (string)
The ID of the subnet in which to launch the instances.
AvailabilityZone -> (string)
The Availability Zone in which to launch the instances.
WeightedCapacity -> (double)
The number of units provided by the specified instance type.
Priority -> (double)
The priority for the launch template override. The highest priority is launched first.
If the On-Demand
AllocationStrategy
is set toprioritized
, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.If the Spot
AllocationStrategy
is set tocapacity-optimized-prioritized
, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.Valid values are whole numbers starting at
0
. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.Placement -> (structure)
The location where the instance launched, if applicable.
GroupName -> (string)
The name of the placement group that the instance is in.
InstanceRequirements -> (structure)
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
Note
If you specify
InstanceRequirements
, you can’t specifyInstanceType
.VCpuCount -> (structure)
The minimum and maximum number of vCPUs.
Min -> (integer)
The minimum number of vCPUs. If the value is
0
, there is no minimum limit.Max -> (integer)
The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
MemoryMiB -> (structure)
The minimum and maximum amount of memory, in MiB.
Min -> (integer)
The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
CpuManufacturers -> (list)
The CPU manufacturers to include.
For instance types with Intel CPUs, specify
intel
.For instance types with AMD CPUs, specify
amd
.For instance types with Amazon Web Services CPUs, specify
amazon-web-services
.Note
Don’t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
(string)
MemoryGiBPerVCpu -> (structure)
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
Max -> (double)
The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
ExcludedInstanceTypes -> (list)
The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to exclude an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.Note
If you specify
ExcludedInstanceTypes
, you can’t specifyAllowedInstanceTypes
.Default: No excluded instance types
(string)
InstanceGenerations -> (list)
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide .
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation instance types
(string)
SpotMaxPricePercentageOverLowestPrice -> (integer)
The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements .
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
100
OnDemandMaxPricePercentageOverLowestPrice -> (integer)
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements .
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
20
BareMetal -> (string)
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify
included
.To require only bare metal instance types, specify
required
.To exclude bare metal instance types, specify
excluded
.Default:
excluded
BurstablePerformance -> (string)
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances .
To include burstable performance instance types, specify
included
.To require only burstable performance instance types, specify
required
.To exclude burstable performance instance types, specify
excluded
.Default:
excluded
RequireHibernateSupport -> (boolean)
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores .
Default:
false
NetworkInterfaceCount -> (structure)
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Min -> (integer)
The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
LocalStorage -> (string)
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide .
To include instance types with instance store volumes, specify
included
.To require only instance types with instance store volumes, specify
required
.To exclude instance types with instance store volumes, specify
excluded
.Default:
included
LocalStorageTypes -> (list)
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify
hdd
.For instance types with solid state drive (SSD) storage, specify
ssd
.Default:
hdd
andssd
(string)
TotalLocalStorageGB -> (structure)
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
Max -> (double)
The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
BaselineEbsBandwidthMbps -> (structure)
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide .
Default: No minimum or maximum limits
Min -> (integer)
The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
AcceleratorTypes -> (list)
The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify
gpu
.For instance types with FPGA accelerators, specify
fpga
.For instance types with inference accelerators, specify
inference
.Default: Any accelerator type
(string)
AcceleratorCount -> (structure)
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set
Max
to0
.Default: No minimum or maximum limits
Min -> (integer)
The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
AcceleratorManufacturers -> (list)
Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify
nvidia
.For instance types with AMD devices, specify
amd
.For instance types with Amazon Web Services devices, specify
amazon-web-services
.For instance types with Xilinx devices, specify
xilinx
.Default: Any manufacturer
(string)
AcceleratorNames -> (list)
The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify
a100
.For instance types with NVIDIA V100 GPUs, specify
v100
.For instance types with NVIDIA K80 GPUs, specify
k80
.For instance types with NVIDIA T4 GPUs, specify
t4
.For instance types with NVIDIA M60 GPUs, specify
m60
.For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520
.For instance types with Xilinx VU9P FPGAs, specify
vu9p
.For instance types with Amazon Web Services Inferentia chips, specify
inferentia
.For instance types with NVIDIA GRID K520 GPUs, specify
k520
.Default: Any accelerator
(string)
AcceleratorTotalMemoryMiB -> (structure)
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Min -> (integer)
The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
NetworkBandwidthGbps -> (structure)
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
Max -> (double)
The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
AllowedInstanceTypes -> (list)
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to allow an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.Note
If you specify
AllowedInstanceTypes
, you can’t specifyExcludedInstanceTypes
.Default: All instance types
(string)
ImageId -> (string)
The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.
Lifecycle -> (string)
Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
ErrorCode -> (string)
The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes .
ErrorMessage -> (string)
The error message that describes why the instance could not be launched. For more information about error messages, see Error codes .
Instances -> (list)
Information about the instances that were launched by the fleet. Supported only for fleets of type
instant
.(structure)
Describes the instances that were launched by the fleet.
LaunchTemplateAndOverrides -> (structure)
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.
LaunchTemplateSpecification -> (structure)
The launch template.
LaunchTemplateId -> (string)
The ID of the launch template.
You must specify the
LaunchTemplateId
or theLaunchTemplateName
, but not both.LaunchTemplateName -> (string)
The name of the launch template.
You must specify the
LaunchTemplateName
or theLaunchTemplateId
, but not both.Version -> (string)
The launch template version number,
$Latest
, or$Default
. You must specify a value, otherwise the request fails.If the value is
$Latest
, Amazon EC2 uses the latest version of the launch template.If the value is
$Default
, Amazon EC2 uses the default version of the launch template.Overrides -> (structure)
Any parameters that you specify override the same parameters in the launch template.
InstanceType -> (string)
The instance type.
Note
If you specify
InstanceType
, you can’t specifyInstanceRequirements
.MaxPrice -> (string)
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
Warning
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
SubnetId -> (string)
The ID of the subnet in which to launch the instances.
AvailabilityZone -> (string)
The Availability Zone in which to launch the instances.
WeightedCapacity -> (double)
The number of units provided by the specified instance type.
Priority -> (double)
The priority for the launch template override. The highest priority is launched first.
If the On-Demand
AllocationStrategy
is set toprioritized
, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.If the Spot
AllocationStrategy
is set tocapacity-optimized-prioritized
, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.Valid values are whole numbers starting at
0
. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.Placement -> (structure)
The location where the instance launched, if applicable.
GroupName -> (string)
The name of the placement group that the instance is in.
InstanceRequirements -> (structure)
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
Note
If you specify
InstanceRequirements
, you can’t specifyInstanceType
.VCpuCount -> (structure)
The minimum and maximum number of vCPUs.
Min -> (integer)
The minimum number of vCPUs. If the value is
0
, there is no minimum limit.Max -> (integer)
The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
MemoryMiB -> (structure)
The minimum and maximum amount of memory, in MiB.
Min -> (integer)
The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
CpuManufacturers -> (list)
The CPU manufacturers to include.
For instance types with Intel CPUs, specify
intel
.For instance types with AMD CPUs, specify
amd
.For instance types with Amazon Web Services CPUs, specify
amazon-web-services
.Note
Don’t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
(string)
MemoryGiBPerVCpu -> (structure)
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
Max -> (double)
The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
ExcludedInstanceTypes -> (list)
The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to exclude an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.Note
If you specify
ExcludedInstanceTypes
, you can’t specifyAllowedInstanceTypes
.Default: No excluded instance types
(string)
InstanceGenerations -> (list)
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide .
For current generation instance types, specify
current
.For previous generation instance types, specify
previous
.Default: Current and previous generation instance types
(string)
SpotMaxPricePercentageOverLowestPrice -> (integer)
The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements .
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
100
OnDemandMaxPricePercentageOverLowestPrice -> (integer)
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as
999999
.This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements .
Note
If you set
TargetCapacityUnitType
tovcpu
ormemory-mib
, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.Default:
20
BareMetal -> (string)
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify
included
.To require only bare metal instance types, specify
required
.To exclude bare metal instance types, specify
excluded
.Default:
excluded
BurstablePerformance -> (string)
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances .
To include burstable performance instance types, specify
included
.To require only burstable performance instance types, specify
required
.To exclude burstable performance instance types, specify
excluded
.Default:
excluded
RequireHibernateSupport -> (boolean)
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores .
Default:
false
NetworkInterfaceCount -> (structure)
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Min -> (integer)
The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
LocalStorage -> (string)
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide .
To include instance types with instance store volumes, specify
included
.To require only instance types with instance store volumes, specify
required
.To exclude instance types with instance store volumes, specify
excluded
.Default:
included
LocalStorageTypes -> (list)
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify
hdd
.For instance types with solid state drive (SSD) storage, specify
ssd
.Default:
hdd
andssd
(string)
TotalLocalStorageGB -> (structure)
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
Max -> (double)
The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
BaselineEbsBandwidthMbps -> (structure)
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide .
Default: No minimum or maximum limits
Min -> (integer)
The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
AcceleratorTypes -> (list)
The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify
gpu
.For instance types with FPGA accelerators, specify
fpga
.For instance types with inference accelerators, specify
inference
.Default: Any accelerator type
(string)
AcceleratorCount -> (structure)
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set
Max
to0
.Default: No minimum or maximum limits
Min -> (integer)
The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
AcceleratorManufacturers -> (list)
Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify
nvidia
.For instance types with AMD devices, specify
amd
.For instance types with Amazon Web Services devices, specify
amazon-web-services
.For instance types with Xilinx devices, specify
xilinx
.Default: Any manufacturer
(string)
AcceleratorNames -> (list)
The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify
a100
.For instance types with NVIDIA V100 GPUs, specify
v100
.For instance types with NVIDIA K80 GPUs, specify
k80
.For instance types with NVIDIA T4 GPUs, specify
t4
.For instance types with NVIDIA M60 GPUs, specify
m60
.For instance types with AMD Radeon Pro V520 GPUs, specify
radeon-pro-v520
.For instance types with Xilinx VU9P FPGAs, specify
vu9p
.For instance types with Amazon Web Services Inferentia chips, specify
inferentia
.For instance types with NVIDIA GRID K520 GPUs, specify
k520
.Default: Any accelerator
(string)
AcceleratorTotalMemoryMiB -> (structure)
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Min -> (integer)
The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
Max -> (integer)
The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
NetworkBandwidthGbps -> (structure)
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
Min -> (double)
The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
Max -> (double)
The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
AllowedInstanceTypes -> (list)
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (
*
), to allow an instance type, size, or generation. The following are examples:m5.8xlarge
,c5*.*
,m5a.*
,r*
,*3*
.For example, if you specify
c5*
,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*
, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.Note
If you specify
AllowedInstanceTypes
, you can’t specifyExcludedInstanceTypes
.Default: All instance types
(string)
ImageId -> (string)
The ID of the AMI. An AMI is required to launch an instance. The AMI ID must be specified here or in the launch template.
Lifecycle -> (string)
Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
InstanceIds -> (list)
The IDs of the instances.
(string)
InstanceType -> (string)
The instance type.
Platform -> (string)
The value is
Windows
for Windows instances. Otherwise, the value is blank.