Package software.amazon.awscdk.services.ec2

Interface CfnCapacityReservationFleetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapacityReservationFleetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:28.396Z")
@Stability(Stable)
public interface CfnCapacityReservationFleetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCapacityReservationFleet.

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.*;
 CfnCapacityReservationFleetProps cfnCapacityReservationFleetProps = CfnCapacityReservationFleetProps.builder()
         .allocationStrategy("allocationStrategy")
         .endDate("endDate")
         .instanceMatchCriteria("instanceMatchCriteria")
         .instanceTypeSpecifications(List.of(InstanceTypeSpecificationProperty.builder()
                 .availabilityZone("availabilityZone")
                 .availabilityZoneId("availabilityZoneId")
                 .ebsOptimized(false)
                 .instancePlatform("instancePlatform")
                 .instanceType("instanceType")
                 .priority(123)
                 .weight(123)
                 .build()))
         .noRemoveEndDate(false)
         .removeEndDate(false)
         .tagSpecifications(List.of(TagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .tenancy("tenancy")
         .totalTargetCapacity(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCapacityReservationFleetProps.Builder	builder()
default String	getAllocationStrategy()	The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.
default String	getEndDate()	The date and time at which the Capacity Reservation Fleet expires.
default String	getInstanceMatchCriteria()	Indicates the type of instance launches that the Capacity Reservation Fleet accepts.
default Object	getInstanceTypeSpecifications()	Information about the instance types for which to reserve the capacity.
default Object	getNoRemoveEndDate()	Used to add an end date to a Capacity Reservation Fleet that has no end date and time.
default Object	getRemoveEndDate()	Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.
default Object	getTagSpecifications()	The tags to assign to the Capacity Reservation Fleet.
default String	getTenancy()	Indicates the tenancy of the Capacity Reservation Fleet.
default Number	getTotalTargetCapacity()	The total number of capacity units to be reserved by the Capacity Reservation Fleet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllocationStrategy

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

The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use.

Currently, only the prioritized allocation strategy is supported. For more information, see Allocation strategy in the Amazon EC2 User Guide.

Valid values: prioritized

See Also:

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

getEndDate

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

The date and time at which the Capacity Reservation Fleet expires.

When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.

The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019 , 13:30:55 , the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019 .

See Also:

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

getInstanceMatchCriteria

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

Indicates the type of instance launches that the Capacity Reservation Fleet accepts.

All Capacity Reservations in the Fleet inherit this instance matching criteria.

Currently, Capacity Reservation Fleets support open instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.

See Also:

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

getInstanceTypeSpecifications

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

Information about the instance types for which to reserve the capacity.

See Also:

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

getNoRemoveEndDate

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

Used to add an end date to a Capacity Reservation Fleet that has no end date and time.

To add an end date to a Capacity Reservation Fleet, specify true for this paramater and specify the end date and time (in UTC time format) for the EndDate parameter.

See Also:

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

getRemoveEndDate

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

Used to remove an end date from a Capacity Reservation Fleet that is configured to end automatically at a specific date and time.

To remove the end date from a Capacity Reservation Fleet, specify true for this paramater and omit the EndDate parameter.

See Also:

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

getTagSpecifications

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

The tags to assign to the Capacity Reservation Fleet.

The tags are automatically assigned to the Capacity Reservations in the Fleet.

See Also:

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

getTenancy

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

Indicates the tenancy of the Capacity Reservation Fleet.

All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:

• default - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts .
• dedicated - The Capacity Reservations are 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-capacityreservationfleet.html#cfn-ec2-capacityreservationfleet-tenancy

getTotalTargetCapacity

@Stability(Stable)
@Nullable
default Number getTotalTargetCapacity()

The total number of capacity units to be reserved by the Capacity Reservation Fleet.

This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.

See Also:

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

builder

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

Returns:

a CfnCapacityReservationFleetProps.Builder of CfnCapacityReservationFleetProps