AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::GameLift::Types::CreateGameSessionQueueInput

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

Overview

Note:

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

{
  name: "GameSessionQueueName", # required
  timeout_in_seconds: 1,
  player_latency_policies: [
    {
      maximum_individual_player_latency_milliseconds: 1,
      policy_duration_seconds: 1,
    },
  ],
  destinations: [
    {
      destination_arn: "ArnStringModel",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Represents the input for a request operation.

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

#nameString

A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

Returns:

  • (String)

    A descriptive label that is associated with game session queue.

#player_latency_policiesArray<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. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.

Returns:

  • (Array<Types::PlayerLatencyPolicy>)

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

#tagsArray<Types::Tag>

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:

  • (Array<Types::Tag>)

    A list of labels to assign to the new game session queue resource.

#timeout_in_secondsInteger

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.