Interface CfnCapacityReservationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCapacityReservationProps.Jsii$Proxy
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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCapacityReservationProps
static final class
An implementation forCfnCapacityReservationProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The Availability Zone in which to create the Capacity Reservation.default Object
Indicates whether the Capacity Reservation supports EBS-optimized instances.default String
The date and time at which the Capacity Reservation expires.default String
Indicates the way in which the Capacity Reservation ends.default Object
Deprecated..The number of instances for which to reserve capacity.default String
Indicates the type of instance launches that the Capacity Reservation accepts.The type of operating system for which to reserve capacity.The instance type for which to reserve capacity.default String
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.default String
The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation.default Object
The tags to apply to the Capacity Reservation during launch.default String
Indicates the tenancy of the Capacity Reservation.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAvailabilityZone
The Availability Zone in which to create the Capacity Reservation.- See Also:
-
getInstanceCount
The number of instances for which to reserve capacity.Valid range: 1 - 1000
- See Also:
-
getInstancePlatform
The type of operating system for which to reserve capacity.- See Also:
-
getInstanceType
The instance type for which to reserve capacity.For more information, see Instance types in the Amazon EC2 User Guide .
- See Also:
-
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:
-
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 ifEndDateType
islimited
. OmitEndDate
ifEndDateType
isunlimited
.If the
EndDateType
islimited
, 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.- See Also:
-
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 anEndDate
if theEndDateType
isunlimited
.limited
- The Capacity Reservation expires automatically at a specified date and time. You must provide anEndDate
value if theEndDateType
value islimited
.
- See Also:
-
getEphemeralStorage
Deprecated..- See Also:
-
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
- See Also:
-
getOutPostArn
The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.- See Also:
-
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 .
- See Also:
-
getTagSpecifications
The tags to apply to the Capacity Reservation during launch.- See Also:
-
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:
-
builder
-