AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud CreateFleet API operation.

Syntax

New-EC2Fleet
-LaunchTemplateConfig <FleetLaunchTemplateConfigRequest[]>
-OnDemandOptions_AllocationStrategy <FleetOnDemandAllocationStrategy>
-SpotOptions_AllocationStrategy <SpotAllocationStrategy>
-ClientToken <String>
-TargetCapacitySpecification_DefaultTargetCapacityType <DefaultTargetCapacityType>
-ExcessCapacityTerminationPolicy <FleetExcessCapacityTerminationPolicy>
-SpotOptions_InstanceInterruptionBehavior <SpotInstanceInterruptionBehavior>
-SpotOptions_InstancePoolsToUseCount <Int32>
-OnDemandOptions_MaxTotalPrice <String>
-SpotOptions_MaxTotalPrice <String>
-OnDemandOptions_MinTargetCapacity <Int32>
-SpotOptions_MinTargetCapacity <Int32>
-TargetCapacitySpecification_OnDemandTargetCapacity <Int32>
-ReplaceUnhealthyInstance <Boolean>
-OnDemandOptions_SingleAvailabilityZone <Boolean>
-SpotOptions_SingleAvailabilityZone <Boolean>
-OnDemandOptions_SingleInstanceType <Boolean>
-SpotOptions_SingleInstanceType <Boolean>
-TargetCapacitySpecification_SpotTargetCapacity <Int32>
-TagSpecification <TagSpecification[]>
-TerminateInstancesWithExpiration <Boolean>
-TargetCapacitySpecification_TotalTargetCapacity <Int32>
-Type <FleetType>
-UtcValidFrom <DateTime>
-UtcValidUntil <DateTime>
-ValidFrom <DateTime>
-ValidUntil <DateTime>
-Force <SwitchParameter>

Description

Launches an EC2 Fleet. You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.

Parameters

-ClientToken <String>
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Required?False
Position?Named
Accept pipeline input?False
-ExcessCapacityTerminationPolicy <FleetExcessCapacityTerminationPolicy>
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.
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-LaunchTemplateConfig <FleetLaunchTemplateConfigRequest[]>
The configuration for the EC2 Fleet.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
AliasesLaunchTemplateConfigs
-OnDemandOptions_AllocationStrategy <FleetOnDemandAllocationStrategy>
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.
Required?False
Position?Named
Accept pipeline input?False
-OnDemandOptions_MaxTotalPrice <String>
The maximum amount per hour for On-Demand Instances that you're willing to pay.
Required?False
Position?Named
Accept pipeline input?False
-OnDemandOptions_MinTargetCapacity <Int32>
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Required?False
Position?Named
Accept pipeline input?False
-OnDemandOptions_SingleAvailabilityZone <Boolean>
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Required?False
Position?Named
Accept pipeline input?False
-OnDemandOptions_SingleInstanceType <Boolean>
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Required?False
Position?Named
Accept pipeline input?False
-ReplaceUnhealthyInstance <Boolean>
Indicates whether EC2 Fleet should replace unhealthy instances.
Required?False
Position?Named
Accept pipeline input?False
AliasesReplaceUnhealthyInstances
-SpotOptions_AllocationStrategy <SpotAllocationStrategy>
Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.If the allocation strategy is lowestPrice, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.If the allocation strategy is diversified, EC2 Fleet launches instances from all the Spot Instance pools that you specify.If the allocation strategy is capacityOptimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.
Required?False
Position?Named
Accept pipeline input?False
-SpotOptions_InstanceInterruptionBehavior <SpotInstanceInterruptionBehavior>
The behavior when a Spot Instance is interrupted. The default is terminate.
Required?False
Position?Named
Accept pipeline input?False
-SpotOptions_InstancePoolsToUseCount <Int32>
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Required?False
Position?Named
Accept pipeline input?False
-SpotOptions_MaxTotalPrice <String>
The maximum amount per hour for Spot Instances that you're willing to pay.
Required?False
Position?Named
Accept pipeline input?False
-SpotOptions_MinTargetCapacity <Int32>
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Required?False
Position?Named
Accept pipeline input?False
-SpotOptions_SingleAvailabilityZone <Boolean>
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Required?False
Position?Named
Accept pipeline input?False
-SpotOptions_SingleInstanceType <Boolean>
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Required?False
Position?Named
Accept pipeline input?False
-TagSpecification <TagSpecification[]>
The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.
Required?False
Position?Named
Accept pipeline input?False
AliasesTagSpecifications
-TargetCapacitySpecification_DefaultTargetCapacityType <DefaultTargetCapacityType>
The default TotalTargetCapacity, which is either Spot or On-Demand.
Required?False
Position?Named
Accept pipeline input?False
-TargetCapacitySpecification_OnDemandTargetCapacity <Int32>
The number of On-Demand units to request.
Required?False
Position?Named
Accept pipeline input?False
-TargetCapacitySpecification_SpotTargetCapacity <Int32>
The number of Spot units to request.
Required?False
Position?Named
Accept pipeline input?False
-TargetCapacitySpecification_TotalTargetCapacity <Int32>
The number of units to request, filled using DefaultTargetCapacityType.
Required?False
Position?Named
Accept pipeline input?False
-TerminateInstancesWithExpiration <Boolean>
Indicates whether running instances should be terminated when the EC2 Fleet expires.
Required?False
Position?Named
Accept pipeline input?False
-Type <FleetType>
The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
Required?False
Position?Named
Accept pipeline input?False
-UtcValidFrom <DateTime>
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?False
Position?Named
Accept pipeline input?False
-UtcValidUntil <DateTime>
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?False
Position?Named
Accept pipeline input?False
-ValidFrom <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ValidFromUtc instead. Setting either ValidFrom or ValidFromUtc results in both ValidFrom and ValidFromUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ValidFrom is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.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.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?False
-ValidUntil <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use ValidUntilUtc instead. Setting either ValidUntil or ValidUntilUtc results in both ValidUntil and ValidUntilUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. ValidUntil is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.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.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
Aliases AK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
Aliases AWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
Aliases AWSProfileName, StoredCredentials
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
Aliases SecretAccessKey, SK
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
Aliases RegionToCall
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a FleetLaunchTemplateConfigRequest[] object to this cmdlet for the LaunchTemplateConfig parameter.

Outputs

This cmdlet returns a Amazon.EC2.Model.CreateFleetResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z