aws_ec2_spotfleetrequest

account_id

Type: STRING

activity_status

Type: STRING
Provider name: ActivityStatus
Description: The progress of the Spot Fleet request. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.

create_time

Type: TIMESTAMP
Provider name: CreateTime
Description: The creation date and time of the request.

spot_fleet_request_config

Type: STRUCT
Provider name: SpotFleetRequestConfig
Description: The configuration of the Spot Fleet request.

• 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 Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.

  priceCapacityOptimized (recommended)

  Spot 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. Spot Fleet then requests Spot Instances from the lowest priced of these pools.

  capacityOptimized

  Spot 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 capacityOptimizedPrioritized. 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. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

  diversified

  Spot Fleet requests instances from all of the Spot Instance pools that you specify.

  lowestPrice (not recommended)

  We don’t recommend the lowestPrice allocation strategy because it has the highest risk of interruption for your Spot Instances. Spot 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, Spot 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: lowestPrice
• client_token
  Type: STRING
  Provider name: ClientToken
  Description: A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
  
• context
  Type: STRING
  Provider name: Context
  Description: Reserved.
  
• excess_capacity_termination_policy
  Type: STRING
  Provider name: ExcessCapacityTerminationPolicy
  Description: Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet. Supported only for fleets of type maintain.
  
• fulfilled_capacity
  Type: DOUBLE
  Provider name: FulfilledCapacity
  Description: The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
  
• iam_fleet_role
  Type: STRING
  Provider name: IamFleetRole
  Description: The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.
  
• instance_interruption_behavior
  Type: STRING
  Provider name: InstanceInterruptionBehavior
  Description: The behavior when a Spot Instance is interrupted. The default is terminate.
  
• instance_pools_to_use_count
  Type: INT32
  Provider name: InstancePoolsToUseCount
  Description: The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify. Note that Spot 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, Spot 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.
  
