Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.CreateCapacityReservation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon EC2 User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Quotas in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data CreateCapacityReservation Source #

See: newCreateCapacityReservation smart constructor.

Constructors

CreateCapacityReservation'

Fields

availabilityZone :: Maybe Text
The Availability Zone in which to create the Capacity Reservation.
availabilityZoneId :: Maybe Text
The ID of the Availability Zone in which to create the Capacity Reservation.
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.
ebsOptimized :: Maybe Bool
Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
endDate :: Maybe ISO8601
The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
endDateType :: Maybe EndDateType
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
- unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
- limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.
ephemeralStorage :: Maybe Bool
Deprecated.
instanceMatchCriteria :: Maybe InstanceMatchCriteria
Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
- open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
- targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
outpostArn :: Maybe Text
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
placementGroupArn :: Maybe Text
The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
tagSpecifications :: Maybe [TagSpecification]
The tags to apply to the Capacity Reservation during launch.
tenancy :: Maybe CapacityReservationTenancy
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
- default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
- dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
instanceType :: Text
The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.
instancePlatform :: CapacityReservationInstancePlatform
The type of operating system for which to reserve capacity.
instanceCount :: Int
The number of instances for which to reserve capacity.
Valid range: 1 - 1000

Instances

Instances details

ToHeaders CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods toHeaders :: CreateCapacityReservation -> [Header] #
ToPath CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods toPath :: CreateCapacityReservation -> ByteString #
ToQuery CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods toQuery :: CreateCapacityReservation -> QueryString #
AWSRequest CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Associated Types type AWSResponse CreateCapacityReservation # Methods request :: (Service -> Service) -> CreateCapacityReservation -> Request CreateCapacityReservation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateCapacityReservation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateCapacityReservation))) #
Generic CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Associated Types type Rep CreateCapacityReservation :: Type -> Type # Methods from :: CreateCapacityReservation -> Rep CreateCapacityReservation x # to :: Rep CreateCapacityReservation x -> CreateCapacityReservation #
Read CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods readsPrec :: Int -> ReadS CreateCapacityReservation # readList :: ReadS [CreateCapacityReservation] # readPrec :: ReadPrec CreateCapacityReservation # readListPrec :: ReadPrec [CreateCapacityReservation] #
Show CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods showsPrec :: Int -> CreateCapacityReservation -> ShowS # show :: CreateCapacityReservation -> String # showList :: [CreateCapacityReservation] -> ShowS #
NFData CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods rnf :: CreateCapacityReservation -> () #
Eq CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods (==) :: CreateCapacityReservation -> CreateCapacityReservation -> Bool # (/=) :: CreateCapacityReservation -> CreateCapacityReservation -> Bool #
Hashable CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods hashWithSalt :: Int -> CreateCapacityReservation -> Int # hash :: CreateCapacityReservation -> Int #
type AWSResponse CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation type AWSResponse CreateCapacityReservation = CreateCapacityReservationResponse
type Rep CreateCapacityReservation Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation type Rep CreateCapacityReservation = D1 ('MetaData "CreateCapacityReservation" "Amazonka.EC2.CreateCapacityReservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateCapacityReservation'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "availabilityZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "ebsOptimized") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :: (S1 ('MetaSel ('Just "endDateType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndDateType)) :: S1 ('MetaSel ('Just "ephemeralStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "instanceMatchCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMatchCriteria)) :: S1 ('MetaSel ('Just "outpostArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "placementGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tagSpecifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagSpecification])))) :: ((S1 ('MetaSel ('Just "tenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityReservationTenancy)) :: S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "instancePlatform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CapacityReservationInstancePlatform) :*: S1 ('MetaSel ('Just "instanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newCreateCapacityReservation Source #

Arguments

:: Text	`CreateCapacityReservation`
-> CapacityReservationInstancePlatform	`CreateCapacityReservation`
-> Int	`CreateCapacityReservation`
-> CreateCapacityReservation

Create a value of CreateCapacityReservation 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:

CreateCapacityReservation, createCapacityReservation_availabilityZone - The Availability Zone in which to create the Capacity Reservation.

CreateCapacityReservation, createCapacityReservation_availabilityZoneId - The ID of the Availability Zone in which to create the Capacity Reservation.

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

$sel:dryRun:CreateCapacityReservation', createCapacityReservation_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.

CreateCapacityReservation, createCapacityReservation_ebsOptimized - Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

CreateCapacityReservation, createCapacityReservation_endDate - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

CreateCapacityReservation, createCapacityReservation_endDateType - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

CreateCapacityReservation, createCapacityReservation_ephemeralStorage - Deprecated.

CreateCapacityReservation, createCapacityReservation_instanceMatchCriteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

CreateCapacityReservation, createCapacityReservation_outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

CreateCapacityReservation, createCapacityReservation_placementGroupArn - The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

CreateCapacityReservation, createCapacityReservation_tagSpecifications - The tags to apply to the Capacity Reservation during launch.

CreateCapacityReservation, createCapacityReservation_tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

CreateCapacityReservation, createCapacityReservation_instanceType - The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

CreateCapacityReservation, createCapacityReservation_instancePlatform - The type of operating system for which to reserve capacity.

CreateCapacityReservation, createCapacityReservation_instanceCount - The number of instances for which to reserve capacity.

Valid range: 1 - 1000

Request Lenses

createCapacityReservation_availabilityZone :: Lens' CreateCapacityReservation (Maybe Text) Source #

The Availability Zone in which to create the Capacity Reservation.

createCapacityReservation_availabilityZoneId :: Lens' CreateCapacityReservation (Maybe Text) Source #

The ID of the Availability Zone in which to create the Capacity Reservation.

createCapacityReservation_clientToken :: Lens' CreateCapacityReservation (Maybe Text) Source #

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

createCapacityReservation_dryRun :: Lens' CreateCapacityReservation (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.

createCapacityReservation_ebsOptimized :: Lens' CreateCapacityReservation (Maybe Bool) Source #

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

createCapacityReservation_endDate :: Lens' CreateCapacityReservation (Maybe UTCTime) Source #

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

createCapacityReservation_endDateType :: Lens' CreateCapacityReservation (Maybe EndDateType) Source #

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

createCapacityReservation_ephemeralStorage :: Lens' CreateCapacityReservation (Maybe Bool) Source #

Deprecated.

createCapacityReservation_instanceMatchCriteria :: Lens' CreateCapacityReservation (Maybe InstanceMatchCriteria) Source #

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

createCapacityReservation_outpostArn :: Lens' CreateCapacityReservation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

createCapacityReservation_placementGroupArn :: Lens' CreateCapacityReservation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

createCapacityReservation_tagSpecifications :: Lens' CreateCapacityReservation (Maybe [TagSpecification]) Source #

The tags to apply to the Capacity Reservation during launch.

createCapacityReservation_tenancy :: Lens' CreateCapacityReservation (Maybe CapacityReservationTenancy) Source #

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

createCapacityReservation_instanceType :: Lens' CreateCapacityReservation Text Source #

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

createCapacityReservation_instancePlatform :: Lens' CreateCapacityReservation CapacityReservationInstancePlatform Source #

The type of operating system for which to reserve capacity.

createCapacityReservation_instanceCount :: Lens' CreateCapacityReservation Int Source #

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

Destructuring the Response

data CreateCapacityReservationResponse Source #

See: newCreateCapacityReservationResponse smart constructor.

Constructors

CreateCapacityReservationResponse'
Fields capacityReservation :: Maybe CapacityReservation Information about the Capacity Reservation. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Associated Types type Rep CreateCapacityReservationResponse :: Type -> Type # Methods from :: CreateCapacityReservationResponse -> Rep CreateCapacityReservationResponse x # to :: Rep CreateCapacityReservationResponse x -> CreateCapacityReservationResponse #
Read CreateCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods readsPrec :: Int -> ReadS CreateCapacityReservationResponse # readList :: ReadS [CreateCapacityReservationResponse] # readPrec :: ReadPrec CreateCapacityReservationResponse # readListPrec :: ReadPrec [CreateCapacityReservationResponse] #
Show CreateCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods showsPrec :: Int -> CreateCapacityReservationResponse -> ShowS # show :: CreateCapacityReservationResponse -> String # showList :: [CreateCapacityReservationResponse] -> ShowS #
NFData CreateCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods rnf :: CreateCapacityReservationResponse -> () #
Eq CreateCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation Methods (==) :: CreateCapacityReservationResponse -> CreateCapacityReservationResponse -> Bool # (/=) :: CreateCapacityReservationResponse -> CreateCapacityReservationResponse -> Bool #
type Rep CreateCapacityReservationResponse Source #
Instance details Defined in Amazonka.EC2.CreateCapacityReservation type Rep CreateCapacityReservationResponse = D1 ('MetaData "CreateCapacityReservationResponse" "Amazonka.EC2.CreateCapacityReservation" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "CreateCapacityReservationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacityReservation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityReservation)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCapacityReservationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateCapacityReservationResponse'`
-> CreateCapacityReservationResponse

Create a value of CreateCapacityReservationResponse 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:

$sel:capacityReservation:CreateCapacityReservationResponse', createCapacityReservationResponse_capacityReservation - Information about the Capacity Reservation.

$sel:httpStatus:CreateCapacityReservationResponse', createCapacityReservationResponse_httpStatus - The response's http status code.

Response Lenses

createCapacityReservationResponse_capacityReservation :: Lens' CreateCapacityReservationResponse (Maybe CapacityReservation) Source #

Information about the Capacity Reservation.

createCapacityReservationResponse_httpStatus :: Lens' CreateCapacityReservationResponse Int Source #

The response's http status code.