AWS SDK for C++  1.7.207
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::MatchmakingConfiguration Class Reference

#include <MatchmakingConfiguration.h>

Public Member Functions

 MatchmakingConfiguration ()
 
 MatchmakingConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
MatchmakingConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
MatchmakingConfigurationWithName (const Aws::String &value)
 
MatchmakingConfigurationWithName (Aws::String &&value)
 
MatchmakingConfigurationWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
MatchmakingConfigurationWithDescription (const Aws::String &value)
 
MatchmakingConfigurationWithDescription (Aws::String &&value)
 
MatchmakingConfigurationWithDescription (const char *value)
 
const Aws::Vector< Aws::String > & GetGameSessionQueueArns () const
 
bool GameSessionQueueArnsHasBeenSet () const
 
void SetGameSessionQueueArns (const Aws::Vector< Aws::String > &value)
 
void SetGameSessionQueueArns (Aws::Vector< Aws::String > &&value)
 
MatchmakingConfigurationWithGameSessionQueueArns (const Aws::Vector< Aws::String > &value)
 
MatchmakingConfigurationWithGameSessionQueueArns (Aws::Vector< Aws::String > &&value)
 
MatchmakingConfigurationAddGameSessionQueueArns (const Aws::String &value)
 
MatchmakingConfigurationAddGameSessionQueueArns (Aws::String &&value)
 
MatchmakingConfigurationAddGameSessionQueueArns (const char *value)
 
int GetRequestTimeoutSeconds () const
 
bool RequestTimeoutSecondsHasBeenSet () const
 
void SetRequestTimeoutSeconds (int value)
 
MatchmakingConfigurationWithRequestTimeoutSeconds (int value)
 
int GetAcceptanceTimeoutSeconds () const
 
bool AcceptanceTimeoutSecondsHasBeenSet () const
 
void SetAcceptanceTimeoutSeconds (int value)
 
MatchmakingConfigurationWithAcceptanceTimeoutSeconds (int value)
 
bool GetAcceptanceRequired () const
 
bool AcceptanceRequiredHasBeenSet () const
 
void SetAcceptanceRequired (bool value)
 
MatchmakingConfigurationWithAcceptanceRequired (bool value)
 
const Aws::StringGetRuleSetName () const
 
bool RuleSetNameHasBeenSet () const
 
void SetRuleSetName (const Aws::String &value)
 
void SetRuleSetName (Aws::String &&value)
 
void SetRuleSetName (const char *value)
 
MatchmakingConfigurationWithRuleSetName (const Aws::String &value)
 
MatchmakingConfigurationWithRuleSetName (Aws::String &&value)
 
MatchmakingConfigurationWithRuleSetName (const char *value)
 
const Aws::StringGetNotificationTarget () const
 
bool NotificationTargetHasBeenSet () const
 
void SetNotificationTarget (const Aws::String &value)
 
void SetNotificationTarget (Aws::String &&value)
 
void SetNotificationTarget (const char *value)
 
MatchmakingConfigurationWithNotificationTarget (const Aws::String &value)
 
MatchmakingConfigurationWithNotificationTarget (Aws::String &&value)
 
MatchmakingConfigurationWithNotificationTarget (const char *value)
 
int GetAdditionalPlayerCount () const
 
bool AdditionalPlayerCountHasBeenSet () const
 
void SetAdditionalPlayerCount (int value)
 
MatchmakingConfigurationWithAdditionalPlayerCount (int value)
 
const Aws::StringGetCustomEventData () const
 
bool CustomEventDataHasBeenSet () const
 
void SetCustomEventData (const Aws::String &value)
 
void SetCustomEventData (Aws::String &&value)
 
void SetCustomEventData (const char *value)
 
MatchmakingConfigurationWithCustomEventData (const Aws::String &value)
 
MatchmakingConfigurationWithCustomEventData (Aws::String &&value)
 
