You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::UpdateGameSessionQueueInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateGameSessionQueueInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "GameSessionQueueNameOrArn", # required
  timeout_in_seconds: 1,
  player_latency_policies: [
    {
      maximum_individual_player_latency_milliseconds: 1,
      policy_duration_seconds: 1,
    },
  ],
  destinations: [
    {
      destination_arn: "ArnStringModel",
    },
  ],
}

Represents the input for a request operation.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#destinations ⇒ Array<Types::GameSessionQueueDestination>

A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.

Returns:

#name ⇒ String

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Returns:

  • (String) —

    A descriptive label that is associated with game session queue.

#player_latency_policies ⇒ Array<Types::PlayerLatencyPolicy>

A collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, the policy is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.

Returns:

  • (Array<Types::PlayerLatencyPolicy>) —

    A collection of latency policies to apply when processing game sessions placement requests with player latency information.

#timeout_in_seconds ⇒ Integer

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.

Returns:

  • (Integer) —

    The maximum time, in seconds, that a new game session placement request remains in the queue.