create_capacity_reservation_fleet¶
Operation¶
async
¶
create_capacity_reservation_fleet(input: CreateCapacityReservationFleetInput, plugins: list[Plugin] | None = None) -> CreateCapacityReservationFleetOutput
Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateCapacityReservationFleetInput
|
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 |
|---|---|
CreateCapacityReservationFleetOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateCapacityReservationFleetInput structure.
Attributes¶
class-attribute
instance-attribute
¶
allocation_strategy: str | None = ...
The strategy used by the Capacity Reservation Fleet to determine which
of the specified instance types to use. Currently, only the
prioritized allocation strategy is supported. For more information,
see Allocation
strategy
in the Amazon EC2 User Guide.
Valid values: prioritized
class-attribute
instance-attribute
¶
availability_zone: str | None = ...
Reserved for internal use.
class-attribute
instance-attribute
¶
availability_zone_id: str | None = ...
Reserved for internal use.
class-attribute
instance-attribute
¶
client_token: str | None = ...
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure 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
¶
end_date: datetime | None = ...
The date and time at which the Capacity Reservation Fleet expires. When
the Capacity Reservation Fleet expires, its state changes to expired
and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the
specified time. For example, if you specify 5/31/2019, 13:30:55, the
Capacity Reservation Fleet is guaranteed to expire between 13:30:55
and 14:30:55 on 5/31/2019.
class-attribute
instance-attribute
¶
instance_match_criteria: str | None = ...
Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.
Currently, Capacity Reservation Fleets support open instance matching
criteria only. This means that instances that have matching attributes
(instance type, platform, and Availability Zone) run in the Capacity
Reservations automatically. Instances do not need to explicitly target a
Capacity Reservation Fleet to use its reserved capacity.
class-attribute
instance-attribute
¶
Reserved for internal use.
class-attribute
instance-attribute
¶
instance_type_specifications: list[ReservationFleetInstanceSpecification] | None = ...
Information about the instance types for which to reserve the capacity.
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.
class-attribute
instance-attribute
¶
tenancy: str | None = ...
Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:
-
default- The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts. -
dedicated- The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
class-attribute
instance-attribute
¶
total_target_capacity: int | None = ...
The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateCapacityReservationFleetOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
allocation_strategy: str | None = ...
The allocation strategy used by the Capacity Reservation Fleet.
class-attribute
instance-attribute
¶
capacity_reservation_fleet_id: str | None = ...
The ID of the Capacity Reservation Fleet.
class-attribute
instance-attribute
¶
create_time: datetime | None = ...
The date and time at which the Capacity Reservation Fleet was created.
class-attribute
instance-attribute
¶
end_date: datetime | None = ...
The date and time at which the Capacity Reservation Fleet expires.
class-attribute
instance-attribute
¶
fleet_capacity_reservations: list[FleetCapacityReservation] | None = ...
Information about the individual Capacity Reservations in the Capacity Reservation Fleet.
class-attribute
instance-attribute
¶
instance_match_criteria: str | None = ...
The instance matching criteria for the Capacity Reservation Fleet.
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.
class-attribute
instance-attribute
¶
state: str | None = ...
The status of the Capacity Reservation Fleet.
class-attribute
instance-attribute
¶
tags: list[Tag] | None = ...
The tags assigned to the Capacity Reservation Fleet.
class-attribute
instance-attribute
¶
tenancy: str | None = ...
Indicates the tenancy of Capacity Reservation Fleet.