MatchmakingConfigurationWithCustomEventData (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
MatchmakingConfigurationWithCreationTime (const Aws::Utils::DateTime &value)
 
MatchmakingConfigurationWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Vector< GameProperty > & GetGameProperties () const
 
bool GamePropertiesHasBeenSet () const
 
void SetGameProperties (const Aws::Vector< GameProperty > &value)
 
void SetGameProperties (Aws::Vector< GameProperty > &&value)
 
MatchmakingConfigurationWithGameProperties (const Aws::Vector< GameProperty > &value)
 
MatchmakingConfigurationWithGameProperties (Aws::Vector< GameProperty > &&value)
 
MatchmakingConfigurationAddGameProperties (const GameProperty &value)
 
MatchmakingConfigurationAddGameProperties (GameProperty &&value)
 
const Aws::StringGetGameSessionData () const
 
bool GameSessionDataHasBeenSet () const
 
void SetGameSessionData (const Aws::String &value)
 
void SetGameSessionData (Aws::String &&value)
 
void SetGameSessionData (const char *value)
 
MatchmakingConfigurationWithGameSessionData (const Aws::String &value)
 
MatchmakingConfigurationWithGameSessionData (Aws::String &&value)
 
MatchmakingConfigurationWithGameSessionData (const char *value)
 
const BackfillModeGetBackfillMode () const
 
bool BackfillModeHasBeenSet () const
 
void SetBackfillMode (const BackfillMode &value)
 
void SetBackfillMode (BackfillMode &&value)
 
MatchmakingConfigurationWithBackfillMode (const BackfillMode &value)
 
MatchmakingConfigurationWithBackfillMode (BackfillMode &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 47 of file MatchmakingConfiguration.h.

Constructor & Destructor Documentation

◆ MatchmakingConfiguration() [1/2]

Aws::GameLift::Model::MatchmakingConfiguration::MatchmakingConfiguration ( )

◆ MatchmakingConfiguration() [2/2]

Aws::GameLift::Model::MatchmakingConfiguration::MatchmakingConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AcceptanceRequiredHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::AcceptanceRequiredHasBeenSet ( ) const
inline

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Definition at line 314 of file MatchmakingConfiguration.h.

◆ AcceptanceTimeoutSecondsHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::AcceptanceTimeoutSecondsHasBeenSet ( ) const
inline

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

Definition at line 287 of file MatchmakingConfiguration.h.

◆ AddGameProperties() [1/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::AddGameProperties ( const GameProperty value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 614 of file MatchmakingConfiguration.h.

◆ AddGameProperties() [2/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::AddGameProperties ( GameProperty &&  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 624 of file MatchmakingConfiguration.h.

◆ AddGameSessionQueueArns() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::AddGameSessionQueueArns ( const Aws::String value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 221 of file MatchmakingConfiguration.h.

◆ AddGameSessionQueueArns() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::AddGameSessionQueueArns ( Aws::String &&  value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 232 of file MatchmakingConfiguration.h.

◆ AddGameSessionQueueArns() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::AddGameSessionQueueArns ( const char *  value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 243 of file MatchmakingConfiguration.h.

◆ AdditionalPlayerCountHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::AdditionalPlayerCountHasBeenSet ( ) const
inline

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 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Definition at line 441 of file MatchmakingConfiguration.h.

◆ BackfillModeHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::BackfillModeHasBeenSet ( ) const
inline

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 StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

Definition at line 728 of file MatchmakingConfiguration.h.

◆ CreationTimeHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::CreationTimeHasBeenSet ( ) const
inline

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

Definition at line 519 of file MatchmakingConfiguration.h.

◆ CustomEventDataHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::CustomEventDataHasBeenSet ( ) const
inline

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

Definition at line 470 of file MatchmakingConfiguration.h.

◆ DescriptionHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::DescriptionHasBeenSet ( ) const
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 113 of file MatchmakingConfiguration.h.

◆ GamePropertiesHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::GamePropertiesHasBeenSet ( ) const
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 564 of file MatchmakingConfiguration.h.

◆ GameSessionDataHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::GameSessionDataHasBeenSet ( ) const
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 645 of file MatchmakingConfiguration.h.

◆ GameSessionQueueArnsHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::GameSessionQueueArnsHasBeenSet ( ) const
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 166 of file MatchmakingConfiguration.h.

◆ GetAcceptanceRequired()

bool Aws::GameLift::Model::MatchmakingConfiguration::GetAcceptanceRequired ( ) const
inline

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Definition at line 308 of file MatchmakingConfiguration.h.

◆ GetAcceptanceTimeoutSeconds()

int Aws::GameLift::Model::MatchmakingConfiguration::GetAcceptanceTimeoutSeconds ( ) const
inline

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

Definition at line 280 of file MatchmakingConfiguration.h.

◆ GetAdditionalPlayerCount()

int Aws::GameLift::Model::MatchmakingConfiguration::GetAdditionalPlayerCount ( ) const
inline

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 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Definition at line 433 of file MatchmakingConfiguration.h.

◆ GetBackfillMode()

const BackfillMode& Aws::GameLift::Model::MatchmakingConfiguration::GetBackfillMode ( ) const
inline

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 StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

Definition at line 717 of file MatchmakingConfiguration.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::GameLift::Model::MatchmakingConfiguration::GetCreationTime ( ) const
inline

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

Definition at line 513 of file MatchmakingConfiguration.h.

◆ GetCustomEventData()

const Aws::String& Aws::GameLift::Model::MatchmakingConfiguration::GetCustomEventData ( ) const
inline

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

Definition at line 464 of file MatchmakingConfiguration.h.

◆ GetDescription()

const Aws::String& Aws::GameLift::Model::MatchmakingConfiguration::GetDescription ( ) const
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 108 of file MatchmakingConfiguration.h.

◆ GetGameProperties()

const Aws::Vector<GameProperty>& Aws::GameLift::Model::MatchmakingConfiguration::GetGameProperties ( ) const
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 554 of file MatchmakingConfiguration.h.

◆ GetGameSessionData()

const Aws::String& Aws::GameLift::Model::MatchmakingConfiguration::GetGameSessionData ( ) const
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 635 of file MatchmakingConfiguration.h.

◆ GetGameSessionQueueArns()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::MatchmakingConfiguration::GetGameSessionQueueArns ( ) const
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 155 of file MatchmakingConfiguration.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::MatchmakingConfiguration::GetName ( ) const
inline

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

Definition at line 60 of file MatchmakingConfiguration.h.

◆ GetNotificationTarget()

const Aws::String& Aws::GameLift::Model::MatchmakingConfiguration::GetNotificationTarget ( ) const
inline

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

Definition at line 389 of file MatchmakingConfiguration.h.

◆ GetRequestTimeoutSeconds()

int Aws::GameLift::Model::MatchmakingConfiguration::GetRequestTimeoutSeconds ( ) const
inline

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.

Definition at line 251 of file MatchmakingConfiguration.h.

◆ GetRuleSetName()

const Aws::String& Aws::GameLift::Model::MatchmakingConfiguration::GetRuleSetName ( ) const
inline

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

Definition at line 334 of file MatchmakingConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::MatchmakingConfiguration::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::NameHasBeenSet ( ) const
inline

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

Definition at line 66 of file MatchmakingConfiguration.h.

◆ NotificationTargetHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::NotificationTargetHasBeenSet ( ) const
inline

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

Definition at line 394 of file MatchmakingConfiguration.h.

◆ operator=()

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RequestTimeoutSecondsHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::RequestTimeoutSecondsHasBeenSet ( ) const
inline

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.

Definition at line 258 of file MatchmakingConfiguration.h.

◆ RuleSetNameHasBeenSet()

bool Aws::GameLift::Model::MatchmakingConfiguration::RuleSetNameHasBeenSet ( ) const
inline

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

Definition at line 341 of file MatchmakingConfiguration.h.

◆ SetAcceptanceRequired()

void Aws::GameLift::Model::MatchmakingConfiguration::SetAcceptanceRequired ( bool  value)
inline

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Definition at line 320 of file MatchmakingConfiguration.h.

◆ SetAcceptanceTimeoutSeconds()

void Aws::GameLift::Model::MatchmakingConfiguration::SetAcceptanceTimeoutSeconds ( int  value)
inline

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

Definition at line 294 of file MatchmakingConfiguration.h.

◆ SetAdditionalPlayerCount()

void Aws::GameLift::Model::MatchmakingConfiguration::SetAdditionalPlayerCount ( int  value)
inline

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 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Definition at line 449 of file MatchmakingConfiguration.h.

◆ SetBackfillMode() [1/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetBackfillMode ( const BackfillMode value)
inline

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 StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

Definition at line 739 of file MatchmakingConfiguration.h.

◆ SetBackfillMode() [2/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetBackfillMode ( BackfillMode &&  value)
inline

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 StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

Definition at line 750 of file MatchmakingConfiguration.h.

◆ SetCreationTime() [1/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetCreationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 525 of file MatchmakingConfiguration.h.

◆ SetCreationTime() [2/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 531 of file MatchmakingConfiguration.h.

◆ SetCustomEventData() [1/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetCustomEventData ( const Aws::String value)
inline

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

Definition at line 476 of file MatchmakingConfiguration.h.

◆ SetCustomEventData() [2/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetCustomEventData ( Aws::String &&  value)
inline

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

Definition at line 482 of file MatchmakingConfiguration.h.

◆ SetCustomEventData() [3/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetCustomEventData ( const char *  value)
inline

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

Definition at line 488 of file MatchmakingConfiguration.h.

◆ SetDescription() [1/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetDescription ( const Aws::String value)
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 118 of file MatchmakingConfiguration.h.

◆ SetDescription() [2/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetDescription ( Aws::String &&  value)
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 123 of file MatchmakingConfiguration.h.

◆ SetDescription() [3/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetDescription ( const char *  value)
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 128 of file MatchmakingConfiguration.h.

◆ SetGameProperties() [1/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameProperties ( const Aws::Vector< GameProperty > &  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 574 of file MatchmakingConfiguration.h.

◆ SetGameProperties() [2/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameProperties ( Aws::Vector< GameProperty > &&  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 584 of file MatchmakingConfiguration.h.

◆ SetGameSessionData() [1/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameSessionData ( const Aws::String value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 655 of file MatchmakingConfiguration.h.

◆ SetGameSessionData() [2/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameSessionData ( Aws::String &&  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 665 of file MatchmakingConfiguration.h.

◆ SetGameSessionData() [3/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameSessionData ( const char *  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 675 of file MatchmakingConfiguration.h.

◆ SetGameSessionQueueArns() [1/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameSessionQueueArns ( const Aws::Vector< Aws::String > &  value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 177 of file MatchmakingConfiguration.h.

◆ SetGameSessionQueueArns() [2/2]

void Aws::GameLift::Model::MatchmakingConfiguration::SetGameSessionQueueArns ( Aws::Vector< Aws::String > &&  value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 188 of file MatchmakingConfiguration.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetName ( const Aws::String value)
inline

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

Definition at line 72 of file MatchmakingConfiguration.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetName ( Aws::String &&  value)
inline

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

Definition at line 78 of file MatchmakingConfiguration.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetName ( const char *  value)
inline

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

Definition at line 84 of file MatchmakingConfiguration.h.

◆ SetNotificationTarget() [1/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetNotificationTarget ( const Aws::String value)
inline

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

Definition at line 399 of file MatchmakingConfiguration.h.

◆ SetNotificationTarget() [2/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetNotificationTarget ( Aws::String &&  value)
inline

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

Definition at line 404 of file MatchmakingConfiguration.h.

◆ SetNotificationTarget() [3/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetNotificationTarget ( const char *  value)
inline

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

Definition at line 409 of file MatchmakingConfiguration.h.

◆ SetRequestTimeoutSeconds()

void Aws::GameLift::Model::MatchmakingConfiguration::SetRequestTimeoutSeconds ( int  value)
inline

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.

Definition at line 265 of file MatchmakingConfiguration.h.

◆ SetRuleSetName() [1/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetRuleSetName ( const Aws::String value)
inline

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

Definition at line 348 of file MatchmakingConfiguration.h.

◆ SetRuleSetName() [2/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetRuleSetName ( Aws::String &&  value)
inline

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

Definition at line 355 of file MatchmakingConfiguration.h.

◆ SetRuleSetName() [3/3]

void Aws::GameLift::Model::MatchmakingConfiguration::SetRuleSetName ( const char *  value)
inline

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

Definition at line 362 of file MatchmakingConfiguration.h.

◆ WithAcceptanceRequired()

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithAcceptanceRequired ( bool  value)
inline

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

Definition at line 326 of file MatchmakingConfiguration.h.

◆ WithAcceptanceTimeoutSeconds()

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithAcceptanceTimeoutSeconds ( int  value)
inline

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

Definition at line 301 of file MatchmakingConfiguration.h.

◆ WithAdditionalPlayerCount()

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithAdditionalPlayerCount ( int  value)
inline

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 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

Definition at line 457 of file MatchmakingConfiguration.h.

◆ WithBackfillMode() [1/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithBackfillMode ( const BackfillMode value)
inline

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 StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

Definition at line 761 of file MatchmakingConfiguration.h.

◆ WithBackfillMode() [2/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithBackfillMode ( BackfillMode &&  value)
inline

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 StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

Definition at line 772 of file MatchmakingConfiguration.h.

◆ WithCreationTime() [1/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithCreationTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 537 of file MatchmakingConfiguration.h.

◆ WithCreationTime() [2/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 543 of file MatchmakingConfiguration.h.

◆ WithCustomEventData() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithCustomEventData ( const Aws::String value)
inline

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

Definition at line 494 of file MatchmakingConfiguration.h.

◆ WithCustomEventData() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithCustomEventData ( Aws::String &&  value)
inline

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

Definition at line 500 of file MatchmakingConfiguration.h.

◆ WithCustomEventData() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithCustomEventData ( const char *  value)
inline

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

Definition at line 506 of file MatchmakingConfiguration.h.

◆ WithDescription() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithDescription ( const Aws::String value)
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 133 of file MatchmakingConfiguration.h.

◆ WithDescription() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithDescription ( Aws::String &&  value)
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 138 of file MatchmakingConfiguration.h.

◆ WithDescription() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithDescription ( const char *  value)
inline

Descriptive label that is associated with matchmaking configuration.

Definition at line 143 of file MatchmakingConfiguration.h.

◆ WithGameProperties() [1/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameProperties ( const Aws::Vector< GameProperty > &  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 594 of file MatchmakingConfiguration.h.

◆ WithGameProperties() [2/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameProperties ( Aws::Vector< GameProperty > &&  value)
inline

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object 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.

Definition at line 604 of file MatchmakingConfiguration.h.

◆ WithGameSessionData() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameSessionData ( const Aws::String value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 685 of file MatchmakingConfiguration.h.

◆ WithGameSessionData() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameSessionData ( Aws::String &&  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 695 of file MatchmakingConfiguration.h.

◆ WithGameSessionData() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameSessionData ( const char *  value)
inline

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object 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.

Definition at line 705 of file MatchmakingConfiguration.h.

◆ WithGameSessionQueueArns() [1/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameSessionQueueArns ( const Aws::Vector< Aws::String > &  value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 199 of file MatchmakingConfiguration.h.

◆ WithGameSessionQueueArns() [2/2]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithGameSessionQueueArns ( Aws::Vector< Aws::String > &&  value)
inline

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

Definition at line 210 of file MatchmakingConfiguration.h.

◆ WithName() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithName ( const Aws::String value)
inline

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

Definition at line 90 of file MatchmakingConfiguration.h.

◆ WithName() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithName ( Aws::String &&  value)
inline

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

Definition at line 96 of file MatchmakingConfiguration.h.

◆ WithName() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithName ( const char *  value)
inline

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

Definition at line 102 of file MatchmakingConfiguration.h.

◆ WithNotificationTarget() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithNotificationTarget ( const Aws::String value)
inline

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

Definition at line 414 of file MatchmakingConfiguration.h.

◆ WithNotificationTarget() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithNotificationTarget ( Aws::String &&  value)
inline

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

Definition at line 419 of file MatchmakingConfiguration.h.

◆ WithNotificationTarget() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithNotificationTarget ( const char *  value)
inline

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

Definition at line 424 of file MatchmakingConfiguration.h.

◆ WithRequestTimeoutSeconds()

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithRequestTimeoutSeconds ( int  value)
inline

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.

Definition at line 272 of file MatchmakingConfiguration.h.

◆ WithRuleSetName() [1/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithRuleSetName ( const Aws::String value)
inline

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

Definition at line 369 of file MatchmakingConfiguration.h.

◆ WithRuleSetName() [2/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithRuleSetName ( Aws::String &&  value)
inline

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

Definition at line 376 of file MatchmakingConfiguration.h.

◆ WithRuleSetName() [3/3]

MatchmakingConfiguration& Aws::GameLift::Model::MatchmakingConfiguration::WithRuleSetName ( const char *  value)
inline

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

Definition at line 383 of file MatchmakingConfiguration.h.


The documentation for this class was generated from the following file: