Request Parameters Response Elements Errors See Also

CreateFleet

Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity.

A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see EC2 Fleet in the Amazon EC2 User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Type: String

Required: No

Context

Reserved.

Type: String

Required: No

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

ExcessCapacityTerminationPolicy

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

Supported only for fleets of type maintain.

Type: String

Valid Values: no-termination | termination

Required: No

LaunchTemplateConfigs.N

The configuration for the EC2 Fleet.

Type: Array of FleetLaunchTemplateConfigRequest objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: Yes

OnDemandOptions

Describes the configuration of On-Demand Instances in an EC2 Fleet.

Type: OnDemandOptionsRequest object

Required: No

ReplaceUnhealthyInstances

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.

Type: Boolean

Required: No

SpotOptions

Describes the configuration of Spot Instances in an EC2 Fleet.

Type: SpotOptionsRequest object

Required: No

TagSpecification.N

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tag your resources.

If the fleet type is instant, specify a resource type of fleet to tag the fleet or instance to tag the instances at launch.

If the fleet type is maintain or request, specify a resource type of fleet to tag the fleet. You cannot specify a resource type of instance. To tag instances at launch, specify the tags in a launch template.

Type: Array of TagSpecification objects

Required: No

TargetCapacitySpecification

The number of units to request.

Type: TargetCapacitySpecificationRequest object

Required: Yes

TerminateInstancesWithExpiration

Indicates whether running instances should be terminated when the EC2 Fleet expires.

Type: Boolean

Required: No

Type

The fleet type. The default value is maintain.

maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.
request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.
instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.

Type: String

Valid Values: request | maintain | instant

Required: No

ValidFrom

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.

Type: Timestamp

Required: No

ValidUntil

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

Type: Timestamp

Required: No

Response Elements

The following elements are returned by the service.

errorSet

Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant.

Type: Array of CreateFleetError objects

fleetId

The ID of the EC2 Fleet.

Type: String

fleetInstanceSet

Information about the instances that were launched by the fleet. Supported only for fleets of type instant.

Type: Array of CreateFleetInstance objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.