Struct aws_sdk_gamelift::types::MatchmakingConfiguration

#[non_exhaustive]
pub struct MatchmakingConfiguration {

    pub name: Option<String>,
    pub configuration_arn: Option<String>,
    pub description: Option<String>,
    pub game_session_queue_arns: Option<Vec<String>>,
    pub request_timeout_seconds: Option<i32>,
    pub acceptance_timeout_seconds: Option<i32>,
    pub acceptance_required: Option<bool>,
    pub rule_set_name: Option<String>,
    pub rule_set_arn: Option<String>,
    pub notification_target: Option<String>,
    pub additional_player_count: Option<i32>,
    pub custom_event_data: Option<String>,
    pub creation_time: Option<DateTime>,
    pub game_properties: Option<Vec<GameProperty>>,
    pub game_session_data: Option<String>,
    pub backfill_mode: Option<BackfillMode>,
    pub flex_match_mode: Option<FlexMatchMode>,
}

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

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 unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

configuration_arn: Option<String>

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::matchmakingconfiguration/ . In a Amazon GameLift configuration ARN, the resource ID matches the Name value.

description: Option<String>

A descriptive label that is associated with matchmaking configuration.

game_session_queue_arns: Option<Vec<String>>

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::gamesessionqueue/ . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when FlexMatchMode is set to STANDALONE.

request_timeout_seconds: Option<i32>

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

acceptance_timeout_seconds: Option<i32>

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

acceptance_required: Option<bool>

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

rule_set_name: Option<String>

A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region.

rule_set_arn: Option<String>

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

notification_target: Option<String>

An SNS topic ARN that is set up to receive matchmaking notifications.

additional_player_count: Option<i32>

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used when FlexMatchMode is set to STANDALONE.

custom_event_data: Option<String>

Information to attach to all events related to the matchmaking configuration.

creation_time: Option<DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

game_properties: Option<Vec<GameProperty>>

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.

game_session_data: Option<String>

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.

backfill_mode: Option<BackfillMode>

The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

flex_match_mode: Option<FlexMatchMode>

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

Implementations

impl MatchmakingConfiguration

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

A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

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

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::matchmakingconfiguration/ . In a Amazon GameLift configuration ARN, the resource ID matches the Name value.

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

A descriptive label that is associated with matchmaking configuration.

pub fn game_session_queue_arns(&self) -> &[String]

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift: ::gamesessionqueue/ . Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when FlexMatchMode is set to STANDALONE.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .game_session_queue_arns.is_none().

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

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

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

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

pub fn acceptance_required(&self) -> Option<bool>

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

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

A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region.

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

The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.

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

An SNS topic ARN that is set up to receive matchmaking notifications.

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

The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 10-person team, and the additional player count is set to 2, 10 players will be selected for the match and 2 more player slots will be open for future players. This parameter is not used when FlexMatchMode is set to STANDALONE.

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

Information to attach to all events related to the matchmaking configuration.

pub fn creation_time(&self) -> Option<&DateTime>

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

pub fn game_properties(&self) -> &[GameProperty]

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .game_properties.is_none().

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

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. This parameter is not used when FlexMatchMode is set to STANDALONE.

pub fn backfill_mode(&self) -> Option<&BackfillMode>

The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill existing games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

pub fn flex_match_mode(&self) -> Option<&FlexMatchMode>

Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match.

impl MatchmakingConfiguration

pub fn builder() -> MatchmakingConfigurationBuilder

Creates a new builder-style object to manufacture MatchmakingConfiguration.

Trait Implementations

impl Clone for MatchmakingConfiguration

fn clone(&self) -> MatchmakingConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MatchmakingConfiguration

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

Formats the value using the given formatter.

impl PartialEq for MatchmakingConfiguration

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MatchmakingConfiguration