AWS::EC2::SpotFleet SpotFleetLaunchSpecification

Specifies the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "BlockDeviceMappings" : [ BlockDeviceMapping, ... ],
  "EbsOptimized" : Boolean,
  "IamInstanceProfile" : IamInstanceProfileSpecification,
  "ImageId" : String,
  "InstanceRequirements" : InstanceRequirementsRequest,
  "InstanceType" : String,
  "KernelId" : String,
  "KeyName" : String,
  "Monitoring" : SpotFleetMonitoring,
  "NetworkInterfaces" : [ InstanceNetworkInterfaceSpecification, ... ],
  "Placement" : SpotPlacement,
  "RamdiskId" : String,
  "SecurityGroups" : [ GroupIdentifier, ... ],
  "SpotPrice" : String,
  "SubnetId" : String,
  "TagSpecifications" : [ SpotFleetTagSpecification, ... ],
  "UserData" : String,
  "WeightedCapacity" : Number
}

YAML


  BlockDeviceMappings: 
    - BlockDeviceMapping
  EbsOptimized: Boolean
  IamInstanceProfile: 
    IamInstanceProfileSpecification
  ImageId: String
  InstanceRequirements: 
    InstanceRequirementsRequest
  InstanceType: String
  KernelId: String
  KeyName: String
  Monitoring: 
    SpotFleetMonitoring
  NetworkInterfaces: 
    - InstanceNetworkInterfaceSpecification
  Placement: 
    SpotPlacement
  RamdiskId: String
  SecurityGroups: 
    - GroupIdentifier
  SpotPrice: String
  SubnetId: String
  TagSpecifications: 
    - SpotFleetTagSpecification
  UserData: String
  WeightedCapacity: Number

Properties

BlockDeviceMappings

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.

Required: No

Type: Array of BlockDeviceMapping

Update requires: Replacement

EbsOptimized

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

Required: No

Type: Boolean

Update requires: Replacement

IamInstanceProfile

The IAM instance profile.

Required: No

Type: IamInstanceProfileSpecification

Update requires: Replacement

ImageId

The ID of the AMI.

Required: Yes

Type: String

Update requires: Replacement

InstanceRequirements

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

Note

If you specify InstanceRequirements, you can't specify InstanceType.

Required: No

Type: InstanceRequirementsRequest

Update requires: Replacement

InstanceType

The instance type.

Required: No

Type: String

Update requires: Replacement

KernelId

The ID of the kernel.

Required: No

Type: String

Update requires: Replacement

KeyName

The name of the key pair.

Required: No

Type: String

Update requires: Replacement

Monitoring

Enable or disable monitoring for the instances.

Required: No

Type: SpotFleetMonitoring

Update requires: Replacement

NetworkInterfaces

The network interfaces.

Required: No

Type: Array of InstanceNetworkInterfaceSpecification

Update requires: Replacement

Placement

The placement information.

Required: No

Type: SpotPlacement

Update requires: Replacement

RamdiskId

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 AWS Resource Center and search for the kernel ID.

Required: No

Type: String

Update requires: Replacement

SecurityGroups

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.

Required: No

Type: Array of GroupIdentifier

Update requires: Replacement

SpotPrice

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.

Important

If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

Required: No

Type: String

Update requires: Replacement

SubnetId

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.

Required: No

Type: String

Update requires: Replacement

TagSpecifications

The tags to apply during creation.

Required: No

Type: Array of SpotFleetTagSpecification

Update requires: Replacement

UserData

The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.

Required: No

Type: String

Update requires: Replacement

WeightedCapacity

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.

Note

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.

Required: No

Type: Number

Update requires: Replacement

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

SpotCapacityRebalance

SpotFleetMonitoring