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::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
UpdateMatchmakingConfigurationRequest &	WithName (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	WithName (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	WithName (const char *value)
const Aws::String &	GetDescription () const
bool	DescriptionHasBeenSet () const
void	SetDescription (const Aws::String &value)
void	SetDescription (Aws::String &&value)
void	SetDescription (const char *value)
UpdateMatchmakingConfigurationRequest &	WithDescription (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	WithDescription (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	WithDescription (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)
UpdateMatchmakingConfigurationRequest &	WithGameSessionQueueArns (const Aws::Vector< Aws::String > &value)
UpdateMatchmakingConfigurationRequest &	WithGameSessionQueueArns (Aws::Vector< Aws::String > &&value)
UpdateMatchmakingConfigurationRequest &	AddGameSessionQueueArns (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	AddGameSessionQueueArns (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	AddGameSessionQueueArns (const char *value)
int	GetRequestTimeoutSeconds () const
bool	RequestTimeoutSecondsHasBeenSet () const
void	SetRequestTimeoutSeconds (int value)
UpdateMatchmakingConfigurationRequest &	WithRequestTimeoutSeconds (int value)
int	GetAcceptanceTimeoutSeconds () const
bool	AcceptanceTimeoutSecondsHasBeenSet () const
void	SetAcceptanceTimeoutSeconds (int value)
UpdateMatchmakingConfigurationRequest &	WithAcceptanceTimeoutSeconds (int value)
bool	GetAcceptanceRequired () const
bool	AcceptanceRequiredHasBeenSet () const
void	SetAcceptanceRequired (bool value)
UpdateMatchmakingConfigurationRequest &	WithAcceptanceRequired (bool value)
const Aws::String &	GetRuleSetName () const
bool	RuleSetNameHasBeenSet () const
void	SetRuleSetName (const Aws::String &value)
void	SetRuleSetName (Aws::String &&value)
void	SetRuleSetName (const char *value)
UpdateMatchmakingConfigurationRequest &	WithRuleSetName (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	WithRuleSetName (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	WithRuleSetName (const char *value)
const Aws::String &	GetNotificationTarget () const
bool	NotificationTargetHasBeenSet () const
void	SetNotificationTarget (const Aws::String &value)
void	SetNotificationTarget (Aws::String &&value)
void	SetNotificationTarget (const char *value)
UpdateMatchmakingConfigurationRequest &	WithNotificationTarget (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	WithNotificationTarget (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	WithNotificationTarget (const char *value)
int	GetAdditionalPlayerCount () const
bool	AdditionalPlayerCountHasBeenSet () const
void	SetAdditionalPlayerCount (int value)
UpdateMatchmakingConfigurationRequest &	WithAdditionalPlayerCount (int value)
const Aws::String &	GetCustomEventData () const
bool	CustomEventDataHasBeenSet () const
void	SetCustomEventData (const Aws::String &value)
void	SetCustomEventData (Aws::String &&value)
void	SetCustomEventData (const char *value)
UpdateMatchmakingConfigurationRequest &	WithCustomEventData (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	WithCustomEventData (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	WithCustomEventData (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)
UpdateMatchmakingConfigurationRequest &	WithGameProperties (const Aws::Vector< GameProperty > &value)
UpdateMatchmakingConfigurationRequest &	WithGameProperties (Aws::Vector< GameProperty > &&value)
UpdateMatchmakingConfigurationRequest &	AddGameProperties (const GameProperty &value)
UpdateMatchmakingConfigurationRequest &	AddGameProperties (GameProperty &&value)
const Aws::String &	GetGameSessionData () const
bool	GameSessionDataHasBeenSet () const
void	SetGameSessionData (const Aws::String &value)
void	SetGameSessionData (Aws::String &&value)
void	SetGameSessionData (const char *value)
UpdateMatchmakingConfigurationRequest &	WithGameSessionData (const Aws::String &value)
UpdateMatchmakingConfigurationRequest &	WithGameSessionData (Aws::String &&value)
UpdateMatchmakingConfigurationRequest &	WithGameSessionData (const char *value)
const BackfillMode &	GetBackfillMode () const
bool	BackfillModeHasBeenSet () const
void	SetBackfillMode (const BackfillMode &value)
void	SetBackfillMode (BackfillMode &&value)
UpdateMatchmakingConfigurationRequest &	WithBackfillMode (const BackfillMode &value)
UpdateMatchmakingConfigurationRequest &	WithBackfillMode (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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 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 304 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 275 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 585 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 595 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 211 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 221 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 231 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 449 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 701 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 478 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 110 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 535 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 616 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 161 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 297 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 268 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 441 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 689 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 472 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 105 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 525 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 606 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 151 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 57 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 383 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 239 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 326 of file UpdateMatchmakingConfigurationRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 46 of file UpdateMatchmakingConfigurationRequest.h.

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 63 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 390 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 246 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 333 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 311 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 282 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 457 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 713 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 725 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 484 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 490 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 496 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 115 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 120 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 125 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 545 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 555 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 626 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 636 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 646 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 171 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 181 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 69 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 75 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 81 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 397 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 404 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 411 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 253 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 340 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 347 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 354 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 318 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 289 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 465 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 737 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 749 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 502 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 508 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 514 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 130 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 135 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 140 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 565 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 575 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 656 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 666 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 676 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 191 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 201 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 87 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 93 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 99 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 418 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 425 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 432 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 260 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 361 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 368 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 375 of file UpdateMatchmakingConfigurationRequest.h.

---

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

• aws-cpp-sdk-gamelift/include/aws/gamelift/model/UpdateMatchmakingConfigurationRequest.h