Package software.amazon.awscdk.services.gamelift

Class CfnGameSessionQueue

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.gamelift.CfnGameSessionQueue
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:29:56.894Z") @Stability(Stable) public class CfnGameSessionQueue extends CfnResource implements IInspectable
A CloudFormation AWS::GameLift::GameSessionQueue.

The AWS::GameLift::GameSessionQueue resource creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or aliases), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region .

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.*;
 CfnGameSessionQueue cfnGameSessionQueue = CfnGameSessionQueue.Builder.create(this, "MyCfnGameSessionQueue")
         .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();

  • 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

    • CfnGameSessionQueue

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

    • CfnGameSessionQueue

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

    • CfnGameSessionQueue

      @Stability(Stable) public CfnGameSessionQueue(@NotNull Construct scope, @NotNull String id, @NotNull CfnGameSessionQueueProps props)
      Create a new AWS::GameLift::GameSessionQueue.

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

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The unique Amazon Resource Name (ARN) for the GameSessionQueue .

    • getAttrName

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

      Names are unique within each Region.

    • getCfnProperties

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

    • getTags

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

    • getName

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

      Queue names must be unique within each Region.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A descriptive label that is associated with game session queue.

      Queue names must be unique within each Region.

    • getCustomEventData

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

    • setCustomEventData

      @Stability(Stable) public void setCustomEventData(@Nullable String value)
      Information to be added to all events that are related to this game session queue.

    • getDestinations

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

    • setDestinations

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

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable List<Object> value)
      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 public 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.

    • setFilterConfiguration

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

    • setFilterConfiguration

      @Stability(Stable) public void setFilterConfiguration(@Nullable CfnGameSessionQueue.FilterConfigurationProperty value)
      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 public String getNotificationTarget()
      An SNS topic ARN that is set up to receive game session placement notifications.

      See Setting up notifications for game session placement .

    • setNotificationTarget

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

    • setPlayerLatencyPolicies

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

    • setPlayerLatencyPolicies

      @Stability(Stable) public void setPlayerLatencyPolicies(@Nullable List<Object> value)
      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 public 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.

    • setPriorityConfiguration

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

    • setPriorityConfiguration

      @Stability(Stable) public void setPriorityConfiguration(@Nullable CfnGameSessionQueue.PriorityConfigurationProperty value)
      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.

    • getTimeoutInSeconds

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

    • setTimeoutInSeconds

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