Package software.amazon.awscdk.services.ec2

Interface CfnCapacityReservationProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCapacityReservationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.427Z") @Stability(Stable) public interface CfnCapacityReservationProps extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.ec2.*;
 CfnCapacityReservationProps cfnCapacityReservationProps = CfnCapacityReservationProps.builder()
         .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(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .tenancy("tenancy")
         .build();

  • Method Details

    • getAvailabilityZone

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

    • getInstanceCount

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

      Valid range: 1 - 1000

    • getInstancePlatform

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

    • getInstanceType

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

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

    • getEbsOptimized

      @Stability(Stable) @Nullable default Object getEbsOptimized()
      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.

    • getEndDate

      @Stability(Stable) @Nullable default String getEndDate()
      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.

    • getEndDateType

      @Stability(Stable) @Nullable default String getEndDateType()
      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 .

    • getEphemeralStorage

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

    • getInstanceMatchCriteria

      @Stability(Stable) @Nullable default String getInstanceMatchCriteria()
      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

    • getOutPostArn

      @Stability(Stable) @Nullable default String getOutPostArn()
      The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

    • getPlacementGroupArn

      @Stability(Stable) @Nullable default String getPlacementGroupArn()
      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 .

    • getTagSpecifications

      @Stability(Stable) @Nullable default Object getTagSpecifications()
      The tags to apply to the Capacity Reservation during launch.

    • getTenancy

      @Stability(Stable) @Nullable default String getTenancy()
      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 .

    • builder

      @Stability(Stable) static CfnCapacityReservationProps.Builder builder()
      Returns:
      a CfnCapacityReservationProps.Builder of CfnCapacityReservationProps