Package software.amazon.awscdk.services.ec2

Interface CfnSpotFleet.SpotFleetRequestConfigDataProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnSpotFleet.SpotFleetRequestConfigDataProperty.Jsii$Proxy
Enclosing class:
CfnSpotFleet
@Stability(Stable) public static interface CfnSpotFleet.SpotFleetRequestConfigDataProperty extends software.amazon.jsii.JsiiSerializable
Specifies the configuration of a Spot Fleet request.

For more information, see Spot Fleet in the Amazon EC2 User Guide .

You must specify either LaunchSpecifications or LaunchTemplateConfigs .

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.*;
 SpotFleetRequestConfigDataProperty spotFleetRequestConfigDataProperty = SpotFleetRequestConfigDataProperty.builder()
         .iamFleetRole("iamFleetRole")
         .targetCapacity(123)
         // the properties below are optional
         .allocationStrategy("allocationStrategy")
         .context("context")
         .excessCapacityTerminationPolicy("excessCapacityTerminationPolicy")
         .instanceInterruptionBehavior("instanceInterruptionBehavior")
         .instancePoolsToUseCount(123)
         .launchSpecifications(List.of(SpotFleetLaunchSpecificationProperty.builder()
                 .imageId("imageId")
                 // the properties below are optional
                 .blockDeviceMappings(List.of(BlockDeviceMappingProperty.builder()
                         .deviceName("deviceName")
                         // the properties below are optional
                         .ebs(EbsBlockDeviceProperty.builder()
                                 .deleteOnTermination(false)
                                 .encrypted(false)
                                 .iops(123)
                                 .snapshotId("snapshotId")
                                 .volumeSize(123)
                                 .volumeType("volumeType")
                                 .build())
                         .noDevice("noDevice")
                         .virtualName("virtualName")
                         .build()))
                 .ebsOptimized(false)
                 .iamInstanceProfile(IamInstanceProfileSpecificationProperty.builder()
                         .arn("arn")
                         .build())
                 .instanceRequirements(InstanceRequirementsRequestProperty.builder()
                         .acceleratorCount(AcceleratorCountRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .acceleratorManufacturers(List.of("acceleratorManufacturers"))
                         .acceleratorNames(List.of("acceleratorNames"))
                         .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .acceleratorTypes(List.of("acceleratorTypes"))
                         .allowedInstanceTypes(List.of("allowedInstanceTypes"))
                         .bareMetal("bareMetal")
                         .baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .burstablePerformance("burstablePerformance")
                         .cpuManufacturers(List.of("cpuManufacturers"))
                         .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                         .instanceGenerations(List.of("instanceGenerations"))
                         .localStorage("localStorage")
                         .localStorageTypes(List.of("localStorageTypes"))
                         .memoryGiBPerVCpu(MemoryGiBPerVCpuRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .memoryMiB(MemoryMiBRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .networkBandwidthGbps(NetworkBandwidthGbpsRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .networkInterfaceCount(NetworkInterfaceCountRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .onDemandMaxPricePercentageOverLowestPrice(123)
                         .requireHibernateSupport(false)
                         .spotMaxPricePercentageOverLowestPrice(123)
                         .totalLocalStorageGb(TotalLocalStorageGBRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .vCpuCount(VCpuCountRangeRequestProperty.builder()
                                 .max(123)
                                 .min(123)
                                 .build())
                         .build())
                 .instanceType("instanceType")
                 .kernelId("kernelId")
                 .keyName("keyName")
                 .monitoring(SpotFleetMonitoringProperty.builder()
                         .enabled(false)
                         .build())
                 .networkInterfaces(List.of(InstanceNetworkInterfaceSpecificationProperty.builder()
                         .associatePublicIpAddress(false)
                         .deleteOnTermination(false)
                         .description("description")
                         .deviceIndex(123)
                         .groups(List.of("groups"))
                         .ipv6AddressCount(123)
                         .ipv6Addresses(List.of(InstanceIpv6AddressProperty.builder()
                                 .ipv6Address("ipv6Address")
                                 .build()))
                         .networkInterfaceId("networkInterfaceId")
                         .privateIpAddresses(List.of(PrivateIpAddressSpecificationProperty.builder()
                                 .privateIpAddress("privateIpAddress")
                                 // the properties below are optional
                                 .primary(false)
                                 .build()))
                         .secondaryPrivateIpAddressCount(123)
                         .subnetId("subnetId")
                         .build()))
                 .placement(SpotPlacementProperty.builder()
                         .availabilityZone("availabilityZone")
                         .groupName("groupName")
                         .tenancy("tenancy")
                         .build())
                 .ramdiskId("ramdiskId")
                 .securityGroups(List.of(GroupIdentifierProperty.builder()
                         .groupId("groupId")
                         .build()))
                 .spotPrice("spotPrice")
                 .subnetId("subnetId")
                 .tagSpecifications(List.of(SpotFleetTagSpecificationProperty.builder()
                         .resourceType("resourceType")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build()))
                 .userData("userData")
                 .weightedCapacity(123)
                 .build()))
         .launchTemplateConfigs(List.of(LaunchTemplateConfigProperty.builder()
                 .launchTemplateSpecification(FleetLaunchTemplateSpecificationProperty.builder()
                         .version("version")
                         // the properties below are optional
                         .launchTemplateId("launchTemplateId")
                         .launchTemplateName("launchTemplateName")
                         .build())
                 .overrides(List.of(LaunchTemplateOverridesProperty.builder()
                         .availabilityZone("availabilityZone")
                         .instanceRequirements(InstanceRequirementsRequestProperty.builder()
                                 .acceleratorCount(AcceleratorCountRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .acceleratorManufacturers(List.of("acceleratorManufacturers"))
                                 .acceleratorNames(List.of("acceleratorNames"))
                                 .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .acceleratorTypes(List.of("acceleratorTypes"))
                                 .allowedInstanceTypes(List.of("allowedInstanceTypes"))
                                 .bareMetal("bareMetal")
                                 .baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .burstablePerformance("burstablePerformance")
                                 .cpuManufacturers(List.of("cpuManufacturers"))
                                 .excludedInstanceTypes(List.of("excludedInstanceTypes"))
                                 .instanceGenerations(List.of("instanceGenerations"))
                                 .localStorage("localStorage")
                                 .localStorageTypes(List.of("localStorageTypes"))
                                 .memoryGiBPerVCpu(MemoryGiBPerVCpuRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .memoryMiB(MemoryMiBRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .networkBandwidthGbps(NetworkBandwidthGbpsRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .networkInterfaceCount(NetworkInterfaceCountRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .onDemandMaxPricePercentageOverLowestPrice(123)
                                 .requireHibernateSupport(false)
                                 .spotMaxPricePercentageOverLowestPrice(123)
                                 .totalLocalStorageGb(TotalLocalStorageGBRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .vCpuCount(VCpuCountRangeRequestProperty.builder()
                                         .max(123)
                                         .min(123)
                                         .build())
                                 .build())
                         .instanceType("instanceType")
                         .priority(123)
                         .spotPrice("spotPrice")
                         .subnetId("subnetId")
                         .weightedCapacity(123)
                         .build()))
                 .build()))
         .loadBalancersConfig(LoadBalancersConfigProperty.builder()
                 .classicLoadBalancersConfig(ClassicLoadBalancersConfigProperty.builder()
                         .classicLoadBalancers(List.of(ClassicLoadBalancerProperty.builder()
                                 .name("name")
                                 .build()))
                         .build())
                 .targetGroupsConfig(TargetGroupsConfigProperty.builder()
                         .targetGroups(List.of(TargetGroupProperty.builder()
                                 .arn("arn")
                                 .build()))
                         .build())
                 .build())
         .onDemandAllocationStrategy("onDemandAllocationStrategy")
         .onDemandMaxTotalPrice("onDemandMaxTotalPrice")
         .onDemandTargetCapacity(123)
         .replaceUnhealthyInstances(false)
         .spotMaintenanceStrategies(SpotMaintenanceStrategiesProperty.builder()
                 .capacityRebalance(SpotCapacityRebalanceProperty.builder()
                         .replacementStrategy("replacementStrategy")
                         .terminationDelay(123)
                         .build())
                 .build())
         .spotMaxTotalPrice("spotMaxTotalPrice")
         .spotPrice("spotPrice")
         .tagSpecifications(List.of(SpotFleetTagSpecificationProperty.builder()
                 .resourceType("resourceType")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         .targetCapacityUnitType("targetCapacityUnitType")
         .terminateInstancesWithExpiration(false)
         .type("type")
         .validFrom("validFrom")
         .validUntil("validUntil")
         .build();

  • Method Details

    • getIamFleetRole

      @Stability(Stable) @NotNull String getIamFleetRole()
      The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf.

      For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances . Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration .

    • getTargetCapacity

      @Stability(Stable) @NotNull Number getTargetCapacity()
      The number of units to request for the Spot Fleet.

      You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.

    • getAllocationStrategy

      @Stability(Stable) @Nullable default String getAllocationStrategy()
      The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration.

      For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide .

      • priceCapacityOptimized (recommended) - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
      • capacityOptimized - Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized . Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides . You can assign the same priority to different LaunchTemplateOverrides . EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized , the same priority is applied when fulfilling On-Demand capacity.
      • diversified - Spot Fleet requests instances from all of the Spot Instance pools that you specify.
      • lowestPrice - Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.

      Default: lowestPrice

    • getContext

      @Stability(Stable) @Nullable default String getContext()
      Reserved.

    • getExcessCapacityTerminationPolicy

      @Stability(Stable) @Nullable default String getExcessCapacityTerminationPolicy()
      Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.

      Supported only for fleets of type maintain .

    • getInstanceInterruptionBehavior

      @Stability(Stable) @Nullable default String getInstanceInterruptionBehavior()
      The behavior when a Spot Instance is interrupted.

      The default is terminate .

    • getInstancePoolsToUseCount

      @Stability(Stable) @Nullable default Number getInstancePoolsToUseCount()
      The number of Spot pools across which to allocate your target Spot capacity.

      Valid only when Spot AllocationStrategy is set to lowest-price . Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

      Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

    • getLaunchSpecifications

      @Stability(Stable) @Nullable default Object getLaunchSpecifications()
      The launch specifications for the Spot Fleet request.

      If you specify LaunchSpecifications , you can't specify LaunchTemplateConfigs .

    • getLaunchTemplateConfigs

      @Stability(Stable) @Nullable default Object getLaunchTemplateConfigs()
      The launch template and overrides.

      If you specify LaunchTemplateConfigs , you can't specify LaunchSpecifications .

    • getLoadBalancersConfig

      @Stability(Stable) @Nullable default Object getLoadBalancersConfig()
      One or more Classic Load Balancers and target groups to attach to the Spot Fleet request.

      Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

      With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

    • getOnDemandAllocationStrategy

      @Stability(Stable) @Nullable default String getOnDemandAllocationStrategy()
      The order of the launch template overrides to use in fulfilling On-Demand capacity.

      If you specify lowestPrice , Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized , Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice .

    • getOnDemandMaxTotalPrice

      @Stability(Stable) @Nullable default String getOnDemandMaxTotalPrice()
      The maximum amount per hour for On-Demand Instances that you're willing to pay.

      You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

    • getOnDemandTargetCapacity

      @Stability(Stable) @Nullable default Number getOnDemandTargetCapacity()
      The number of On-Demand units to request.

      You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.

    • getReplaceUnhealthyInstances

      @Stability(Stable) @Nullable default Object getReplaceUnhealthyInstances()
      Indicates whether Spot Fleet should replace unhealthy instances.

    • getSpotMaintenanceStrategies

      @Stability(Stable) @Nullable default Object getSpotMaintenanceStrategies()
      The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

    • getSpotMaxTotalPrice

      @Stability(Stable) @Nullable default String getSpotMaxTotalPrice()
      The maximum amount per hour for Spot Instances that you're willing to pay.

      You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

    • getSpotPrice

      @Stability(Stable) @Nullable default String getSpotPrice()
      The maximum price per unit hour that you are willing to pay for a Spot Instance.

      We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.

      If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

    • getTagSpecifications

      @Stability(Stable) @Nullable default Object getTagSpecifications()
      The key-value pair for tagging the Spot Fleet request on creation.

      The value for ResourceType must be spot-fleet-request , otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs ) or in the [SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) (valid only if you use LaunchSpecifications ). For information about tagging after launch, see Tagging Your Resources .

    • getTargetCapacityUnitType

      @Stability(Stable) @Nullable default String getTargetCapacityUnitType()
      The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.

      Default: units (translates to number of instances)

    • getTerminateInstancesWithExpiration

      @Stability(Stable) @Nullable default Object getTerminateInstancesWithExpiration()
      Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.

    • getType

      @Stability(Stable) @Nullable default String getType()
      The type of request.

      Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request , the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain , the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain . instant is listed but is not used by Spot Fleet.

    • getValidFrom

      @Stability(Stable) @Nullable default String getValidFrom()
      The start date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z).

      By default, Amazon EC2 starts fulfilling the request immediately.

    • getValidUntil

      @Stability(Stable) @Nullable default String getValidUntil()
      The end date and time of the request, in UTC format ( YYYY - MM - DD T HH : MM : SS Z).

      After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.

    • builder

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