AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::CapacityReservation

CfnCapacityReservation

Creates a new Capacity Reservation with the specified attributes. For more information, see [Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide* .

Import

import { CfnCapacityReservation } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnCapacityReservation

Properties

Configuration passed to the constructor as CfnCapacityReservationProps.

instanceCountRequired
number

The number of instances for which to reserve capacity. > You can request future-dated Capacity Reservations for an instance count with a minimum of 32 vCPUs. For example, if you request a future-dated Capacity Reservation for `m5.xlarge` instances, you must request at least 8 instances ( *8 * m5.xlarge = 32 vCPUs* ). Valid range: 1 - 1000

instancePlatformRequired
string

The type of operating system for which to reserve capacity.

instanceTypeRequired
string

The instance type for which to reserve capacity. > You can request future-dated Capacity Reservations for instance types in the C, M, R, I, T, and G instance families only. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .

availabilityZoneOptional
string

The Availability Zone in which to create the Capacity Reservation.

availabilityZoneIdOptional
string

The ID of the Availability Zone in which the capacity is reserved.

ebsOptimizedOptional
boolean | IResolvable

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.

endDateOptional
string

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. If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

endDateTypeOptional
string

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` .

ephemeralStorageOptional
boolean | IResolvable

*Deprecated.*.

instanceMatchCriteriaOptional
string

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. > If you are requesting a future-dated Capacity Reservation, you must specify `targeted` . Default: `open`

outPostArnOptional
string

> Not supported for future-dated Capacity Reservations. The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

placementGroupArnOptional
string

> Not supported for future-dated Capacity Reservations. 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide* .

tagSpecificationsOptional
IResolvable | IResolvable | TagSpecificationProperty[]

The tags to apply to the Capacity Reservation during launch.

tenancyOptional
string

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 AWS accounts . - `dedicated` - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .

unusedReservationBillingOwnerIdOptional
string

The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation. A request will be sent to the specified account. That account must accept the request for the billing to be assigned to their account. For more information, see [Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html) . You can assign billing only for shared Capacity Reservations. To share a Capacity Reservation, you must add it to a resource share. For more information, see [AWS::RAM::ResourceShare](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ram-resourceshare.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic