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.104.0 (build e79254c)",
           date="2025-01-15T21:09:17.681Z")
@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")
         .unusedReservationBillingOwnerId("unusedReservationBillingOwnerId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCapacityReservationProps.Builder	A builder for CfnCapacityReservationProps
static final class	CfnCapacityReservationProps.Jsii$Proxy	An implementation for CfnCapacityReservationProps

Method Summary

Modifier and Type	Method	Description
static CfnCapacityReservationProps.Builder	builder()
String	getAvailabilityZone()	The Availability Zone in which to create the Capacity Reservation.
default Object	getEbsOptimized()	Indicates whether the Capacity Reservation supports EBS-optimized instances.
default String	getEndDate()	The date and time at which the Capacity Reservation expires.
default String	getEndDateType()	Indicates the way in which the Capacity Reservation ends.
default Object	getEphemeralStorage()	Deprecated..
Number	getInstanceCount()	The number of instances for which to reserve capacity.
default String	getInstanceMatchCriteria()	Indicates the type of instance launches that the Capacity Reservation accepts.
String	getInstancePlatform()	The type of operating system for which to reserve capacity.
String	getInstanceType()	The instance type for which to reserve capacity.
default String	getOutPostArn()
default String	getPlacementGroupArn()
default Object	getTagSpecifications()	The tags to apply to the Capacity Reservation during launch.
default String	getTenancy()	Indicates the tenancy of the Capacity Reservation.
default String	getUnusedReservationBillingOwnerId()	The ID of the AWS account to which to assign billing of the unused capacity of the Capacity Reservation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZone

@Stability(Stable)
@NotNull
String getAvailabilityZone()

The Availability Zone in which to create the Capacity Reservation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-availabilityzone

getInstanceCount

@Stability(Stable)
@NotNull
Number getInstanceCount()

The number of instances for which to reserve capacity.

You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances ( 25 * m5.xlarge = 100 vCPUs ).

Valid range: 1 - 1000

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancecount

getInstancePlatform

@Stability(Stable)
@NotNull
String getInstancePlatform()

The type of operating system for which to reserve capacity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instanceplatform

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

The instance type for which to reserve capacity.

You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancetype

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ebsoptimized

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.

If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddate

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-enddatetype

getEphemeralStorage

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

Deprecated..

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-ephemeralstorage

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.

If you are requesting a future-dated Capacity Reservation, you must specify targeted .

Default: open

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-instancematchcriteria

getOutPostArn

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

Not supported for future-dated Capacity Reservations.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-outpostarn

getPlacementGroupArn

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

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 in the Amazon EC2 User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-placementgrouparn

getTagSpecifications

@Stability(Stable)
@Nullable
default Object getTagSpecifications()

The tags to apply to the Capacity Reservation during launch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tagspecifications

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-tenancy

getUnusedReservationBillingOwnerId

@Stability(Stable)
@Nullable
default String getUnusedReservationBillingOwnerId()

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 .

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-capacityreservation.html#cfn-ec2-capacityreservation-unusedreservationbillingownerid

builder

@Stability(Stable)
static CfnCapacityReservationProps.Builder builder()

Returns:

a CfnCapacityReservationProps.Builder of CfnCapacityReservationProps