Package software.amazon.awscdk.services.ec2

Class CfnCapacityReservationFleet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ec2.CfnCapacityReservationFleet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:38.402Z") @Stability(Stable) public class CfnCapacityReservationFleet extends CfnResource implements IInspectable
A CloudFormation AWS::EC2::CapacityReservationFleet.

Creates a new Capacity Reservation Fleet with the specified attributes. For more information, see Capacity Reservation Fleets 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.*;
 CfnCapacityReservationFleet cfnCapacityReservationFleet = CfnCapacityReservationFleet.Builder.create(this, "MyCfnCapacityReservationFleet")
         .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();

  • 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

    • CfnCapacityReservationFleet

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

    • CfnCapacityReservationFleet

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

    • CfnCapacityReservationFleet

      @Stability(Stable) public CfnCapacityReservationFleet(@NotNull Construct scope, @NotNull String id, @Nullable CfnCapacityReservationFleetProps props)
      Create a new AWS::EC2::CapacityReservationFleet.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnCapacityReservationFleet

      @Stability(Stable) public CfnCapacityReservationFleet(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::EC2::CapacityReservationFleet.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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.

    • getAttrCapacityReservationFleetId

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

    • getCfnProperties

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

    • getAllocationStrategy

      @Stability(Stable) @Nullable public 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

    • setAllocationStrategy

      @Stability(Stable) public void setAllocationStrategy(@Nullable String value)
      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

    • getEndDate

      @Stability(Stable) @Nullable public 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 .

    • setEndDate

      @Stability(Stable) public void setEndDate(@Nullable String value)
      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 .

    • getInstanceMatchCriteria

      @Stability(Stable) @Nullable public 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.

    • setInstanceMatchCriteria

      @Stability(Stable) public void setInstanceMatchCriteria(@Nullable String value)
      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.

    • getInstanceTypeSpecifications

      @Stability(Stable) @Nullable public Object getInstanceTypeSpecifications()
      Information about the instance types for which to reserve the capacity.

    • setInstanceTypeSpecifications

      @Stability(Stable) public void setInstanceTypeSpecifications(@Nullable IResolvable value)
      Information about the instance types for which to reserve the capacity.

    • setInstanceTypeSpecifications

      @Stability(Stable) public void setInstanceTypeSpecifications(@Nullable List<Object> value)
      Information about the instance types for which to reserve the capacity.

    • getNoRemoveEndDate

      @Stability(Stable) @Nullable public 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.

    • setNoRemoveEndDate

      @Stability(Stable) public void setNoRemoveEndDate(@Nullable Boolean value)
      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.

    • setNoRemoveEndDate

      @Stability(Stable) public void setNoRemoveEndDate(@Nullable IResolvable value)
      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.

    • getRemoveEndDate

      @Stability(Stable) @Nullable public 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.

    • setRemoveEndDate

      @Stability(Stable) public void setRemoveEndDate(@Nullable Boolean value)
      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.

    • setRemoveEndDate

      @Stability(Stable) public void setRemoveEndDate(@Nullable IResolvable value)
      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.

    • getTagSpecifications

      @Stability(Stable) @Nullable public Object getTagSpecifications()
      The tags to assign to the Capacity Reservation Fleet.

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

    • setTagSpecifications

      @Stability(Stable) public void setTagSpecifications(@Nullable IResolvable value)
      The tags to assign to the Capacity Reservation Fleet.

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

    • setTagSpecifications

      @Stability(Stable) public void setTagSpecifications(@Nullable List<Object> value)
      The tags to assign to the Capacity Reservation Fleet.

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

    • getTenancy

      @Stability(Stable) @Nullable public 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 .

    • setTenancy

      @Stability(Stable) public void setTenancy(@Nullable String value)
      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 .

    • getTotalTargetCapacity

      @Stability(Stable) @Nullable public 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.

    • setTotalTargetCapacity

      @Stability(Stable) public void setTotalTargetCapacity(@Nullable Number value)
      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.