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

#include <CreateMatchmakingConfigurationRequest.h>

+ Inheritance diagram for Aws::GameLift::Model::CreateMatchmakingConfigurationRequest:

Public Member Functions

 CreateMatchmakingConfigurationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateMatchmakingConfigurationRequestWithName (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestWithName (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestWithName (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)
 
CreateMatchmakingConfigurationRequestWithDescription (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestWithDescription (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestWithDescription (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)
 
CreateMatchmakingConfigurationRequestWithGameSessionQueueArns (const Aws::Vector< Aws::String > &value)
 
CreateMatchmakingConfigurationRequestWithGameSessionQueueArns (Aws::Vector< Aws::String > &&value)
 
CreateMatchmakingConfigurationRequestAddGameSessionQueueArns (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestAddGameSessionQueueArns (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestAddGameSessionQueueArns (const char *value)
 
int GetRequestTimeoutSeconds () const
 
bool RequestTimeoutSecondsHasBeenSet () const
 
void SetRequestTimeoutSeconds (int value)
 
CreateMatchmakingConfigurationRequestWithRequestTimeoutSeconds (int value)
 
int GetAcceptanceTimeoutSeconds () const
 
bool AcceptanceTimeoutSecondsHasBeenSet () const
 
void SetAcceptanceTimeoutSeconds (int value)
 
CreateMatchmakingConfigurationRequestWithAcceptanceTimeoutSeconds (int value)
 
bool GetAcceptanceRequired () const
 
bool AcceptanceRequiredHasBeenSet () const
 
void SetAcceptanceRequired (bool value)
 
CreateMatchmakingConfigurationRequestWithAcceptanceRequired (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)
 
CreateMatchmakingConfigurationRequestWithRuleSetName (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestWithRuleSetName (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestWithRuleSetName (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)
 
CreateMatchmakingConfigurationRequestWithNotificationTarget (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestWithNotificationTarget (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestWithNotificationTarget (const char *value)
 
int GetAdditionalPlayerCount () const
 
bool AdditionalPlayerCountHasBeenSet () const
 
void SetAdditionalPlayerCount (int value)
 
CreateMatchmakingConfigurationRequestWithAdditionalPlayerCount (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)
 
CreateMatchmakingConfigurationRequestWithCustomEventData (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestWithCustomEventData (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestWithCustomEventData (const char *value)
 
const Aws::Vector< GameProperty > & GetGameProperties () const
 
bool GamePropertiesHasBeenSet () const
 
void SetGameProperties (const Aws::Vector< GameProperty > &value)
 
void SetGameProperties (Aws::Vector< GameProperty > &&value)
 
CreateMatchmakingConfigurationRequestWithGameProperties (const Aws::Vector< GameProperty > &value)
 
CreateMatchmakingConfigurationRequestWithGameProperties (Aws::Vector< GameProperty > &&value)
 
CreateMatchmakingConfigurationRequestAddGameProperties (const GameProperty &value)
 
CreateMatchmakingConfigurationRequestAddGameProperties (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)
 
CreateMatchmakingConfigurationRequestWithGameSessionData (const Aws::String &value)
 
CreateMatchmakingConfigurationRequestWithGameSessionData (Aws::String &&value)
 
CreateMatchmakingConfigurationRequestWithGameSessionData (const char *value)
 
const BackfillModeGetBackfillMode () const
 
bool BackfillModeHasBeenSet () const
 
void SetBackfillMode (const BackfillMode &value)
 
void SetBackfillMode (BackfillMode &&value)
 
CreateMatchmakingConfigurationRequestWithBackfillMode (const BackfillMode &value)
 
CreateMatchmakingConfigurationRequestWithBackfillMode (BackfillMode &&value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input for a request action.

See Also:

AWS API Reference

Definition at line 37 of file CreateMatchmakingConfigurationRequest.h.

Constructor & Destructor Documentation

◆ CreateMatchmakingConfigurationRequest()

Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::CreateMatchmakingConfigurationRequest ( )

Member Function Documentation

◆ AcceptanceRequiredHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 311 of file CreateMatchmakingConfigurationRequest.h.

◆ AcceptanceTimeoutSecondsHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 284 of file CreateMatchmakingConfigurationRequest.h.

◆ AddGameProperties() [1/2]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 574 of file CreateMatchmakingConfigurationRequest.h.

◆ AddGameProperties() [2/2]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 584 of file CreateMatchmakingConfigurationRequest.h.

◆ AddGameSessionQueueArns() [1/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 218 of file CreateMatchmakingConfigurationRequest.h.

◆ AddGameSessionQueueArns() [2/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 229 of file CreateMatchmakingConfigurationRequest.h.

◆ AddGameSessionQueueArns() [3/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 240 of file CreateMatchmakingConfigurationRequest.h.

◆ AdditionalPlayerCountHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 438 of file CreateMatchmakingConfigurationRequest.h.

◆ BackfillModeHasBeenSet()

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

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request 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 688 of file CreateMatchmakingConfigurationRequest.h.

◆ CustomEventDataHasBeenSet()

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 467 of file CreateMatchmakingConfigurationRequest.h.

◆ DescriptionHasBeenSet()

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

Meaningful description of the matchmaking configuration.

Definition at line 110 of file CreateMatchmakingConfigurationRequest.h.

◆ GamePropertiesHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 524 of file CreateMatchmakingConfigurationRequest.h.

◆ GameSessionDataHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 605 of file CreateMatchmakingConfigurationRequest.h.

◆ GameSessionQueueArnsHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 163 of file CreateMatchmakingConfigurationRequest.h.

◆ GetAcceptanceRequired()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 305 of file CreateMatchmakingConfigurationRequest.h.

◆ GetAcceptanceTimeoutSeconds()

int Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 277 of file CreateMatchmakingConfigurationRequest.h.

◆ GetAdditionalPlayerCount()

int Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 430 of file CreateMatchmakingConfigurationRequest.h.

◆ GetBackfillMode()

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

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request 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 677 of file CreateMatchmakingConfigurationRequest.h.

◆ GetCustomEventData()

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 461 of file CreateMatchmakingConfigurationRequest.h.

◆ GetDescription()

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

Meaningful description of the matchmaking configuration.

Definition at line 105 of file CreateMatchmakingConfigurationRequest.h.

◆ GetGameProperties()

const Aws::Vector<GameProperty>& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 514 of file CreateMatchmakingConfigurationRequest.h.

◆ GetGameSessionData()

const Aws::String& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 595 of file CreateMatchmakingConfigurationRequest.h.

◆ GetGameSessionQueueArns()

const Aws::Vector<Aws::String>& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 152 of file CreateMatchmakingConfigurationRequest.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 57 of file CreateMatchmakingConfigurationRequest.h.

◆ GetNotificationTarget()

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

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

Definition at line 386 of file CreateMatchmakingConfigurationRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetRequestTimeoutSeconds()

int Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 248 of file CreateMatchmakingConfigurationRequest.h.

◆ GetRuleSetName()

const Aws::String& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 331 of file CreateMatchmakingConfigurationRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ NameHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 63 of file CreateMatchmakingConfigurationRequest.h.

◆ NotificationTargetHasBeenSet()

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

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

Definition at line 391 of file CreateMatchmakingConfigurationRequest.h.

◆ RequestTimeoutSecondsHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 255 of file CreateMatchmakingConfigurationRequest.h.

◆ RuleSetNameHasBeenSet()

bool Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 338 of file CreateMatchmakingConfigurationRequest.h.

◆ SerializePayload()

Aws::String Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAcceptanceRequired()

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 317 of file CreateMatchmakingConfigurationRequest.h.

◆ SetAcceptanceTimeoutSeconds()

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 291 of file CreateMatchmakingConfigurationRequest.h.

◆ SetAdditionalPlayerCount()

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 446 of file CreateMatchmakingConfigurationRequest.h.

◆ SetBackfillMode() [1/2]

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

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request 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 699 of file CreateMatchmakingConfigurationRequest.h.

◆ SetBackfillMode() [2/2]

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

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request 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 710 of file CreateMatchmakingConfigurationRequest.h.

◆ SetCustomEventData() [1/3]

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 473 of file CreateMatchmakingConfigurationRequest.h.

◆ SetCustomEventData() [2/3]

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 479 of file CreateMatchmakingConfigurationRequest.h.

◆ SetCustomEventData() [3/3]

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 485 of file CreateMatchmakingConfigurationRequest.h.

◆ SetDescription() [1/3]

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

Meaningful description of the matchmaking configuration.

Definition at line 115 of file CreateMatchmakingConfigurationRequest.h.

◆ SetDescription() [2/3]

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

Meaningful description of the matchmaking configuration.

Definition at line 120 of file CreateMatchmakingConfigurationRequest.h.

◆ SetDescription() [3/3]

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

Meaningful description of the matchmaking configuration.

Definition at line 125 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameProperties() [1/2]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 534 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameProperties() [2/2]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 544 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameSessionData() [1/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 615 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameSessionData() [2/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 625 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameSessionData() [3/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 635 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameSessionQueueArns() [1/2]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 174 of file CreateMatchmakingConfigurationRequest.h.

◆ SetGameSessionQueueArns() [2/2]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 185 of file CreateMatchmakingConfigurationRequest.h.

◆ SetName() [1/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 69 of file CreateMatchmakingConfigurationRequest.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 75 of file CreateMatchmakingConfigurationRequest.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 81 of file CreateMatchmakingConfigurationRequest.h.

◆ SetNotificationTarget() [1/3]

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

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

Definition at line 396 of file CreateMatchmakingConfigurationRequest.h.

◆ SetNotificationTarget() [2/3]

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

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

Definition at line 401 of file CreateMatchmakingConfigurationRequest.h.

◆ SetNotificationTarget() [3/3]

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

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

Definition at line 406 of file CreateMatchmakingConfigurationRequest.h.

◆ SetRequestTimeoutSeconds()

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 262 of file CreateMatchmakingConfigurationRequest.h.

◆ SetRuleSetName() [1/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 345 of file CreateMatchmakingConfigurationRequest.h.

◆ SetRuleSetName() [2/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 352 of file CreateMatchmakingConfigurationRequest.h.

◆ SetRuleSetName() [3/3]

void Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 359 of file CreateMatchmakingConfigurationRequest.h.

◆ WithAcceptanceRequired()

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 323 of file CreateMatchmakingConfigurationRequest.h.

◆ WithAcceptanceTimeoutSeconds()

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 298 of file CreateMatchmakingConfigurationRequest.h.

◆ WithAdditionalPlayerCount()

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 454 of file CreateMatchmakingConfigurationRequest.h.

◆ WithBackfillMode() [1/2]

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

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request 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 721 of file CreateMatchmakingConfigurationRequest.h.

◆ WithBackfillMode() [2/2]

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

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request 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 732 of file CreateMatchmakingConfigurationRequest.h.

◆ WithCustomEventData() [1/3]

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 491 of file CreateMatchmakingConfigurationRequest.h.

◆ WithCustomEventData() [2/3]

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 497 of file CreateMatchmakingConfigurationRequest.h.

◆ WithCustomEventData() [3/3]

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

Information to be added to all events related to this matchmaking configuration.

Definition at line 503 of file CreateMatchmakingConfigurationRequest.h.

◆ WithDescription() [1/3]

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

Meaningful description of the matchmaking configuration.

Definition at line 130 of file CreateMatchmakingConfigurationRequest.h.

◆ WithDescription() [2/3]

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

Meaningful description of the matchmaking configuration.

Definition at line 135 of file CreateMatchmakingConfigurationRequest.h.

◆ WithDescription() [3/3]

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

Meaningful description of the matchmaking configuration.

Definition at line 140 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameProperties() [1/2]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 554 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameProperties() [2/2]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 564 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameSessionData() [1/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 645 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameSessionData() [2/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 655 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameSessionData() [3/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 665 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameSessionQueueArns() [1/2]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 196 of file CreateMatchmakingConfigurationRequest.h.

◆ WithGameSessionQueueArns() [2/2]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 207 of file CreateMatchmakingConfigurationRequest.h.

◆ WithName() [1/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 87 of file CreateMatchmakingConfigurationRequest.h.

◆ WithName() [2/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 93 of file CreateMatchmakingConfigurationRequest.h.

◆ WithName() [3/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 99 of file CreateMatchmakingConfigurationRequest.h.

◆ WithNotificationTarget() [1/3]

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

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

Definition at line 411 of file CreateMatchmakingConfigurationRequest.h.

◆ WithNotificationTarget() [2/3]

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

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

Definition at line 416 of file CreateMatchmakingConfigurationRequest.h.

◆ WithNotificationTarget() [3/3]

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

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

Definition at line 421 of file CreateMatchmakingConfigurationRequest.h.

◆ WithRequestTimeoutSeconds()

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 269 of file CreateMatchmakingConfigurationRequest.h.

◆ WithRuleSetName() [1/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 366 of file CreateMatchmakingConfigurationRequest.h.

◆ WithRuleSetName() [2/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 373 of file CreateMatchmakingConfigurationRequest.h.

◆ WithRuleSetName() [3/3]

CreateMatchmakingConfigurationRequest& Aws::GameLift::Model::CreateMatchmakingConfigurationRequest::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 380 of file CreateMatchmakingConfigurationRequest.h.


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