AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::EC2Fleet

CfnEC2Fleet

Specifies the configuration information to launch a fleet--or group--of instances. An EC2 Fleet can launch multiple instance types across multiple Availability Zones, using the On-Demand Instance, Reserved Instance, and Spot Instance purchasing models together. Using EC2 Fleet, you can define separate On-Demand and Spot capacity targets, specify the instance types that work best for your applications, and specify how Amazon EC2 should distribute your fleet capacity within each purchasing model. For more information, see [Launching an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) in the *Amazon EC2 User Guide* .

Import

import { CfnEC2Fleet } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnEC2Fleet

Properties

Configuration passed to the constructor as CfnEC2FleetProps.

launchTemplateConfigsRequired
IResolvable | IResolvable | FleetLaunchTemplateConfigRequestProperty[]

The configuration for the EC2 Fleet.

targetCapacitySpecificationRequired
IResolvable | TargetCapacitySpecificationRequestProperty

The number of units to request.

contextOptional
string

Reserved.

excessCapacityTerminationPolicyOptional
string

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported only for fleets of type `maintain` .

onDemandOptionsOptional
IResolvable | OnDemandOptionsRequestProperty

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

replaceUnhealthyInstancesOptional
boolean | IResolvable

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type `maintain` . For more information, see [EC2 Fleet health checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) in the *Amazon EC2 User Guide* .

reservedCapacityOptionsOptional
IResolvable | ReservedCapacityOptionsRequestProperty
spotOptionsOptional
IResolvable | SpotOptionsRequestProperty

Describes the configuration of Spot Instances in an EC2 Fleet.

tagSpecificationsOptional
IResolvable | IResolvable | TagSpecificationProperty[]

The key-value pair for tagging the EC2 Fleet request on creation. For more information, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) .

terminateInstancesWithExpirationOptional
boolean | IResolvable

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

typeOptional
string

The fleet type. The default value is `maintain` . - `maintain` - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances. - `request` - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted. - `instant` - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched. For more information, see [EC2 Fleet request types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide* .

validFromOptional
string

The start date and time of the request, in UTC format (for example, *YYYY* - *MM* - *DD* T *HH* : *MM* : *SS* Z). The default is to start fulfilling the request immediately.

validUntilOptional
string

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic