Package software.amazon.awscdk.services.gamelift.alpha

Enum PriorityType

java.lang.Object
java.lang.Enum<PriorityType>
software.amazon.awscdk.services.gamelift.alpha.PriorityType
All Implemented Interfaces:
Serializable, Comparable<PriorityType>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:15.718Z") @Stability(Experimental) public enum PriorityType extends Enum<PriorityType>
(experimental) Priority to condider when placing new game sessions.

Example: 

 BuildFleet fleet;
 Topic topic;
 GameSessionQueue.Builder.create(this, "MyGameSessionQueue")
         .gameSessionQueueName("test-gameSessionQueue")
         .customEventData("test-event-data")
         .allowedLocations(List.of("eu-west-1", "eu-west-2"))
         .destinations(List.of(fleet))
         .notificationTarget(topic)
         .playerLatencyPolicies(List.of(PlayerLatencyPolicy.builder()
                 .maximumIndividualPlayerLatency(Duration.millis(100))
                 .policyDuration(Duration.seconds(300))
                 .build()))
         .priorityConfiguration(PriorityConfiguration.builder()
                 .locationOrder(List.of("eu-west-1", "eu-west-2"))
                 .priorityOrder(List.of(PriorityType.LATENCY, PriorityType.COST, PriorityType.DESTINATION, PriorityType.LOCATION))
                 .build())
         .timeout(Duration.seconds(300))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    COST
    (experimental) FleetIQ prioritizes destinations with the lowest current hosting costs.
    DESTINATION
    (experimental) FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    LATENCY
    (experimental) FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    LOCATION
    (experimental) FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

  • Method Summary

    Modifier and Type
    Method
    Description
    static PriorityType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static PriorityType[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • LATENCY

      @Stability(Experimental) public static final PriorityType LATENCY
      (experimental) FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.

    • COST

      @Stability(Experimental) public static final PriorityType COST
      (experimental) FleetIQ prioritizes destinations with the lowest current hosting costs.

      Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.

    • DESTINATION

      @Stability(Experimental) public static final PriorityType DESTINATION
      (experimental) FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.

    • LOCATION

      @Stability(Experimental) public static final PriorityType LOCATION
      (experimental) FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder.

  • Method Details

    • values

      public static PriorityType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static PriorityType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null