create_fleet¶
Operation¶
async
¶
create_fleet(input: CreateFleetInput, plugins: list[Plugin] | None = None) -> CreateFleetOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateFleetInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateFleetOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateFleetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
class-attribute
instance-attribute
¶
excess_capacity_termination_policy: str | None = ...
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.
class-attribute
instance-attribute
¶
launch_template_configs: list[FleetLaunchTemplateConfigRequest] | None = ...
The configuration for the EC2 Fleet.
class-attribute
instance-attribute
¶
Describes the configuration of On-Demand Instances in an EC2 Fleet.
class-attribute
instance-attribute
¶
replace_unhealthy_instances: bool | None = ...
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.
class-attribute
instance-attribute
¶
Defines EC2 Fleet preferences for utilizing reserved capacity when
DefaultTargetCapacityType is set to reserved-capacity.
Supported only for fleets of type instant.
class-attribute
instance-attribute
¶
Describes the configuration of Spot Instances in an EC2 Fleet.
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
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, instance to tag the instances at launch, volume to
tag the volumes at launch, or network-interface to tag the network
interfaces 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, volume, or network-interface. To tag instances at
launch, specify the tags in a launch
template.
class-attribute
instance-attribute
¶
The number of units to request.
class-attribute
instance-attribute
¶
terminate_instances_with_expiration: bool | None = ...
Indicates whether running instances should be terminated when the EC2 Fleet expires.
class-attribute
instance-attribute
¶
type: str | None = ...
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.
class-attribute
instance-attribute
¶
valid_from: datetime | None = ...
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.
class-attribute
instance-attribute
¶
valid_until: datetime | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateFleetOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
errors: list[CreateFleetError] | None = ...
Information about the instances that could not be launched by the fleet.
Supported only for fleets of type instant.
class-attribute
instance-attribute
¶
instances: list[CreateFleetInstance] | None = ...
Information about the instances that were launched by the fleet.
Supported only for fleets of type instant.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.