This product is not supported for your selected
Datadog site. (
).
aws_ec2_fleet
account_id
Type: STRING
activity_status
Type: STRING
Provider name: ActivityStatus
Description: The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.
client_token
Type: STRING
Provider name: ClientToken
Description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency. Constraints: Maximum 64 ASCII characters
context
Type: STRING
Provider name: Context
Description: Reserved.
create_time
Type: TIMESTAMP
Provider name: CreateTime
Description: The creation date and time of the EC2 Fleet.
errors
Type: UNORDERED_LIST_STRUCT
Provider name: Errors
Description: Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.
error_code
Type: STRING
Provider name: ErrorCode
Description: The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.
error_message
Type: STRING
Provider name: ErrorMessage
Description: The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.
launch_template_and_overrides
Type: STRUCT
Provider name: LaunchTemplateAndOverrides
Description: 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.
launch_template_specification
Type: STRUCT
Provider name: LaunchTemplateSpecification
Description: The launch template.
launch_template_id
Type: STRING
Provider name: LaunchTemplateId
Description: The ID of the launch template. You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
launch_template_name
Type: STRING
Provider name: LaunchTemplateName
Description: The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
version
Type: STRING
Provider name: Version
Description: 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
Type: STRUCT
Provider name: Overrides
Description: Any parameters that you specify override the same parameters in the launch template.
availability_zone
Type: STRING
Provider name: AvailabilityZone
Description: The Availability Zone in which to launch the instances.
image_id
Type: STRING
Provider name: ImageId
Description: The ID of the AMI in the format ami-17characters00000. Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch. To reference a public parameter:resolve:ssm:public-parameter
To reference a parameter stored in the same account:resolve:ssm:parameter-nameresolve:ssm:parameter-name:version-numberresolve:ssm:parameter-name:label
To reference a parameter shared from another Amazon Web Services account:resolve:ssm:parameter-ARNresolve:ssm:parameter-ARN:version-numberresolve:ssm:parameter-ARN:label
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide. This parameter is only available for fleets of type instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.
instance_requirements
Type: STRUCT
Provider name: InstanceRequirements
Description: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify InstanceRequirements, you can’t specify InstanceType.
accelerator_count
Type: STRUCT
Provider name: AcceleratorCount
Description: 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 to 0.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
accelerator_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorManufacturers
Description: Indicates whether instance types must have accelerators by specific manufacturers.- For instance types with Amazon Web Services devices, specify
amazon-web-services. - For instance types with AMD devices, specify
amd. - For instance types with Habana devices, specify
habana. - For instance types with NVIDIA devices, specify
nvidia. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufactureraccelerator_names
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorNames
Description: The accelerators that must be on the instance type.- For instance types with NVIDIA A10G GPUs, specify
a10g. - For instance types with NVIDIA A100 GPUs, specify
a100. - For instance types with NVIDIA H100 GPUs, specify
h100. - For instance types with Amazon Web Services Inferentia chips, specify
inferentia. - For instance types with NVIDIA GRID K520 GPUs, specify
k520. - For instance types with NVIDIA K80 GPUs, specify
k80. - 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 NVIDIA T4 GPUs, specify
t4. - For instance types with NVIDIA T4G GPUs, specify
t4g. - For instance types with Xilinx VU9P FPGAs, specify
vu9p. - For instance types with NVIDIA V100 GPUs, specify
v100.
Default: Any acceleratoraccelerator_total_memory_mib
Type: STRUCT
Provider name: AcceleratorTotalMemoryMiB
Description: The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
accelerator_types
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorTypes
Description: The accelerator types that must be on the instance type.- For instance types with FPGA accelerators, specify
fpga. - For instance types with GPU accelerators, specify
gpu. - For instance types with Inference accelerators, specify
inference.
Default: Any accelerator typeallowed_instance_types
Type: UNORDERED_LIST_STRING
Provider name: AllowedInstanceTypes
Description: 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 (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 specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. If you specify AllowedInstanceTypes, you can’t specify ExcludedInstanceTypes.
Default: All instance typesbare_metal
Type: STRING
Provider name: BareMetal
Description: 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: excludedbaseline_ebs_bandwidth_mbps
Type: STRUCT
Provider name: BaselineEbsBandwidthMbps
Description: 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 limitsmax
Type: INT32
Provider name: Max
Description: The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
baseline_performance_factors
Type: STRUCT
Provider name: BaselinePerformanceFactors
Description: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the Amazon EC2 User Guide.
cpu
Type: STRUCT
Provider name: Cpu
Description: The CPU performance to consider, using an instance family as the baseline reference.
references
Type: UNORDERED_LIST_STRUCT
Provider name: References
Description: Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Currently, only one instance family can be specified in the list.
instance_family
Type: STRING
Provider name: InstanceFamily
Description: The instance family to use as a baseline reference. Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types. The following instance families are not supported for performance protection:c1g3 | g3shpc7gm1 | m2mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2prop3dn | p4d | p5t1u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
burstable_performance
Type: STRING
Provider name: BurstablePerformance
Description: 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: excludedcpu_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: CpuManufacturers
Description: 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. - For instance types with Apple CPUs, specify
apple.
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 manufacturerexcluded_instance_types
Type: UNORDERED_LIST_STRING
Provider name: ExcludedInstanceTypes
Description: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (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 specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. If you specify ExcludedInstanceTypes, you can’t specify AllowedInstanceTypes.
Default: No excluded instance typesinstance_generations
Type: UNORDERED_LIST_STRING
Provider name: InstanceGenerations
Description: 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 typeslocal_storage
Type: STRING
Provider name: LocalStorage
Description: 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: includedlocal_storage_types
Type: UNORDERED_LIST_STRING
Provider name: LocalStorageTypes
Description: 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 and ssdmax_spot_price_as_percentage_of_optimal_on_demand_price
Type: INT32
Provider name: MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
memory_gib_per_v_cpu
Type: STRUCT
Provider name: MemoryGiBPerVCpu
Description: The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
memory_mib
Type: STRUCT
Provider name: MemoryMiB
Description: The minimum and maximum amount of memory, in MiB.
max
Type: INT32
Provider name: Max
Description: The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
network_bandwidth_gbps
Type: STRUCT
Provider name: NetworkBandwidthGbps
Description: The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
network_interface_count
Type: STRUCT
Provider name: NetworkInterfaceCount
Description: The minimum and maximum number of network interfaces.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
on_demand_max_price_percentage_over_lowest_price
Type: INT32
Provider name: OnDemandMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified 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. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20require_hibernate_support
Type: BOOLEAN
Provider name: RequireHibernateSupport
Description: Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores.
Default: falsespot_max_price_percentage_over_lowest_price
Type: INT32
Provider name: SpotMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100total_local_storage_gb
Type: STRUCT
Provider name: TotalLocalStorageGB
Description: The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
v_cpu_count
Type: STRUCT
Provider name: VCpuCount
Description: The minimum and maximum number of vCPUs.
max
Type: INT32
Provider name: Max
Description: The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of vCPUs. If the value is 0, there is no minimum limit.
instance_type
Type: STRING
Provider name: InstanceType
Description: The instance type. mac1.metal is not supported as a launch template override. If you specify InstanceType, you can’t specify InstanceRequirements.
max_price
Type: STRING
Provider name: MaxPrice
Description: 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. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
placement
Type: STRUCT
Provider name: Placement
Description: The location where the instance launched, if applicable.
group_name
Type: STRING
Provider name: GroupName
Description: The name of the placement group that the instance is in.
priority
Type: DOUBLE
Provider name: Priority
Description: The priority for the launch template override. The highest priority is launched first. If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot AllocationStrategy is set to capacity-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.
subnet_id
Type: STRING
Provider name: SubnetId
Description: The ID of the subnet in which to launch the instances.
weighted_capacity
Type: DOUBLE
Provider name: WeightedCapacity
Description: The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
lifecycle
Type: STRING
Provider name: Lifecycle
Description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
excess_capacity_termination_policy
Type: STRING
Provider name: ExcessCapacityTerminationPolicy
Description: Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported only for fleets of type maintain.
fleet_id
Type: STRING
Provider name: FleetId
Description: The ID of the EC2 Fleet.
fleet_state
Type: STRING
Provider name: FleetState
Description: The state of the EC2 Fleet.
fulfilled_capacity
Type: DOUBLE
Provider name: FulfilledCapacity
Description: The number of units fulfilled by this request compared to the set target capacity.
fulfilled_on_demand_capacity
Type: DOUBLE
Provider name: FulfilledOnDemandCapacity
Description: The number of units fulfilled by this request compared to the set target On-Demand capacity.
instances
Type: UNORDERED_LIST_STRUCT
Provider name: Instances
Description: Information about the instances that were launched by the fleet. Valid only when Type is set to instant.
instance_ids
Type: UNORDERED_LIST_STRING
Provider name: InstanceIds
Description: The IDs of the instances.
instance_type
Type: STRING
Provider name: InstanceType
Description: The instance type.
launch_template_and_overrides
Type: STRUCT
Provider name: LaunchTemplateAndOverrides
Description: 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.
launch_template_specification
Type: STRUCT
Provider name: LaunchTemplateSpecification
Description: The launch template.
launch_template_id
Type: STRING
Provider name: LaunchTemplateId
Description: The ID of the launch template. You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
launch_template_name
Type: STRING
Provider name: LaunchTemplateName
Description: The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
version
Type: STRING
Provider name: Version
Description: 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
Type: STRUCT
Provider name: Overrides
Description: Any parameters that you specify override the same parameters in the launch template.
availability_zone
Type: STRING
Provider name: AvailabilityZone
Description: The Availability Zone in which to launch the instances.
image_id
Type: STRING
Provider name: ImageId
Description: The ID of the AMI in the format ami-17characters00000. Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch. To reference a public parameter:resolve:ssm:public-parameter
To reference a parameter stored in the same account:resolve:ssm:parameter-nameresolve:ssm:parameter-name:version-numberresolve:ssm:parameter-name:label
To reference a parameter shared from another Amazon Web Services account:resolve:ssm:parameter-ARNresolve:ssm:parameter-ARN:version-numberresolve:ssm:parameter-ARN:label
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide. This parameter is only available for fleets of type instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.
instance_requirements
Type: STRUCT
Provider name: InstanceRequirements
Description: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify InstanceRequirements, you can’t specify InstanceType.
accelerator_count
Type: STRUCT
Provider name: AcceleratorCount
Description: 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 to 0.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
accelerator_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorManufacturers
Description: Indicates whether instance types must have accelerators by specific manufacturers.- For instance types with Amazon Web Services devices, specify
amazon-web-services. - For instance types with AMD devices, specify
amd. - For instance types with Habana devices, specify
habana. - For instance types with NVIDIA devices, specify
nvidia. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufactureraccelerator_names
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorNames
Description: The accelerators that must be on the instance type.- For instance types with NVIDIA A10G GPUs, specify
a10g. - For instance types with NVIDIA A100 GPUs, specify
a100. - For instance types with NVIDIA H100 GPUs, specify
h100. - For instance types with Amazon Web Services Inferentia chips, specify
inferentia. - For instance types with NVIDIA GRID K520 GPUs, specify
k520. - For instance types with NVIDIA K80 GPUs, specify
k80. - 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 NVIDIA T4 GPUs, specify
t4. - For instance types with NVIDIA T4G GPUs, specify
t4g. - For instance types with Xilinx VU9P FPGAs, specify
vu9p. - For instance types with NVIDIA V100 GPUs, specify
v100.
Default: Any acceleratoraccelerator_total_memory_mib
Type: STRUCT
Provider name: AcceleratorTotalMemoryMiB
Description: The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
accelerator_types
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorTypes
Description: The accelerator types that must be on the instance type.- For instance types with FPGA accelerators, specify
fpga. - For instance types with GPU accelerators, specify
gpu. - For instance types with Inference accelerators, specify
inference.
Default: Any accelerator typeallowed_instance_types
Type: UNORDERED_LIST_STRING
Provider name: AllowedInstanceTypes
Description: 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 (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 specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. If you specify AllowedInstanceTypes, you can’t specify ExcludedInstanceTypes.
Default: All instance typesbare_metal
Type: STRING
Provider name: BareMetal
Description: 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: excludedbaseline_ebs_bandwidth_mbps
Type: STRUCT
Provider name: BaselineEbsBandwidthMbps
Description: 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 limitsmax
Type: INT32
Provider name: Max
Description: The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
baseline_performance_factors
Type: STRUCT
Provider name: BaselinePerformanceFactors
Description: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the Amazon EC2 User Guide.
cpu
Type: STRUCT
Provider name: Cpu
Description: The CPU performance to consider, using an instance family as the baseline reference.
references
Type: UNORDERED_LIST_STRUCT
Provider name: References
Description: Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Currently, only one instance family can be specified in the list.
instance_family
Type: STRING
Provider name: InstanceFamily
Description: The instance family to use as a baseline reference. Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types. The following instance families are not supported for performance protection:c1g3 | g3shpc7gm1 | m2mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2prop3dn | p4d | p5t1u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
burstable_performance
Type: STRING
Provider name: BurstablePerformance
Description: 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: excludedcpu_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: CpuManufacturers
Description: 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. - For instance types with Apple CPUs, specify
apple.
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 manufacturerexcluded_instance_types
Type: UNORDERED_LIST_STRING
Provider name: ExcludedInstanceTypes
Description: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (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 specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. If you specify ExcludedInstanceTypes, you can’t specify AllowedInstanceTypes.
Default: No excluded instance typesinstance_generations
Type: UNORDERED_LIST_STRING
Provider name: InstanceGenerations
Description: 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 typeslocal_storage
Type: STRING
Provider name: LocalStorage
Description: 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: includedlocal_storage_types
Type: UNORDERED_LIST_STRING
Provider name: LocalStorageTypes
Description: 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 and ssdmax_spot_price_as_percentage_of_optimal_on_demand_price
Type: INT32
Provider name: MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
memory_gib_per_v_cpu
Type: STRUCT
Provider name: MemoryGiBPerVCpu
Description: The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
memory_mib
Type: STRUCT
Provider name: MemoryMiB
Description: The minimum and maximum amount of memory, in MiB.
max
Type: INT32
Provider name: Max
Description: The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
network_bandwidth_gbps
Type: STRUCT
Provider name: NetworkBandwidthGbps
Description: The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
network_interface_count
Type: STRUCT
Provider name: NetworkInterfaceCount
Description: The minimum and maximum number of network interfaces.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
on_demand_max_price_percentage_over_lowest_price
Type: INT32
Provider name: OnDemandMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified 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. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20require_hibernate_support
Type: BOOLEAN
Provider name: RequireHibernateSupport
Description: Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores.
Default: falsespot_max_price_percentage_over_lowest_price
Type: INT32
Provider name: SpotMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100total_local_storage_gb
Type: STRUCT
Provider name: TotalLocalStorageGB
Description: The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
v_cpu_count
Type: STRUCT
Provider name: VCpuCount
Description: The minimum and maximum number of vCPUs.
max
Type: INT32
Provider name: Max
Description: The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of vCPUs. If the value is 0, there is no minimum limit.
instance_type
Type: STRING
Provider name: InstanceType
Description: The instance type. mac1.metal is not supported as a launch template override. If you specify InstanceType, you can’t specify InstanceRequirements.
max_price
Type: STRING
Provider name: MaxPrice
Description: 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. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
placement
Type: STRUCT
Provider name: Placement
Description: The location where the instance launched, if applicable.
group_name
Type: STRING
Provider name: GroupName
Description: The name of the placement group that the instance is in.
priority
Type: DOUBLE
Provider name: Priority
Description: The priority for the launch template override. The highest priority is launched first. If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot AllocationStrategy is set to capacity-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.
subnet_id
Type: STRING
Provider name: SubnetId
Description: The ID of the subnet in which to launch the instances.
weighted_capacity
Type: DOUBLE
Provider name: WeightedCapacity
Description: The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
lifecycle
Type: STRING
Provider name: Lifecycle
Description: Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
platform
Type: STRING
Provider name: Platform
Description: The value is windows for Windows instances in an EC2 Fleet. Otherwise, the value is blank.
launch_template_configs
Type: UNORDERED_LIST_STRUCT
Provider name: LaunchTemplateConfigs
Description: The launch template and overrides.
launch_template_specification
Type: STRUCT
Provider name: LaunchTemplateSpecification
Description: The launch template.
launch_template_id
Type: STRING
Provider name: LaunchTemplateId
Description: The ID of the launch template. You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
launch_template_name
Type: STRING
Provider name: LaunchTemplateName
Description: The name of the launch template. You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
version
Type: STRING
Provider name: Version
Description: 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
Type: UNORDERED_LIST_STRUCT
Provider name: Overrides
Description: Any parameters that you specify override the same parameters in the launch template.
availability_zone
Type: STRING
Provider name: AvailabilityZone
Description: The Availability Zone in which to launch the instances.
image_id
Type: STRING
Provider name: ImageId
Description: The ID of the AMI in the format ami-17characters00000. Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch. To reference a public parameter:resolve:ssm:public-parameter
To reference a parameter stored in the same account:resolve:ssm:parameter-nameresolve:ssm:parameter-name:version-numberresolve:ssm:parameter-name:label
To reference a parameter shared from another Amazon Web Services account:resolve:ssm:parameter-ARNresolve:ssm:parameter-ARN:version-numberresolve:ssm:parameter-ARN:label
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide. This parameter is only available for fleets of type instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.
instance_requirements
Type: STRUCT
Provider name: InstanceRequirements
Description: The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify InstanceRequirements, you can’t specify InstanceType.
accelerator_count
Type: STRUCT
Provider name: AcceleratorCount
Description: 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 to 0.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.
accelerator_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorManufacturers
Description: Indicates whether instance types must have accelerators by specific manufacturers.- For instance types with Amazon Web Services devices, specify
amazon-web-services. - For instance types with AMD devices, specify
amd. - For instance types with Habana devices, specify
habana. - For instance types with NVIDIA devices, specify
nvidia. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufactureraccelerator_names
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorNames
Description: The accelerators that must be on the instance type.- For instance types with NVIDIA A10G GPUs, specify
a10g. - For instance types with NVIDIA A100 GPUs, specify
a100. - For instance types with NVIDIA H100 GPUs, specify
h100. - For instance types with Amazon Web Services Inferentia chips, specify
inferentia. - For instance types with NVIDIA GRID K520 GPUs, specify
k520. - For instance types with NVIDIA K80 GPUs, specify
k80. - 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 NVIDIA T4 GPUs, specify
t4. - For instance types with NVIDIA T4G GPUs, specify
t4g. - For instance types with Xilinx VU9P FPGAs, specify
vu9p. - For instance types with NVIDIA V100 GPUs, specify
v100.
Default: Any acceleratoraccelerator_total_memory_mib
Type: STRUCT
Provider name: AcceleratorTotalMemoryMiB
Description: The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.
accelerator_types
Type: UNORDERED_LIST_STRING
Provider name: AcceleratorTypes
Description: The accelerator types that must be on the instance type.- For instance types with FPGA accelerators, specify
fpga. - For instance types with GPU accelerators, specify
gpu. - For instance types with Inference accelerators, specify
inference.
Default: Any accelerator typeallowed_instance_types
Type: UNORDERED_LIST_STRING
Provider name: AllowedInstanceTypes
Description: 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 (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 specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types. If you specify AllowedInstanceTypes, you can’t specify ExcludedInstanceTypes.
Default: All instance typesbare_metal
Type: STRING
Provider name: BareMetal
Description: 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: excludedbaseline_ebs_bandwidth_mbps
Type: STRUCT
Provider name: BaselineEbsBandwidthMbps
Description: 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 limitsmax
Type: INT32
Provider name: Max
Description: The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.
baseline_performance_factors
Type: STRUCT
Provider name: BaselinePerformanceFactors
Description: The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see Performance protection in the Amazon EC2 User Guide.
cpu
Type: STRUCT
Provider name: Cpu
Description: The CPU performance to consider, using an instance family as the baseline reference.
references
Type: UNORDERED_LIST_STRUCT
Provider name: References
Description: Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences. Currently, only one instance family can be specified in the list.
instance_family
Type: STRING
Provider name: InstanceFamily
Description: The instance family to use as a baseline reference. Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types. The following instance families are not supported for performance protection:c1g3 | g3shpc7gm1 | m2mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2prop3dn | p4d | p5t1u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families. If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for and an exception for , , , and .
burstable_performance
Type: STRING
Provider name: BurstablePerformance
Description: 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: excludedcpu_manufacturers
Type: UNORDERED_LIST_STRING
Provider name: CpuManufacturers
Description: 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. - For instance types with Apple CPUs, specify
apple.
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 manufacturerexcluded_instance_types
Type: UNORDERED_LIST_STRING
Provider name: ExcludedInstanceTypes
Description: The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (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 specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types. If you specify ExcludedInstanceTypes, you can’t specify AllowedInstanceTypes.
Default: No excluded instance typesinstance_generations
Type: UNORDERED_LIST_STRING
Provider name: InstanceGenerations
Description: 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 typeslocal_storage
Type: STRING
Provider name: LocalStorage
Description: 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: includedlocal_storage_types
Type: UNORDERED_LIST_STRING
Provider name: LocalStorageTypes
Description: 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 and ssdmax_spot_price_as_percentage_of_optimal_on_demand_price
Type: INT32
Provider name: MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
memory_gib_per_v_cpu
Type: STRUCT
Provider name: MemoryGiBPerVCpu
Description: The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.
memory_mib
Type: STRUCT
Provider name: MemoryMiB
Description: The minimum and maximum amount of memory, in MiB.
max
Type: INT32
Provider name: Max
Description: The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.
network_bandwidth_gbps
Type: STRUCT
Provider name: NetworkBandwidthGbps
Description: The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.
network_interface_count
Type: STRUCT
Provider name: NetworkInterfaceCount
Description: The minimum and maximum number of network interfaces.
Default: No minimum or maximum limitsmax
Type: INT32
Provider name: Max
Description: The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.
on_demand_max_price_percentage_over_lowest_price
Type: INT32
Provider name: OnDemandMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified 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. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20require_hibernate_support
Type: BOOLEAN
Provider name: RequireHibernateSupport
Description: Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores.
Default: falsespot_max_price_percentage_over_lowest_price
Type: INT32
Provider name: SpotMaxPricePercentageOverLowestPrice
Description: [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price. This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements. Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as 999999.
Default: 100total_local_storage_gb
Type: STRUCT
Provider name: TotalLocalStorageGB
Description: The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limitsmax
Type: DOUBLE
Provider name: Max
Description: The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.
min
Type: DOUBLE
Provider name: Min
Description: The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.
v_cpu_count
Type: STRUCT
Provider name: VCpuCount
Description: The minimum and maximum number of vCPUs.
max
Type: INT32
Provider name: Max
Description: The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.
min
Type: INT32
Provider name: Min
Description: The minimum number of vCPUs. If the value is 0, there is no minimum limit.
instance_type
Type: STRING
Provider name: InstanceType
Description: The instance type. mac1.metal is not supported as a launch template override. If you specify InstanceType, you can’t specify InstanceRequirements.
max_price
Type: STRING
Provider name: MaxPrice
Description: 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. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
placement
Type: STRUCT
Provider name: Placement
Description: The location where the instance launched, if applicable.
group_name
Type: STRING
Provider name: GroupName
Description: The name of the placement group that the instance is in.
priority
Type: DOUBLE
Provider name: Priority
Description: The priority for the launch template override. The highest priority is launched first. If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot AllocationStrategy is set to capacity-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.
subnet_id
Type: STRING
Provider name: SubnetId
Description: The ID of the subnet in which to launch the instances.
weighted_capacity
Type: DOUBLE
Provider name: WeightedCapacity
Description: The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O. If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1. When specifying weights, the price used in the lowest-price and price-capacity-optimized allocation strategies is per unit hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested TargetCapacity, resulting in only 1 instance being launched, the price used is per instance hour.
on_demand_options
Type: STRUCT
Provider name: OnDemandOptions
Description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
allocation_strategy
Type: STRING
Provider name: AllocationStrategy
Description: 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-pricecapacity_reservation_options
Type: STRUCT
Provider name: CapacityReservationOptions
Description: The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets of type instant.
usage_strategy
Type: STRING
Provider name: UsageStrategy
Description: 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 or prioritized) 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 or prioritized). If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.
max_total_price
Type: STRING
Provider name: MaxTotalPrice
Description: The maximum amount per hour for On-Demand Instances that you’re willing to pay. If your fleet includes T instances that are configured as unlimited, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The maxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
min_target_capacity
Type: INT32
Provider name: MinTargetCapacity
Description: The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn’t reached, no instances are launched. Constraints: Maximum value of 1000. Supported only for fleets of type instant. At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
single_availability_zone
Type: BOOLEAN
Provider name: SingleAvailabilityZone
Description: Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for fleets of type instant.
single_instance_type
Type: BOOLEAN
Provider name: SingleInstanceType
Description: 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.
replace_unhealthy_instances
Type: BOOLEAN
Provider name: ReplaceUnhealthyInstances
Description: 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.
spot_options
Type: STRUCT
Provider name: SpotOptions
Description: The configuration of Spot Instances in an EC2 Fleet.
allocation_strategy
Type: STRING
Provider name: AllocationStrategy
Description: 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 the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. 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-Demand AllocationStrategy is set to prioritized, 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 (not recommended)
- We don’t recommend the
lowest-price allocation strategy because it has the highest risk of interruption for your Spot Instances. 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-priceinstance_interruption_behavior
Type: STRING
Provider name: InstanceInterruptionBehavior
Description: The behavior when a Spot Instance is interrupted.
Default: terminateinstance_pools_to_use_count
Type: INT32
Provider name: InstancePoolsToUseCount
Description: The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-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.
maintenance_strategies
Type: STRUCT
Provider name: MaintenanceStrategies
Description: The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.
capacity_rebalance
Type: STRUCT
Provider name: CapacityRebalance
Description: The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
replacement_strategy
Type: STRING
Provider name: ReplacementStrategy
Description: The replacement strategy to use. Only available for fleets of type maintain. launch - EC2 Fleet launches a new 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 new 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 (in TerminationDelay), terminates the instances that received a rebalance notification.
termination_delay
Type: INT32
Provider name: TerminationDelay
Description: 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 to launch-before-terminate. Not valid when ReplacementStrategy is set to launch. Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
max_total_price
Type: STRING
Provider name: MaxTotalPrice
Description: 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. If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter. If your fleet includes T instances that are configured as unlimited, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The maxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for maxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
min_target_capacity
Type: INT32
Provider name: MinTargetCapacity
Description: The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn’t reached, no instances are launched. Constraints: Maximum value of 1000. Supported only for fleets of type instant. At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
single_availability_zone
Type: BOOLEAN
Provider name: SingleAvailabilityZone
Description: Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets of type instant.
single_instance_type
Type: BOOLEAN
Provider name: SingleInstanceType
Description: Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only for fleets of type instant.
Type: UNORDERED_LIST_STRING
target_capacity_specification
Type: STRUCT
Provider name: TargetCapacitySpecification
Description: The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
default_target_capacity_type
Type: STRING
Provider name: DefaultTargetCapacityType
Description: The default target capacity type.
on_demand_target_capacity
Type: INT32
Provider name: OnDemandTargetCapacity
Description: The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.
spot_target_capacity
Type: INT32
Provider name: SpotTargetCapacity
Description: The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.
target_capacity_unit_type
Type: STRING
Provider name: TargetCapacityUnitType
Description: The unit for the target capacity.
total_target_capacity
Type: INT32
Provider name: TotalTargetCapacity
Description: The number of units to request, filled the default target capacity type.
terminate_instances_with_expiration
Type: BOOLEAN
Provider name: TerminateInstancesWithExpiration
Description: Indicates whether running instances should be terminated when the EC2 Fleet expires.
type
Type: STRING
Provider name: Type
Description: The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.
valid_from
Type: TIMESTAMP
Provider name: ValidFrom
Description: The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
valid_until
Type: TIMESTAMP
Provider name: ValidUntil
Description: The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
