CreateFleetRequest
¶
Source code in docs_src/capo_ec2/types/create_fleet_request.py
client_token
instance-attribute
¶
client_token: NotRequired[String]
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.
dry_run
instance-attribute
¶
dry_run: NotRequired[Boolean]
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.
excess_capacity_termination_policy
instance-attribute
¶
excess_capacity_termination_policy: NotRequired[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.
Supported only for fleets of type maintain.
launch_template_configs
instance-attribute
¶
launch_template_configs: NotRequired[FleetLaunchTemplateConfigListRequest]
The configuration for the EC2 Fleet.
on_demand_options
instance-attribute
¶
on_demand_options: NotRequired[OnDemandOptionsRequest]
Describes the configuration of On-Demand Instances in an EC2 Fleet.
replace_unhealthy_instances
instance-attribute
¶
replace_unhealthy_instances: NotRequired[Boolean]
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.
reserved_capacity_options
instance-attribute
¶
reserved_capacity_options: NotRequired[ReservedCapacityOptionsRequest]
Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to reserved-capacity.
Supported only for fleets of type instant.
spot_options
instance-attribute
¶
spot_options: NotRequired[SpotOptionsRequest]
Describes the configuration of Spot Instances in an EC2 Fleet.
tag_specifications
instance-attribute
¶
tag_specifications: NotRequired[TagSpecificationList]
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.
target_capacity_specification
instance-attribute
¶
target_capacity_specification: NotRequired[TargetCapacitySpecificationRequest]
The number of units to request.
terminate_instances_with_expiration
instance-attribute
¶
terminate_instances_with_expiration: NotRequired[Boolean]
Indicates whether running instances should be terminated when the EC2 Fleet expires.
type
instance-attribute
¶
type: NotRequired[FleetType]
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.
valid_from
instance-attribute
¶
valid_from: NotRequired[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.
valid_until
instance-attribute
¶
valid_until: NotRequired[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.