Syntax Properties Return values See also

AWS::EC2::EC2Fleet

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 in the Amazon EC2 User Guide.

Syntax

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

JSON


{
  "Type" : "AWS::EC2::EC2Fleet",
  "Properties" : {
      "Context" : String,
      "ExcessCapacityTerminationPolicy" : String,
      "LaunchTemplateConfigs" : [ FleetLaunchTemplateConfigRequest, ... ],
      "OnDemandOptions" : OnDemandOptionsRequest,
      "ReplaceUnhealthyInstances" : Boolean,
      "SpotOptions" : SpotOptionsRequest,
      "TagSpecifications" : [ TagSpecification, ... ],
      "TargetCapacitySpecification" : TargetCapacitySpecificationRequest,
      "TerminateInstancesWithExpiration" : Boolean,
      "Type" : String,
      "ValidFrom" : String,
      "ValidUntil" : String
    }
}

YAML


Type: AWS::EC2::EC2Fleet
Properties:
  Context: String
  ExcessCapacityTerminationPolicy: String
  LaunchTemplateConfigs: 
    - FleetLaunchTemplateConfigRequest
  OnDemandOptions: 
    OnDemandOptionsRequest
  ReplaceUnhealthyInstances: Boolean
  SpotOptions: 
    SpotOptionsRequest
  TagSpecifications: 
    - TagSpecification
  TargetCapacitySpecification: 
    TargetCapacitySpecificationRequest
  TerminateInstancesWithExpiration: Boolean
  Type: String
  ValidFrom: String
  ValidUntil: String

Properties

Context

Reserved.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: termination | no-termination

Update requires: No interruption

LaunchTemplateConfigs

The configuration for the EC2 Fleet.

Required: Yes

Type: Array of FleetLaunchTemplateConfigRequest

Maximum: 50

Update requires: Replacement

OnDemandOptions

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

Required: No

Type: OnDemandOptionsRequest

Update requires: Replacement

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.

Required: No

Type: Boolean

Update requires: Replacement

SpotOptions

Describes the configuration of Spot Instances in an EC2 Fleet.

Required: No

Type: SpotOptionsRequest

Update requires: Replacement

TagSpecifications

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.

Required: No

Type: Array of TagSpecification

Update requires: Replacement

TargetCapacitySpecification

The number of units to request.

Required: Yes

Type: TargetCapacitySpecificationRequest

Update requires: No interruption

TerminateInstancesWithExpiration

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

Required: No

Type: Boolean

Update requires: Replacement

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.

Required: No

Type: String

Allowed values: maintain | request | instant

Update requires: Replacement

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.

Required: No

Type: String

Update requires: Replacement

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.

Required: No

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the fleet ID, such as fleet-1fe24079-d272-4023-8e7c-70e10784cb0e.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

FleetId: The ID of the EC2 Fleet.