Struct aws_sdk_gamelift::input::CreateGameSessionQueueInput

#[non_exhaustive]
pub struct CreateGameSessionQueueInput {
    pub name: Option<String>,
    pub timeout_in_seconds: Option<i32>,
    pub player_latency_policies: Option<Vec<PlayerLatencyPolicy>>,
    pub destinations: Option<Vec<GameSessionQueueDestination>>,
    pub filter_configuration: Option<FilterConfiguration>,
    pub priority_configuration: Option<PriorityConfiguration>,
    pub custom_event_data: Option<String>,
    pub notification_target: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

Represents the input for a request operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

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

timeout_in_seconds: Option<i32>

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.

player_latency_policies: Option<Vec<PlayerLatencyPolicy>>

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.

destinations: Option<Vec<GameSessionQueueDestination>>

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.

filter_configuration: Option<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.

priority_configuration: Option<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.

custom_event_data: Option<String>

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

notification_target: Option<String>

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

tags: Option<Vec<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.

Implementations

impl CreateGameSessionQueueInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<CreateGameSessionQueue, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateGameSessionQueue>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateGameSessionQueueInput

impl CreateGameSessionQueueInput

pub fn name(&self) -> Option<&str>

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

pub fn timeout_in_seconds(&self) -> Option<i32>

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) -> Option<&[PlayerLatencyPolicy]>

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) -> Option<&[GameSessionQueueDestination]>

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) -> Option<&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.

pub fn priority_configuration(&self) -> Option<&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.

pub fn custom_event_data(&self) -> Option<&str>

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

pub fn notification_target(&self) -> Option<&str>

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) -> Option<&[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.

Trait Implementations

impl Clone for CreateGameSessionQueueInput

fn clone(&self) -> CreateGameSessionQueueInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateGameSessionQueueInput

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

Formats the value using the given formatter.

impl PartialEq<CreateGameSessionQueueInput> for CreateGameSessionQueueInput

fn eq(&self, other: &CreateGameSessionQueueInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateGameSessionQueueInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateGameSessionQueueInput