Package software.amazon.awscdk.services.gamelift

Interface CfnGameSessionQueueProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnGameSessionQueueProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.900Z") @Stability(Stable) public interface CfnGameSessionQueueProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnGameSessionQueue.

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.gamelift.*;
 CfnGameSessionQueueProps cfnGameSessionQueueProps = CfnGameSessionQueueProps.builder()
         .name("name")
         // the properties below are optional
         .customEventData("customEventData")
         .destinations(List.of(DestinationProperty.builder()
                 .destinationArn("destinationArn")
                 .build()))
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .allowedLocations(List.of("allowedLocations"))
                 .build())
         .notificationTarget("notificationTarget")
         .playerLatencyPolicies(List.of(PlayerLatencyPolicyProperty.builder()
                 .maximumIndividualPlayerLatencyMilliseconds(123)
                 .policyDurationSeconds(123)
                 .build()))
         .priorityConfiguration(PriorityConfigurationProperty.builder()
                 .locationOrder(List.of("locationOrder"))
                 .priorityOrder(List.of("priorityOrder"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutInSeconds(123)
         .build();

  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      A descriptive label that is associated with game session queue.

      Queue names must be unique within each Region.

    • getCustomEventData

      @Stability(Stable) @Nullable default String getCustomEventData()
      Information to be added to all events that are related to this game session queue.

    • getDestinations

      @Stability(Stable) @Nullable default Object getDestinations()
      A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

      Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.

    • getFilterConfiguration

      @Stability(Stable) @Nullable default Object getFilterConfiguration()
      A list of locations where a queue is allowed to place new game sessions.

      Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.

    • getNotificationTarget

      @Stability(Stable) @Nullable default String getNotificationTarget()
      An SNS topic ARN that is set up to receive game session placement notifications.

      See Setting up notifications for game session placement .

    • getPlayerLatencyPolicies

      @Stability(Stable) @Nullable default Object getPlayerLatencyPolicies()
      A set of policies that act as a sliding cap on player latency.

      FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

    • getPriorityConfiguration

      @Stability(Stable) @Nullable default Object getPriorityConfiguration()
      Custom settings to use when prioritizing destinations and locations for game session placements.

      This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      A list of labels to assign to the new game session queue resource.

      Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

    • getTimeoutInSeconds

      @Stability(Stable) @Nullable default Number getTimeoutInSeconds()
      The maximum time, in seconds, that a new game session placement request remains in the queue.

      When a request exceeds this time, the game session placement changes to a TIMED_OUT status. By default, this property is set to 600 .

    • builder

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