amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.CreateCapacityReservationFleet

Description

Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data CreateCapacityReservationFleet Source #

See: newCreateCapacityReservationFleet smart constructor.

Constructors

CreateCapacityReservationFleet' 

Fields

  • allocationStrategy :: Maybe Text

    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

  • clientToken :: Maybe Text

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

  • dryRun :: Maybe Bool

    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.

  • endDate :: Maybe ISO8601

    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.

  • instanceMatchCriteria :: Maybe FleetInstanceMatchCriteria

    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.

  • tagSpecifications :: Maybe [TagSpecification]

    The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

  • tenancy :: Maybe FleetCapacityReservationTenancy

    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.
  • instanceTypeSpecifications :: [ReservationFleetInstanceSpecification]

    Information about the instance types for which to reserve the capacity.

  • totalTargetCapacity :: Int

    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.

Instances

Instances details
ToHeaders CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

ToPath CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

ToQuery CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

AWSRequest CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Generic CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Associated Types

type Rep CreateCapacityReservationFleet :: Type -> Type #

Read CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Show CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

NFData CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Eq CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Hashable CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

type AWSResponse CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

type Rep CreateCapacityReservationFleet Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

newCreateCapacityReservationFleet Source #

Create a value of CreateCapacityReservationFleet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCapacityReservationFleet, createCapacityReservationFleet_allocationStrategy - 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

CreateCapacityReservationFleet, createCapacityReservationFleet_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

$sel:dryRun:CreateCapacityReservationFleet', createCapacityReservationFleet_dryRun - 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.

CreateCapacityReservationFleet, createCapacityReservationFleet_endDate - 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.

CreateCapacityReservationFleet, createCapacityReservationFleet_instanceMatchCriteria - 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.

CreateCapacityReservationFleet, createCapacityReservationFleet_tagSpecifications - The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

CreateCapacityReservationFleet, createCapacityReservationFleet_tenancy - 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.

CreateCapacityReservationFleet, createCapacityReservationFleet_instanceTypeSpecifications - Information about the instance types for which to reserve the capacity.

CreateCapacityReservationFleet, createCapacityReservationFleet_totalTargetCapacity - 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.

Request Lenses

createCapacityReservationFleet_allocationStrategy :: Lens' CreateCapacityReservationFleet (Maybe Text) Source #

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

createCapacityReservationFleet_clientToken :: Lens' CreateCapacityReservationFleet (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

createCapacityReservationFleet_dryRun :: Lens' CreateCapacityReservationFleet (Maybe Bool) Source #

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.

createCapacityReservationFleet_endDate :: Lens' CreateCapacityReservationFleet (Maybe UTCTime) Source #

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.

createCapacityReservationFleet_instanceMatchCriteria :: Lens' CreateCapacityReservationFleet (Maybe FleetInstanceMatchCriteria) Source #

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.

createCapacityReservationFleet_tagSpecifications :: Lens' CreateCapacityReservationFleet (Maybe [TagSpecification]) Source #

The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.

createCapacityReservationFleet_tenancy :: Lens' CreateCapacityReservationFleet (Maybe FleetCapacityReservationTenancy) Source #

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.

createCapacityReservationFleet_totalTargetCapacity :: Lens' CreateCapacityReservationFleet Int Source #

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.

Destructuring the Response

data CreateCapacityReservationFleetResponse Source #

Constructors

CreateCapacityReservationFleetResponse' 

Fields

Instances

Instances details
Generic CreateCapacityReservationFleetResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Read CreateCapacityReservationFleetResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Show CreateCapacityReservationFleetResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

NFData CreateCapacityReservationFleetResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

Eq CreateCapacityReservationFleetResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

type Rep CreateCapacityReservationFleetResponse Source # 
Instance details

Defined in Amazonka.EC2.CreateCapacityReservationFleet

type Rep CreateCapacityReservationFleetResponse = D1 ('MetaData "CreateCapacityReservationFleetResponse" "Amazonka.EC2.CreateCapacityReservationFleet" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateCapacityReservationFleetResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allocationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "capacityReservationFleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: (S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "fleetCapacityReservations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FleetCapacityReservation])) :*: S1 ('MetaSel ('Just "instanceMatchCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetInstanceMatchCriteria))))) :*: ((S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityReservationFleetState)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "tenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetCapacityReservationTenancy)))) :*: (S1 ('MetaSel ('Just "totalFulfilledCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "totalTargetCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateCapacityReservationFleetResponse Source #

Create a value of CreateCapacityReservationFleetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCapacityReservationFleet, createCapacityReservationFleetResponse_allocationStrategy - The allocation strategy used by the Capacity Reservation Fleet.

CreateCapacityReservationFleetResponse, createCapacityReservationFleetResponse_capacityReservationFleetId - The ID of the Capacity Reservation Fleet.

CreateCapacityReservationFleetResponse, createCapacityReservationFleetResponse_createTime - The date and time at which the Capacity Reservation Fleet was created.

CreateCapacityReservationFleet, createCapacityReservationFleetResponse_endDate - The date and time at which the Capacity Reservation Fleet expires.

$sel:fleetCapacityReservations:CreateCapacityReservationFleetResponse', createCapacityReservationFleetResponse_fleetCapacityReservations - Information about the individual Capacity Reservations in the Capacity Reservation Fleet.

CreateCapacityReservationFleet, createCapacityReservationFleetResponse_instanceMatchCriteria - The instance matching criteria for the Capacity Reservation Fleet.

CreateCapacityReservationFleetResponse, createCapacityReservationFleetResponse_state - The status of the Capacity Reservation Fleet.

CreateCapacityReservationFleetResponse, createCapacityReservationFleetResponse_tags - The tags assigned to the Capacity Reservation Fleet.

CreateCapacityReservationFleet, createCapacityReservationFleetResponse_tenancy - Indicates the tenancy of Capacity Reservation Fleet.

CreateCapacityReservationFleetResponse, createCapacityReservationFleetResponse_totalFulfilledCapacity - The requested capacity units that have been successfully reserved.

CreateCapacityReservationFleet, createCapacityReservationFleetResponse_totalTargetCapacity - The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.

$sel:httpStatus:CreateCapacityReservationFleetResponse', createCapacityReservationFleetResponse_httpStatus - The response's http status code.

Response Lenses

createCapacityReservationFleetResponse_createTime :: Lens' CreateCapacityReservationFleetResponse (Maybe UTCTime) Source #

The date and time at which the Capacity Reservation Fleet was created.

createCapacityReservationFleetResponse_endDate :: Lens' CreateCapacityReservationFleetResponse (Maybe UTCTime) Source #

The date and time at which the Capacity Reservation Fleet expires.

createCapacityReservationFleetResponse_fleetCapacityReservations :: Lens' CreateCapacityReservationFleetResponse (Maybe [FleetCapacityReservation]) Source #

Information about the individual Capacity Reservations in the Capacity Reservation Fleet.

createCapacityReservationFleetResponse_totalTargetCapacity :: Lens' CreateCapacityReservationFleetResponse (Maybe Int) Source #

The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.