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

#include <UpdateMatchmakingConfigurationRequest.h>

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

Public Member Functions

 UpdateMatchmakingConfigurationRequest ()
 
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)
 
UpdateMatchmakingConfigurationRequestWithName (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestWithName (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestWithName (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)
 
UpdateMatchmakingConfigurationRequestWithDescription (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestWithDescription (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestWithDescription (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)
 
UpdateMatchmakingConfigurationRequestWithGameSessionQueueArns (const Aws::Vector< Aws::String > &value)
 
UpdateMatchmakingConfigurationRequestWithGameSessionQueueArns (Aws::Vector< Aws::String > &&value)
 
UpdateMatchmakingConfigurationRequestAddGameSessionQueueArns (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestAddGameSessionQueueArns (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestAddGameSessionQueueArns (const char *value)
 
int GetRequestTimeoutSeconds () const
 
bool RequestTimeoutSecondsHasBeenSet () const
 
void SetRequestTimeoutSeconds (int value)
 
UpdateMatchmakingConfigurationRequestWithRequestTimeoutSeconds (int value)
 
int GetAcceptanceTimeoutSeconds () const
 
bool AcceptanceTimeoutSecondsHasBeenSet () const
 
void SetAcceptanceTimeoutSeconds (int value)
 
UpdateMatchmakingConfigurationRequestWithAcceptanceTimeoutSeconds (int value)
 
bool GetAcceptanceRequired () const
 
bool AcceptanceRequiredHasBeenSet () const
 
void SetAcceptanceRequired (bool value)
 
UpdateMatchmakingConfigurationRequestWithAcceptanceRequired (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)
 
UpdateMatchmakingConfigurationRequestWithRuleSetName (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestWithRuleSetName (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestWithRuleSetName (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)
 
UpdateMatchmakingConfigurationRequestWithNotificationTarget (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestWithNotificationTarget (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestWithNotificationTarget (const char *value)
 
int GetAdditionalPlayerCount () const
 
bool AdditionalPlayerCountHasBeenSet () const
 
void SetAdditionalPlayerCount (int value)
 
UpdateMatchmakingConfigurationRequestWithAdditionalPlayerCount (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)
 
UpdateMatchmakingConfigurationRequestWithCustomEventData (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestWithCustomEventData (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestWithCustomEventData (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)
 
UpdateMatchmakingConfigurationRequestWithGameProperties (const Aws::Vector< GameProperty > &value)
 
UpdateMatchmakingConfigurationRequestWithGameProperties (Aws::Vector< GameProperty > &&value)
 
UpdateMatchmakingConfigurationRequestAddGameProperties (const GameProperty &value)
 
UpdateMatchmakingConfigurationRequestAddGameProperties (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)
 
UpdateMatchmakingConfigurationRequestWithGameSessionData (const Aws::String &value)
 
UpdateMatchmakingConfigurationRequestWithGameSessionData (Aws::String &&value)
 
UpdateMatchmakingConfigurationRequestWithGameSessionData (const char *value)
 
const BackfillModeGetBackfillMode () const
 
bool BackfillModeHasBeenSet () const
 
void SetBackfillMode (const BackfillMode &value)
 
void SetBackfillMode (BackfillMode &&value)
 
UpdateMatchmakingConfigurationRequestWithBackfillMode (const BackfillMode &value)
 
UpdateMatchmakingConfigurationRequestWithBackfillMode (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 operation.

See Also:

AWS API Reference

Definition at line 27 of file UpdateMatchmakingConfigurationRequest.h.

Constructor & Destructor Documentation

◆ UpdateMatchmakingConfigurationRequest()

Aws::GameLift::Model::UpdateMatchmakingConfigurationRequest::UpdateMatchmakingConfigurationRequest ( )

Member Function Documentation

◆ AcceptanceRequiredHasBeenSet()

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

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.

Definition at line 294 of file UpdateMatchmakingConfigurationRequest.h.

◆ AcceptanceTimeoutSecondsHasBeenSet()

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

The 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 265 of file UpdateMatchmakingConfigurationRequest.h.

◆ AddGameProperties() [1/2]

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

A 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 575 of file UpdateMatchmakingConfigurationRequest.h.

◆ AddGameProperties() [2/2]

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

A 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 585 of file UpdateMatchmakingConfigurationRequest.h.

◆ AddGameSessionQueueArns() [1/3]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 201 of file UpdateMatchmakingConfigurationRequest.h.

◆ AddGameSessionQueueArns() [2/3]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 211 of file UpdateMatchmakingConfigurationRequest.h.

◆ AddGameSessionQueueArns() [3/3]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 UpdateMatchmakingConfigurationRequest.h.

◆ AdditionalPlayerCountHasBeenSet()

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

The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match.

Definition at line 439 of file UpdateMatchmakingConfigurationRequest.h.

◆ BackfillModeHasBeenSet()

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

The method that is 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 691 of file UpdateMatchmakingConfigurationRequest.h.

◆ CustomEventDataHasBeenSet()

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

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

Definition at line 468 of file UpdateMatchmakingConfigurationRequest.h.

◆ DescriptionHasBeenSet()

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 100 of file UpdateMatchmakingConfigurationRequest.h.

◆ GamePropertiesHasBeenSet()

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

A 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 525 of file UpdateMatchmakingConfigurationRequest.h.

◆ GameSessionDataHasBeenSet()

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

A 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 606 of file UpdateMatchmakingConfigurationRequest.h.

◆ GameSessionQueueArnsHasBeenSet()

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 151 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetAcceptanceRequired()

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

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.

Definition at line 287 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetAcceptanceTimeoutSeconds()

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

The 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 258 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetAdditionalPlayerCount()

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

The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match.

Definition at line 431 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetBackfillMode()

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

The method that is 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 679 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetCustomEventData()

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

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

Definition at line 462 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetDescription()

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 95 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetGameProperties()

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

A 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 515 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetGameSessionData()

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

A 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 596 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetGameSessionQueueArns()

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 141 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetName()

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 47 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetNotificationTarget()

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 373 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetRequestTimeoutSeconds()

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

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.

Definition at line 229 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetRuleSetName()

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 316 of file UpdateMatchmakingConfigurationRequest.h.

◆ GetServiceRequestName()

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

◆ NameHasBeenSet()

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 53 of file UpdateMatchmakingConfigurationRequest.h.

◆ NotificationTargetHasBeenSet()

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 380 of file UpdateMatchmakingConfigurationRequest.h.

◆ RequestTimeoutSecondsHasBeenSet()

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

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.

Definition at line 236 of file UpdateMatchmakingConfigurationRequest.h.

◆ RuleSetNameHasBeenSet()

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 323 of file UpdateMatchmakingConfigurationRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAcceptanceRequired()

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

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.

Definition at line 301 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetAcceptanceTimeoutSeconds()

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

The 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 272 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetAdditionalPlayerCount()

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

The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match.

Definition at line 447 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetBackfillMode() [1/2]

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

The method that is 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 703 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetBackfillMode() [2/2]

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

The method that is 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 715 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetCustomEventData() [1/3]

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

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

Definition at line 474 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetCustomEventData() [2/3]

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

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

Definition at line 480 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetCustomEventData() [3/3]

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

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

Definition at line 486 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetDescription() [1/3]

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 105 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetDescription() [2/3]

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 110 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetDescription() [3/3]

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 115 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameProperties() [1/2]

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

A 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 535 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameProperties() [2/2]

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

A 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 545 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameSessionData() [1/3]

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

A 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 616 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameSessionData() [2/3]

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

A 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 626 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameSessionData() [3/3]

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

A 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 636 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameSessionQueueArns() [1/2]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 161 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetGameSessionQueueArns() [2/2]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 171 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetName() [1/3]

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 59 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetName() [2/3]

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 65 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetName() [3/3]

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 71 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetNotificationTarget() [1/3]

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 387 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetNotificationTarget() [2/3]

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 394 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetNotificationTarget() [3/3]

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 401 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetRequestTimeoutSeconds()

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

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.

Definition at line 243 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetRuleSetName() [1/3]

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 330 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetRuleSetName() [2/3]

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 337 of file UpdateMatchmakingConfigurationRequest.h.

◆ SetRuleSetName() [3/3]

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 344 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithAcceptanceRequired()

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

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.

Definition at line 308 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithAcceptanceTimeoutSeconds()

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

The 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 279 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithAdditionalPlayerCount()

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

The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match.

Definition at line 455 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithBackfillMode() [1/2]

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

The method that is 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 727 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithBackfillMode() [2/2]

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

The method that is 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 739 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithCustomEventData() [1/3]

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

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

Definition at line 492 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithCustomEventData() [2/3]

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

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

Definition at line 498 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithCustomEventData() [3/3]

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

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

Definition at line 504 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithDescription() [1/3]

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 120 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithDescription() [2/3]

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 125 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithDescription() [3/3]

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

A descriptive label that is associated with matchmaking configuration.

Definition at line 130 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameProperties() [1/2]

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

A 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 555 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameProperties() [2/2]

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

A 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 565 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameSessionData() [1/3]

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

A 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 646 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameSessionData() [2/3]

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

A 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 656 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameSessionData() [3/3]

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

A 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 666 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameSessionQueueArns() [1/2]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 181 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithGameSessionQueueArns() [2/2]

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

Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. 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 191 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithName() [1/3]

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 77 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithName() [2/3]

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 83 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithName() [3/3]

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

A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN value.

Definition at line 89 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithNotificationTarget() [1/3]

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 408 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithNotificationTarget() [2/3]

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 415 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithNotificationTarget() [3/3]

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

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

Definition at line 422 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithRequestTimeoutSeconds()

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

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.

Definition at line 250 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithRuleSetName() [1/3]

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 351 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithRuleSetName() [2/3]

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 358 of file UpdateMatchmakingConfigurationRequest.h.

◆ WithRuleSetName() [3/3]

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

A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

Definition at line 365 of file UpdateMatchmakingConfigurationRequest.h.


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