• launch_specifications
  Type: UNORDERED_LIST_STRUCT
  Provider name: LaunchSpecifications
  Description: The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can’t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs. If an AMI specified in a launch specification is deregistered or disabled, no new instances can be launched from the AMI. For fleets of type maintain, the target capacity will not be maintained.
  
  • addressing_type
    Type: STRING
    Provider name: AddressingType
    Description: Deprecated.
    
  • block_device_mappings
    Type: UNORDERED_LIST_STRUCT
    Provider name: BlockDeviceMappings
    Description: One or more block devices that are mapped to the Spot Instances. You can’t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
    
    • device_name
      Type: STRING
      Provider name: DeviceName
      Description: The device name (for example, /dev/sdh or xvdh).
      
    • ebs
      Type: STRUCT
      Provider name: Ebs
      Description: Parameters used to automatically set up EBS volumes when the instance is launched.
      
      • delete_on_termination
        Type: BOOLEAN
        Provider name: DeleteOnTermination
        Description: Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
        
      • encrypted
        Type: BOOLEAN
        Provider name: Encrypted
        Description: Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter is not returned by DescribeImageAttribute. For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
        • If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
        • If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
        • If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
        • If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
      • iops
        Type: INT32
        Provider name: Iops
        Description: The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type:
        • gp3: 3,000 - 16,000 IOPS
        • io1: 100 - 64,000 IOPS
        • io2: 100 - 256,000 IOPS
        For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.
        
      • kms_key_id
        Type: STRING
        Provider name: KmsKeyId
        Description: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        
      • outpost_arn
        Type: STRING
        Provider name: OutpostArn
        Description: The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage.
        
      • snapshot_id
        Type: STRING
        Provider name: SnapshotId
        Description: The ID of the snapshot.
        
      • throughput
        Type: INT32
        Provider name: Throughput
        Description: The throughput that the volume supports, in MiB/s. This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 1000.
        
      • volume_size
        Type: INT32
        Provider name: VolumeSize
        Description: The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported sizes for each volume type:
        • gp2 and gp3: 1 - 16,384 GiB
        • io1: 4 - 16,384 GiB
        • io2: 4 - 65,536 GiB
        • st1 and sc1: 125 - 16,384 GiB
        • standard: 1 - 1024 GiB
      • volume_type
        Type: STRING
        Provider name: VolumeType
        Description: The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
        
    • no_device
      Type: STRING
      Provider name: NoDevice
      Description: To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
      
    • virtual_name
      Type: STRING
      Provider name: VirtualName
      Description: The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
      
  • ebs_optimized
    Type: BOOLEAN
    Provider name: EbsOptimized
    Description: Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    Default: false
  • iam_instance_profile
    Type: STRUCT
    Provider name: IamInstanceProfile
    Description: The IAM instance profile.
    
    • arn
      Type: STRING
      Provider name: Arn
      Description: The Amazon Resource Name (ARN) of the instance profile.
      
    • name
      Type: STRING
      Provider name: Name
      Description: The name of the instance profile.
      
  • image_id
    Type: STRING
    Provider name: ImageId
    Description: The ID of the AMI.
    
  • 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 limits
      • max
        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 manufacturer
    • accelerator_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 accelerator
    • accelerator_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 limits
      • max
        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 type
    • allowed_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 (), 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 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 types
    • bare_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: excluded
    • baseline_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 limits
      • max
        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:
            • c1
            • g3 | g3s
            • hpc7g
            • m1 | m2
            • mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
            • p3dn | p4d | p5
            • t1
            • u-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: excluded
    • cpu_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 manufacturer
    • excluded_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 (), 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 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 types
    • instance_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 types
    • local_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: included
    • local_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 ssd
    • max_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 limits
      • max
        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 limits
      • max
        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 limits
      • max
        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: 20
    • require_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: false
    • spot_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: 100
    • total_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 limits
      • max
        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.
    
  • kernel_id
    Type: STRING
    Provider name: KernelId
    Description: The ID of the kernel.
    
  • key_name
    Type: STRING
    Provider name: KeyName
    Description: The name of the key pair.
    
  • monitoring
    Type: STRUCT
    Provider name: Monitoring
    Description: Enable or disable monitoring for the instances.
    
    • enabled
      Type: BOOLEAN
      Provider name: Enabled
      Description: Enables monitoring for the instance.
      Default: false
  • network_interfaces
    Type: UNORDERED_LIST_STRUCT
    Provider name: NetworkInterfaces
    Description: The network interfaces. SpotFleetLaunchSpecification does not support Elastic Fabric Adapter (EFA). You must use LaunchTemplateConfig instead.
    
    • associate_carrier_ip_address
      Type: BOOLEAN
      Provider name: AssociateCarrierIpAddress
      Description: Indicates whether to assign a carrier IP address to the network interface. You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer Guide.
      
    • associate_public_ip_address
      Type: BOOLEAN
      Provider name: AssociatePublicIpAddress
      Description: Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true. Amazon Web Services charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the Public IPv4 Address tab on the Amazon VPC pricing page.
      
    • connection_tracking_specification
      Type: STRUCT
      Provider name: ConnectionTrackingSpecification
      Description: A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon EC2 User Guide.
      
      • tcp_established_timeout
        Type: INT32
        Provider name: TcpEstablishedTimeout
        Description: Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.
        
      • udp_stream_timeout
        Type: INT32
        Provider name: UdpStreamTimeout
        Description: Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.
        
      • udp_timeout
        Type: INT32
        Provider name: UdpTimeout
        Description: Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.
        
    • delete_on_termination
      Type: BOOLEAN
      Provider name: DeleteOnTermination
      Description: If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
      
    • description
      Type: STRING
      Provider name: Description
      Description: The description of the network interface. Applies only if creating a network interface when launching an instance.
      
    • device_index
      Type: INT32
      Provider name: DeviceIndex
      Description: The position of the network interface in the attachment order. A primary network interface has a device index of 0. If you specify a network interface when launching an instance, you must specify the device index.
      
    • ena_srd_specification
      Type: STRUCT
      Provider name: EnaSrdSpecification
      Description: Specifies the ENA Express settings for the network interface that’s attached to the instance.
      
      • ena_srd_enabled
        Type: BOOLEAN
        Provider name: EnaSrdEnabled
        Description: Specifies whether ENA Express is enabled for the network interface when you launch an instance from your launch template.
        
      • ena_srd_udp_specification
        Type: STRUCT
        Provider name: EnaSrdUdpSpecification
        Description: Contains ENA Express settings for UDP network traffic in your launch template.
        
        • ena_srd_udp_enabled
          Type: BOOLEAN
          Provider name: EnaSrdUdpEnabled
          Description: Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set EnaSrdEnabled in the EnaSrdSpecificationRequest to true in your launch template.
          
    • groups
      Type: UNORDERED_LIST_STRING
      Provider name: Groups
      Description: The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
      
    • interface_type
      Type: STRING
      Provider name: InterfaceType
      Description: The type of network interface. If you specify efa-only, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. Valid values: interface | efa | efa-only
      
    • ipv4_prefix_count
      Type: INT32
      Provider name: Ipv4PrefixCount
      Description: The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
      
    • ipv4_prefixes
      Type: UNORDERED_LIST_STRUCT
      Provider name: Ipv4Prefixes
      Description: The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
      
      • ipv4_prefix
        Type: STRING
        Provider name: Ipv4Prefix
        Description: The IPv4 prefix. For information, see Assigning prefixes to network interfaces in the Amazon EC2 User Guide.
        
    • ipv6_address_count
      Type: INT32
      Provider name: Ipv6AddressCount
      Description: A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you’ve specified a minimum number of instances to launch.
      
    • ipv6_addresses
      Type: UNORDERED_LIST_STRUCT
      Provider name: Ipv6Addresses
      Description: The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you’ve specified a minimum number of instances to launch.
      
      • ipv6_address
        Type: STRING
        Provider name: Ipv6Address
        Description: The IPv6 address.
        
      • is_primary_ipv6
        Type: BOOLEAN
        Provider name: IsPrimaryIpv6
        Description: Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.
        
    • ipv6_prefix_count
      Type: INT32
      Provider name: Ipv6PrefixCount
      Description: The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
      
    • ipv6_prefixes
      Type: UNORDERED_LIST_STRUCT
      Provider name: Ipv6Prefixes
      Description: The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
      
      • ipv6_prefix
        Type: STRING
        Provider name: Ipv6Prefix
        Description: The IPv6 prefix.
        
    • network_card_index
      Type: INT32
      Provider name: NetworkCardIndex
      Description: The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
      
    • network_interface_id
      Type: STRING
      Provider name: NetworkInterfaceId
      Description: The ID of the network interface. If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
      
    • primary_ipv6
      Type: BOOLEAN
      Provider name: PrimaryIpv6
      Description: The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.
      
    • private_ip_address
      Type: STRING
      Provider name: PrivateIpAddress
      Description: The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you’re launching more than one instance in a RunInstances request.
      
    • private_ip_addresses
      Type: UNORDERED_LIST_STRUCT
      Provider name: PrivateIpAddresses
      Description: The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you’re launching more than one instance in a RunInstances request.
      
      • primary
        Type: BOOLEAN
        Provider name: Primary
        Description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
      • private_ip_address
        Type: STRING
        Provider name: PrivateIpAddress
        Description: The private IPv4 address.
        
    • secondary_private_ip_address_count
      Type: INT32
      Provider name: SecondaryPrivateIpAddressCount
      Description: The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the PrivateIpAddress parameter.
      
    • subnet_id
      Type: STRING
      Provider name: SubnetId
      Description: The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.
      
  • placement
    Type: STRUCT
    Provider name: Placement
    Description: The placement information.
    
    • availability_zone
      Type: STRING
      Provider name: AvailabilityZone
      Description: The Availability Zone. [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, “us-west-2a, us-west-2b”.
      
    • group_name
      Type: STRING
      Provider name: GroupName
      Description: The name of the placement group.
      
    • tenancy
      Type: STRING
      Provider name: Tenancy
      Description: 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. The host tenancy is not supported for Spot Instances.
      
  • ramdisk_id
    Type: STRING
    Provider name: RamdiskId
    Description: The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
    
  • security_groups
    Type: UNORDERED_LIST_STRUCT
    Provider name: SecurityGroups
    Description: The security groups. If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
    
    • group_id
      Type: STRING
      Provider name: GroupId
      Description: The ID of the security group.
      
    • group_name
      Type: STRING
      Provider name: GroupName
      Description: The name of the security group.
      
  • spot_price
    Type: STRING
    Provider name: SpotPrice
    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.
    
  • subnet_id
    Type: STRING
    Provider name: SubnetId
    Description: The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, “subnet-1234abcdeexample1, subnet-0987cdef6example2”. If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.
    
  • tag_specifications
    Type: UNORDERED_LIST_STRUCT
    Provider name: TagSpecifications
    Description: The tags to apply during creation.
    
    • resource_type
      Type: STRING
      Provider name: ResourceType
      Description: The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .
      
  • user_data
    Type: STRING
    Provider name: UserData
    Description: The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.
    
  • 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 lowestPrice and priceCapacityOptimized 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.
    
• launch_template_configs
  Type: UNORDERED_LIST_STRUCT
  Provider name: LaunchTemplateConfigs
  Description: The launch template and overrides. If you specify LaunchTemplateConfigs, you can’t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.
  
  • launch_template_specification
    Type: STRUCT
    Provider name: LaunchTemplateSpecification
    Description: The launch template to use. Make sure that the launch template does not contain the NetworkInterfaceId parameter because you can’t specify a network interface ID in a Spot Fleet.
    
    • 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.
      
    • instance_requirements
      Type: STRUCT
      Provider name: InstanceRequirements
      Description: The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types. 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 limits
        • max
          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 manufacturer
      • accelerator_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 accelerator
      • accelerator_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 limits
        • max
          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 type
      • allowed_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 (), 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 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 types
      • bare_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: excluded
      • baseline_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 limits
        • max
          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:
              • c1
              • g3 | g3s
              • hpc7g
              • m1 | m2
              • mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro
              • p3dn | p4d | p5
              • t1
              • u-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: excluded
      • cpu_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 manufacturer
      • excluded_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 (), 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 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 types
      • instance_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 types
      • local_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: included
      • local_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 ssd
      • max_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 limits
        • max
          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 limits
        • max
          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 limits
        • max
          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: 20
      • require_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: false
      • spot_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: 100
      • total_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 limits
        • max
          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.
      
    • priority
      Type: DOUBLE
      Provider name: Priority
      Description: The priority for the launch template override. The highest priority is launched first. If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot 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.
      
    • spot_price
      Type: STRING
      Provider name: SpotPrice
      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.
      
    • 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 lowestPrice and priceCapacityOptimized 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.
      
• load_balancers_config
  Type: STRUCT
  Provider name: LoadBalancersConfig
  Description: One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups. With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
  
  • classic_load_balancers_config
    Type: STRUCT
    Provider name: ClassicLoadBalancersConfig
    Description: The Classic Load Balancers.
    
    • classic_load_balancers
      Type: UNORDERED_LIST_STRUCT
      Provider name: ClassicLoadBalancers
      Description: One or more Classic Load Balancers.
      
      • name
        Type: STRING
        Provider name: Name
        Description: The name of the load balancer.
        
  • target_groups_config
    Type: STRUCT
    Provider name: TargetGroupsConfig
    Description: The target groups.
    
    • target_groups
      Type: UNORDERED_LIST_STRUCT
      Provider name: TargetGroups
      Description: One or more target groups.
      
      • arn
        Type: STRING
        Provider name: Arn
        Description: The Amazon Resource Name (ARN) of the target group.
        
• on_demand_allocation_strategy
  Type: STRING
  Provider name: OnDemandAllocationStrategy
  Description: The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
  
• on_demand_fulfilled_capacity
  Type: DOUBLE
  Provider name: OnDemandFulfilledCapacity
  Description: The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
  
• on_demand_max_total_price
  Type: STRING
  Provider name: OnDemandMaxTotalPrice
  Description: The maximum amount per hour for On-Demand Instances that you’re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you’re willing to pay. When the maximum amount you’re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. 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 onDemandMaxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for onDemandMaxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
  
• on_demand_target_capacity
  Type: INT32
  Provider name: OnDemandTargetCapacity
  Description: The number of On-Demand 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.
  
• replace_unhealthy_instances
  Type: BOOLEAN
  Provider name: ReplaceUnhealthyInstances
  Description: Indicates whether Spot Fleet should replace unhealthy instances.
  
• spot_maintenance_strategies
  Type: STRUCT
  Provider name: SpotMaintenanceStrategies
  Description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
  
  • capacity_rebalance
    Type: STRUCT
    Provider name: CapacityRebalance
    Description: The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide.
    
    • replacement_strategy
      Type: STRING
      Provider name: ReplacementStrategy
      Description: The replacement strategy to use. Only available for fleets of type maintain. launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot 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 - Spot 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.
      
• spot_max_total_price
  Type: STRING
  Provider name: SpotMaxTotalPrice
  Description: The maximum amount per hour for Spot Instances that you’re willing to pay. You can use the spotMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you’re willing to pay. When the maximum amount you’re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. 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 spotMaxTotalPrice does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for spotMaxTotalPrice. For more information, see Surplus credits can incur charges in the Amazon EC2 User Guide.
  
• spot_price
  Type: STRING
  Provider name: SpotPrice
  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.
  
• tag_specifications
  Type: UNORDERED_LIST_STRUCT
  Provider name: TagSpecifications
  Description: The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tag your resources.
  
  • resource_type
    Type: STRING
    Provider name: ResourceType
    Description: The type of resource to tag on creation.
    
• target_capacity
  Type: INT32
  Provider name: TargetCapacity
  Description: The number of units to request for the Spot Fleet. 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.
  
• target_capacity_unit_type
  Type: STRING
  Provider name: TargetCapacityUnitType
  Description: The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.
  Default: units (the number of instances)
• terminate_instances_with_expiration
  Type: BOOLEAN
  Provider name: TerminateInstancesWithExpiration
  Description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
  
• type
  Type: STRING
  Provider name: Type
  Description: The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.
  
• valid_from
  Type: TIMESTAMP
  Provider name: ValidFrom
  Description: The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.
  
• valid_until
  Type: TIMESTAMP
  Provider name: ValidUntil
  Description: The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
  

spot_fleet_request_id

Type: STRING
Provider name: SpotFleetRequestId
Description: The ID of the Spot Fleet request.

spot_fleet_request_state

Type: STRING
Provider name: SpotFleetRequestState
Description: The state of the Spot Fleet request.

tags

Type: UNORDERED_LIST_STRING