Package software.amazon.awscdk.services.gamelift

Class CfnGameSessionQueueProps.Builder

java.lang.Object
software.amazon.awscdk.services.gamelift.CfnGameSessionQueueProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnGameSessionQueueProps>
Enclosing interface:
CfnGameSessionQueueProps
@Stability(Stable) public static final class CfnGameSessionQueueProps.Builder extends Object implements software.amazon.jsii.Builder<CfnGameSessionQueueProps>
A builder for CfnGameSessionQueueProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnGameSessionQueueProps.Builder name(String name)
      Sets the value of CfnGameSessionQueueProps.getName()
      Parameters:
      name - A descriptive label that is associated with game session queue. This parameter is required. Queue names must be unique within each Region.
      Returns:
      this

    • customEventData

      @Stability(Stable) public CfnGameSessionQueueProps.Builder customEventData(String customEventData)
      Sets the value of CfnGameSessionQueueProps.getCustomEventData()
      Parameters:
      customEventData - Information to be added to all events that are related to this game session queue.
      Returns:
      this

    • destinations

      @Stability(Stable) public CfnGameSessionQueueProps.Builder destinations(IResolvable destinations)
      Sets the value of CfnGameSessionQueueProps.getDestinations()
      Parameters:
      destinations - 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.
      Returns:
      this

    • destinations

      @Stability(Stable) public CfnGameSessionQueueProps.Builder destinations(List<? extends Object> destinations)
      Sets the value of CfnGameSessionQueueProps.getDestinations()
      Parameters:
      destinations - 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.
      Returns:
      this

    • filterConfiguration

      @Stability(Stable) public CfnGameSessionQueueProps.Builder filterConfiguration(IResolvable filterConfiguration)
      Sets the value of CfnGameSessionQueueProps.getFilterConfiguration()
      Parameters:
      filterConfiguration - 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.
      Returns:
      this

    • filterConfiguration

      @Stability(Stable) public CfnGameSessionQueueProps.Builder filterConfiguration(CfnGameSessionQueue.FilterConfigurationProperty filterConfiguration)
      Sets the value of CfnGameSessionQueueProps.getFilterConfiguration()
      Parameters:
      filterConfiguration - 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.
      Returns:
      this

    • notificationTarget

      @Stability(Stable) public CfnGameSessionQueueProps.Builder notificationTarget(String notificationTarget)
      Sets the value of CfnGameSessionQueueProps.getNotificationTarget()
      Parameters:
      notificationTarget - An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement .
      Returns:
      this

    • playerLatencyPolicies

      @Stability(Stable) public CfnGameSessionQueueProps.Builder playerLatencyPolicies(IResolvable playerLatencyPolicies)
      Sets the value of CfnGameSessionQueueProps.getPlayerLatencyPolicies()
      Parameters:
      playerLatencyPolicies - 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.
      Returns:
      this

    • playerLatencyPolicies

      @Stability(Stable) public CfnGameSessionQueueProps.Builder playerLatencyPolicies(List<? extends Object> playerLatencyPolicies)
      Sets the value of CfnGameSessionQueueProps.getPlayerLatencyPolicies()
      Parameters:
      playerLatencyPolicies - 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.
      Returns:
      this

    • priorityConfiguration

      @Stability(Stable) public CfnGameSessionQueueProps.Builder priorityConfiguration(IResolvable priorityConfiguration)
      Sets the value of CfnGameSessionQueueProps.getPriorityConfiguration()
      Parameters:
      priorityConfiguration - 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.
      Returns:
      this

    • priorityConfiguration

      @Stability(Stable) public CfnGameSessionQueueProps.Builder priorityConfiguration(CfnGameSessionQueue.PriorityConfigurationProperty priorityConfiguration)
      Sets the value of CfnGameSessionQueueProps.getPriorityConfiguration()
      Parameters:
      priorityConfiguration - 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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnGameSessionQueueProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnGameSessionQueueProps.getTags()
      Parameters:
      tags - 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.
      Returns:
      this

    • timeoutInSeconds

      @Stability(Stable) public CfnGameSessionQueueProps.Builder timeoutInSeconds(Number timeoutInSeconds)
      Sets the value of CfnGameSessionQueueProps.getTimeoutInSeconds()
      Parameters:
      timeoutInSeconds - 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 .
      Returns:
      this

    • build

      @Stability(Stable) public CfnGameSessionQueueProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnGameSessionQueueProps>
      Returns:
      a new instance of CfnGameSessionQueueProps
      Throws:
      NullPointerException - if any required attribute was not provided