Package software.amazon.awscdk.services.ec2

Class CfnCapacityReservation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnCapacityReservation
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, ICapacityReservationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:02.633Z") @Stability(Stable) public class CfnCapacityReservation extends CfnResource implements IInspectable, ICapacityReservationRef, ITaggableV2
Creates a new Capacity Reservation with the specified attributes.

For more information, see Capacity Reservations in the Amazon EC2 User Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnCapacityReservation cfnCapacityReservation = CfnCapacityReservation.Builder.create(this, "MyCfnCapacityReservation")
         .instanceCount(123)
         .instancePlatform("instancePlatform")
         .instanceType("instanceType")
         // the properties below are optional
         .availabilityZone("availabilityZone")
         .availabilityZoneId("availabilityZoneId")
         .ebsOptimized(false)
         .endDate("endDate")
         .endDateType("endDateType")
         .ephemeralStorage(false)
         .instanceMatchCriteria("instanceMatchCriteria")
         .outPostArn("outPostArn")
         .placementGroupArn("placementGroupArn")
         .tagSpecifications(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .tenancy("tenancy")
         .unusedReservationBillingOwnerId("unusedReservationBillingOwnerId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCapacityReservation

      protected CfnCapacityReservation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCapacityReservation

      protected CfnCapacityReservation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCapacityReservation

      @Stability(Stable) public CfnCapacityReservation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCapacityReservationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromCapacityReservationArn

      @Stability(Stable) @NotNull public static ICapacityReservationRef fromCapacityReservationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICapacityReservationRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCapacityReservationId

      @Stability(Stable) @NotNull public static ICapacityReservationRef fromCapacityReservationId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String capacityReservationId)
      Creates a new ICapacityReservationRef from a capacityReservationId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      capacityReservationId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAvailabilityZone

      @Stability(Stable) @NotNull public String getAttrAvailabilityZone()
      Returns the Availability Zone in which the capacity is reserved.

      For example: us-east-1a .

    • getAttrAvailableInstanceCount

      @Stability(Stable) @NotNull public Number getAttrAvailableInstanceCount()
      Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation.

      For example: 9 .

    • getAttrCapacityAllocationSet

      @Stability(Stable) @NotNull public IResolvable getAttrCapacityAllocationSet()

    • getAttrCapacityReservationArn

      @Stability(Stable) @NotNull public String getAttrCapacityReservationArn()
      The Amazon Resource Name (ARN) of the Capacity Reservation.

    • getAttrCapacityReservationFleetId

      @Stability(Stable) @NotNull public String getAttrCapacityReservationFleetId()
      The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs.

      Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.

    • getAttrCommitmentInfo

      @Stability(Stable) @NotNull public IResolvable getAttrCommitmentInfo()

    • getAttrCreateDate

      @Stability(Stable) @NotNull public String getAttrCreateDate()
      The date and time the Capacity Reservation was created.

    • getAttrDeliveryPreference

      @Stability(Stable) @NotNull public String getAttrDeliveryPreference()
      The delivery method for a future-dated Capacity Reservation.

      incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the Capacity Reservation.

    • getAttrInstanceType

      @Stability(Stable) @NotNull public String getAttrInstanceType()
      Returns the type of instance for which the capacity is reserved.

      For example: m4.large .

    • getAttrOwnerId

      @Stability(Stable) @NotNull public String getAttrOwnerId()
      The ID of the AWS account that owns the Capacity Reservation.

    • getAttrReservationType

      @Stability(Stable) @NotNull public String getAttrReservationType()
      The type of Capacity Reservation.

    • getAttrStartDate

      @Stability(Stable) @NotNull public String getAttrStartDate()
      The date and time the Capacity Reservation was started.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:.

      • active - The capacity is available for use.
      • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
      • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.
      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
      • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
      • scheduled - ( Future-dated Capacity Reservations ) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
      • payment-pending - ( Capacity Blocks ) The upfront payment has not been processed yet.
      • payment-failed - ( Capacity Blocks ) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.
      • assessing - ( Future-dated Capacity Reservations ) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
      • delayed - ( Future-dated Capacity Reservations ) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
      • unsupported - ( Future-dated Capacity Reservations ) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

    • getAttrTenancy

      @Stability(Stable) @NotNull public String getAttrTenancy()
      Returns the tenancy of the Capacity Reservation.

      For example: dedicated .

    • getAttrTotalInstanceCount

      @Stability(Stable) @NotNull public Number getAttrTotalInstanceCount()
      Returns the total number of instances for which the Capacity Reservation reserves capacity.

      For example: 15 .

    • getCapacityReservationRef

      @Stability(Stable) @NotNull public CapacityReservationReference getCapacityReservationRef()
      A reference to a CapacityReservation resource.
      Specified by:
      getCapacityReservationRef in interface ICapacityReservationRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceCount

      @Stability(Stable) @NotNull public Number getInstanceCount()
      The number of instances for which to reserve capacity.

    • setInstanceCount

      @Stability(Stable) public void setInstanceCount(@NotNull Number value)
      The number of instances for which to reserve capacity.

    • getInstancePlatform

      @Stability(Stable) @NotNull public String getInstancePlatform()
      The type of operating system for which to reserve capacity.

    • setInstancePlatform

      @Stability(Stable) public void setInstancePlatform(@NotNull String value)
      The type of operating system for which to reserve capacity.

    • getInstanceType

      @Stability(Stable) @NotNull public String getInstanceType()
      The instance type for which to reserve capacity.

    • setInstanceType

      @Stability(Stable) public void setInstanceType(@NotNull String value)
      The instance type for which to reserve capacity.

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      The Availability Zone in which to create the Capacity Reservation.

    • setAvailabilityZone

      @Stability(Stable) public void setAvailabilityZone(@Nullable String value)
      The Availability Zone in which to create the Capacity Reservation.

    • getAvailabilityZoneId

      @Stability(Stable) @Nullable public String getAvailabilityZoneId()
      The ID of the Availability Zone in which the capacity is reserved.

    • setAvailabilityZoneId

      @Stability(Stable) public void setAvailabilityZoneId(@Nullable String value)
      The ID of the Availability Zone in which the capacity is reserved.

    • getEbsOptimized

      @Stability(Stable) @Nullable public Object getEbsOptimized()
      Indicates whether the Capacity Reservation supports EBS-optimized instances.

      Returns union: either Boolean or IResolvable

    • setEbsOptimized

      @Stability(Stable) public void setEbsOptimized(@Nullable Boolean value)
      Indicates whether the Capacity Reservation supports EBS-optimized instances.

    • setEbsOptimized

      @Stability(Stable) public void setEbsOptimized(@Nullable IResolvable value)
      Indicates whether the Capacity Reservation supports EBS-optimized instances.

    • getEndDate

      @Stability(Stable) @Nullable public String getEndDate()
      The date and time at which the Capacity Reservation expires.

    • setEndDate

      @Stability(Stable) public void setEndDate(@Nullable String value)
      The date and time at which the Capacity Reservation expires.

    • getEndDateType

      @Stability(Stable) @Nullable public String getEndDateType()
      Indicates the way in which the Capacity Reservation ends.

    • setEndDateType

      @Stability(Stable) public void setEndDateType(@Nullable String value)
      Indicates the way in which the Capacity Reservation ends.

    • getEphemeralStorage

      @Stability(Stable) @Nullable public Object getEphemeralStorage()
      Deprecated..

      Returns union: either Boolean or IResolvable

    • setEphemeralStorage

      @Stability(Stable) public void setEphemeralStorage(@Nullable Boolean value)
      Deprecated..

    • setEphemeralStorage

      @Stability(Stable) public void setEphemeralStorage(@Nullable IResolvable value)
      Deprecated..

    • getInstanceMatchCriteria

      @Stability(Stable) @Nullable public String getInstanceMatchCriteria()
      Indicates the type of instance launches that the Capacity Reservation accepts.

      The options include:.

    • setInstanceMatchCriteria

      @Stability(Stable) public void setInstanceMatchCriteria(@Nullable String value)
      Indicates the type of instance launches that the Capacity Reservation accepts.

      The options include:.

    • getOutPostArn

      @Stability(Stable) @Nullable public String getOutPostArn()

      Not supported for future-dated Capacity Reservations.

    • setOutPostArn

      @Stability(Stable) public void setOutPostArn(@Nullable String value)

      Not supported for future-dated Capacity Reservations.

    • getPlacementGroupArn

      @Stability(Stable) @Nullable public String getPlacementGroupArn()

      Not supported for future-dated Capacity Reservations.

    • setPlacementGroupArn

      @Stability(Stable) public void setPlacementGroupArn(@Nullable String value)

      Not supported for future-dated Capacity Reservations.

    • getTagSpecifications

      @Stability(Stable) @Nullable public List<CfnCapacityReservation.TagSpecificationProperty> getTagSpecifications()
      The tags to apply to the Capacity Reservation during launch.

    • setTagSpecifications

      @Stability(Stable) public void setTagSpecifications(@Nullable List<CfnCapacityReservation.TagSpecificationProperty> value)
      The tags to apply to the Capacity Reservation during launch.

    • getTenancy

      @Stability(Stable) @Nullable public String getTenancy()
      Indicates the tenancy of the Capacity Reservation.

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

    • setTenancy

      @Stability(Stable) public void setTenancy(@Nullable String value)
      Indicates the tenancy of the Capacity Reservation.

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

    • getUnusedReservationBillingOwnerId

      @Stability(Stable) @Nullable public String getUnusedReservationBillingOwnerId()
      The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation.

    • setUnusedReservationBillingOwnerId

      @Stability(Stable) public void setUnusedReservationBillingOwnerId(@Nullable String value)
      The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation.