Struct aws_sdk_gamelift::client::fluent_builders::CreateGameSessionQueue

pub struct CreateGameSessionQueue<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to CreateGameSessionQueue.

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 there, then prompts the game server process to start a new game session.

A game session queue is configured with a set of destinations (GameLift fleets or aliases), which determine the locations where the queue can place new game sessions. These destinations can span multiple fleet types (Spot and On-Demand), instance types, and AWS Regions. If the queue includes multi-location fleets, the queue is able to place game sessions in all of a fleet's remote locations. You can opt to filter out individual locations if needed.

The queue configuration also determines how FleetIQ selects the best available placement for a new game session. Before searching for an available game server, FleetIQ first prioritizes the queue's destinations and locations, with the best placement locations on top. You can set up the queue to use the FleetIQ default prioritization or provide an alternate set of priorities.

To create a new queue, provide a name, timeout value, and a list of destinations. Optionally, specify a sort configuration and/or a filter, and define a set of latency cap policies. You can also include the ARN for an Amazon Simple Notification Service (SNS) topic to receive notifications of game session placement activity. Notifications using SNS or CloudWatch events is the preferred way to track placement activity.

If successful, a new GameSessionQueue object is returned with an assigned queue ARN. New game session requests, which are submitted to the queue with StartGameSessionPlacement or StartMatchmaking, reference a queue's name or ARN.

Learn more

Design a game session queue

Create a game session queue

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Implementations

impl<C, M, R> CreateGameSessionQueue<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateGameSessionQueueOutput, SdkError<CreateGameSessionQueueError>> where
    R::Policy: SmithyRetryPolicy<CreateGameSessionQueueInputOperationOutputAlias, CreateGameSessionQueueOutput, CreateGameSessionQueueError, CreateGameSessionQueueInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, inp: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn timeout_in_seconds(self, inp: i32) -> Self

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.

pub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self

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.

pub fn player_latency_policies(
    self,
    inp: impl Into<PlayerLatencyPolicy>
) -> Self

Appends an item to PlayerLatencyPolicies.

To override the contents of this collection use set_player_latency_policies.

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.

pub fn set_player_latency_policies(
    self,
    input: Option<Vec<PlayerLatencyPolicy>>
) -> Self

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.

pub fn destinations(self, inp: impl Into<GameSessionQueueDestination>) -> Self

Appends an item to Destinations.

To override the contents of this collection use set_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.

pub fn set_destinations(
    self,
    input: Option<Vec<GameSessionQueueDestination>>
) -> Self

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.

pub fn filter_configuration(self, inp: FilterConfiguration) -> Self

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.

pub fn set_filter_configuration(
    self,
    input: Option<FilterConfiguration>
) -> Self

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.

pub fn priority_configuration(self, inp: PriorityConfiguration) -> Self

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.

pub fn set_priority_configuration(
    self,
    input: Option<PriorityConfiguration>
) -> Self

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.

pub fn custom_event_data(self, inp: impl Into<String>) -> Self

Information to be added to all events that are related to this game session queue.

pub fn set_custom_event_data(self, input: Option<String>) -> Self

Information to be added to all events that are related to this game session queue.

pub fn notification_target(self, inp: impl Into<String>) -> Self

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

pub fn set_notification_target(self, input: Option<String>) -> Self

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

pub fn tags(self, inp: impl Into<Tag>) -> Self

Appends an item to Tags.

To override the contents of this collection use set_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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for CreateGameSessionQueue<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.