aws-cdk-lib.aws_ec2.CfnCapacityReservationProps

interface CfnCapacityReservationProps

LanguageType name
.NETAmazon.CDK.AWS.EC2.CfnCapacityReservationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnCapacityReservationProps
Javasoftware.amazon.awscdk.services.ec2.CfnCapacityReservationProps
Pythonaws_cdk.aws_ec2.CfnCapacityReservationProps
TypeScript aws-cdk-lib » aws_ec2 » CfnCapacityReservationProps

Properties for defining a CfnCapacityReservation.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnCapacityReservationProps: ec2.CfnCapacityReservationProps = {
  availabilityZone: 'availabilityZone',
  instanceCount: 123,
  instancePlatform: 'instancePlatform',
  instanceType: 'instanceType',

  // the properties below are optional
  ebsOptimized: false,
  endDate: 'endDate',
  endDateType: 'endDateType',
  ephemeralStorage: false,
  instanceMatchCriteria: 'instanceMatchCriteria',
  outPostArn: 'outPostArn',
  placementGroupArn: 'placementGroupArn',
  tagSpecifications: [{
    resourceType: 'resourceType',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  tenancy: 'tenancy',
};

Properties

NameTypeDescription
availabilityZonestringThe Availability Zone in which to create the Capacity Reservation.
instanceCountnumberThe number of instances for which to reserve capacity.
instancePlatformstringThe type of operating system for which to reserve capacity.
instanceTypestringThe instance type for which to reserve capacity.
ebsOptimized?boolean | IResolvableIndicates whether the Capacity Reservation supports EBS-optimized instances.
endDate?stringThe date and time at which the Capacity Reservation expires.
endDateType?stringIndicates the way in which the Capacity Reservation ends.
ephemeralStorage?boolean | IResolvableDeprecated..
instanceMatchCriteria?stringIndicates the type of instance launches that the Capacity Reservation accepts. The options include:.
outPostArn?stringThe Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
placementGroupArn?stringThe Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.
tagSpecifications?IResolvable | IResolvable | TagSpecificationProperty[]The tags to apply to the Capacity Reservation during launch.
tenancy?stringIndicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:.

availabilityZone

Type: string

The Availability Zone in which to create the Capacity Reservation.


instanceCount

Type: number

The number of instances for which to reserve capacity.

Valid range: 1 - 1000


instancePlatform

Type: string

The type of operating system for which to reserve capacity.


instanceType

Type: string

The instance type for which to reserve capacity.

For more information, see Instance types in the Amazon EC2 User Guide .


ebsOptimized?

Type: boolean | IResolvable (optional)

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?

Type: string (optional)

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?

Type: string (optional)

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?

Type: boolean | IResolvable (optional)

Deprecated..


instanceMatchCriteria?

Type: string (optional)

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?

Type: string (optional)

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


placementGroupArn?

Type: string (optional)

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?

Type: IResolvable | IResolvable | TagSpecificationProperty[] (optional)

The tags to apply to the Capacity Reservation during launch.


tenancy?

Type: string (optional)

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 .