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

#include <CreateGameSessionRequest.h>

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

Public Member Functions

 CreateGameSessionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFleetId () const
 
bool FleetIdHasBeenSet () const
 
void SetFleetId (const Aws::String &value)
 
void SetFleetId (Aws::String &&value)
 
void SetFleetId (const char *value)
 
CreateGameSessionRequestWithFleetId (const Aws::String &value)
 
CreateGameSessionRequestWithFleetId (Aws::String &&value)
 
CreateGameSessionRequestWithFleetId (const char *value)
 
const Aws::StringGetAliasId () const
 
bool AliasIdHasBeenSet () const
 
void SetAliasId (const Aws::String &value)
 
void SetAliasId (Aws::String &&value)
 
void SetAliasId (const char *value)
 
CreateGameSessionRequestWithAliasId (const Aws::String &value)
 
CreateGameSessionRequestWithAliasId (Aws::String &&value)
 
CreateGameSessionRequestWithAliasId (const char *value)
 
int GetMaximumPlayerSessionCount () const
 
bool MaximumPlayerSessionCountHasBeenSet () const
 
void SetMaximumPlayerSessionCount (int value)
 
CreateGameSessionRequestWithMaximumPlayerSessionCount (int value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateGameSessionRequestWithName (const Aws::String &value)
 
CreateGameSessionRequestWithName (Aws::String &&value)
 
CreateGameSessionRequestWithName (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)
 
CreateGameSessionRequestWithGameProperties (const Aws::Vector< GameProperty > &value)
 
CreateGameSessionRequestWithGameProperties (Aws::Vector< GameProperty > &&value)
 
CreateGameSessionRequestAddGameProperties (const GameProperty &value)
 
CreateGameSessionRequestAddGameProperties (GameProperty &&value)
 
const Aws::StringGetCreatorId () const
 
bool CreatorIdHasBeenSet () const
 
void SetCreatorId (const Aws::String &value)
 
void SetCreatorId (Aws::String &&value)
 
void SetCreatorId (const char *value)
 
CreateGameSessionRequestWithCreatorId (const Aws::String &value)
 
CreateGameSessionRequestWithCreatorId (Aws::String &&value)
 
CreateGameSessionRequestWithCreatorId (const char *value)
 
const Aws::StringGetGameSessionId () const
 
bool GameSessionIdHasBeenSet () const
 
void SetGameSessionId (const Aws::String &value)
 
void SetGameSessionId (Aws::String &&value)
 
void SetGameSessionId (const char *value)
 
CreateGameSessionRequestWithGameSessionId (const Aws::String &value)
 
CreateGameSessionRequestWithGameSessionId (Aws::String &&value)
 
CreateGameSessionRequestWithGameSessionId (const char *value)
 
const Aws::StringGetIdempotencyToken () const
 
bool IdempotencyTokenHasBeenSet () const
 
void SetIdempotencyToken (const Aws::String &value)
 
void SetIdempotencyToken (Aws::String &&value)
 
void SetIdempotencyToken (const char *value)
 
CreateGameSessionRequestWithIdempotencyToken (const Aws::String &value)
 
CreateGameSessionRequestWithIdempotencyToken (Aws::String &&value)
 
CreateGameSessionRequestWithIdempotencyToken (const char *value)
 
const Aws::StringGetGameSessionData () const
 
bool GameSessionDataHasBeenSet () const
 
void SetGameSessionData (const Aws::String &value)
 
void SetGameSessionData (Aws::String &&value)
 
void SetGameSessionData (const char *value)
 
CreateGameSessionRequestWithGameSessionData (const Aws::String &value)
 
CreateGameSessionRequestWithGameSessionData (Aws::String &&value)
 
CreateGameSessionRequestWithGameSessionData (const char *value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

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

Detailed Description

Represents the input for a request action.

See Also:

AWS API Reference

Definition at line 36 of file CreateGameSessionRequest.h.

Constructor & Destructor Documentation

◆ CreateGameSessionRequest()

Aws::GameLift::Model::CreateGameSessionRequest::CreateGameSessionRequest ( )

Member Function Documentation

◆ AddGameProperties() [1/2]

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 293 of file CreateGameSessionRequest.h.

◆ AddGameProperties() [2/2]

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 302 of file CreateGameSessionRequest.h.

◆ AliasIdHasBeenSet()

bool Aws::GameLift::Model::CreateGameSessionRequest::AliasIdHasBeenSet ( ) const
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 113 of file CreateGameSessionRequest.h.

◆ CreatorIdHasBeenSet()

bool Aws::GameLift::Model::CreateGameSessionRequest::CreatorIdHasBeenSet ( ) const
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 317 of file CreateGameSessionRequest.h.

◆ FleetIdHasBeenSet()

bool Aws::GameLift::Model::CreateGameSessionRequest::FleetIdHasBeenSet ( ) const
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 62 of file CreateGameSessionRequest.h.

◆ GamePropertiesHasBeenSet()

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 248 of file CreateGameSessionRequest.h.

◆ GameSessionDataHasBeenSet()

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 556 of file CreateGameSessionRequest.h.

◆ GameSessionIdHasBeenSet()

bool Aws::GameLift::Model::CreateGameSessionRequest::GameSessionIdHasBeenSet ( ) const
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 382 of file CreateGameSessionRequest.h.

◆ GetAliasId()

const Aws::String& Aws::GameLift::Model::CreateGameSessionRequest::GetAliasId ( ) const
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 106 of file CreateGameSessionRequest.h.

◆ GetCreatorId()

const Aws::String& Aws::GameLift::Model::CreateGameSessionRequest::GetCreatorId ( ) const
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 310 of file CreateGameSessionRequest.h.

◆ GetFleetId()

const Aws::String& Aws::GameLift::Model::CreateGameSessionRequest::GetFleetId ( ) const
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 56 of file CreateGameSessionRequest.h.

◆ GetGameProperties()

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 239 of file CreateGameSessionRequest.h.

◆ GetGameSessionData()

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 547 of file CreateGameSessionRequest.h.

◆ GetGameSessionId()

const Aws::String& Aws::GameLift::Model::CreateGameSessionRequest::GetGameSessionId ( ) const
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 371 of file CreateGameSessionRequest.h.

◆ GetIdempotencyToken()

const Aws::String& Aws::GameLift::Model::CreateGameSessionRequest::GetIdempotencyToken ( ) const
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 460 of file CreateGameSessionRequest.h.

◆ GetMaximumPlayerSessionCount()

int Aws::GameLift::Model::CreateGameSessionRequest::GetMaximumPlayerSessionCount ( ) const
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 162 of file CreateGameSessionRequest.h.

◆ GetName()

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 187 of file CreateGameSessionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 45 of file CreateGameSessionRequest.h.

◆ IdempotencyTokenHasBeenSet()

bool Aws::GameLift::Model::CreateGameSessionRequest::IdempotencyTokenHasBeenSet ( ) const
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 471 of file CreateGameSessionRequest.h.

◆ MaximumPlayerSessionCountHasBeenSet()

bool Aws::GameLift::Model::CreateGameSessionRequest::MaximumPlayerSessionCountHasBeenSet ( ) const
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 168 of file CreateGameSessionRequest.h.

◆ NameHasBeenSet()

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 193 of file CreateGameSessionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAliasId() [1/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetAliasId ( const Aws::String value)
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 120 of file CreateGameSessionRequest.h.

◆ SetAliasId() [2/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetAliasId ( Aws::String &&  value)
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 127 of file CreateGameSessionRequest.h.

◆ SetAliasId() [3/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetAliasId ( const char *  value)
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 134 of file CreateGameSessionRequest.h.

◆ SetCreatorId() [1/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetCreatorId ( const Aws::String value)
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 324 of file CreateGameSessionRequest.h.

◆ SetCreatorId() [2/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetCreatorId ( Aws::String &&  value)
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 331 of file CreateGameSessionRequest.h.

◆ SetCreatorId() [3/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetCreatorId ( const char *  value)
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 338 of file CreateGameSessionRequest.h.

◆ SetFleetId() [1/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetFleetId ( const Aws::String value)
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 68 of file CreateGameSessionRequest.h.

◆ SetFleetId() [2/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetFleetId ( Aws::String &&  value)
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 74 of file CreateGameSessionRequest.h.

◆ SetFleetId() [3/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetFleetId ( const char *  value)
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 80 of file CreateGameSessionRequest.h.

◆ SetGameProperties() [1/2]

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 257 of file CreateGameSessionRequest.h.

◆ SetGameProperties() [2/2]

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 266 of file CreateGameSessionRequest.h.

◆ SetGameSessionData() [1/3]

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 565 of file CreateGameSessionRequest.h.

◆ SetGameSessionData() [2/3]

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 574 of file CreateGameSessionRequest.h.

◆ SetGameSessionData() [3/3]

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 583 of file CreateGameSessionRequest.h.

◆ SetGameSessionId() [1/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetGameSessionId ( const Aws::String value)
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 393 of file CreateGameSessionRequest.h.

◆ SetGameSessionId() [2/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetGameSessionId ( Aws::String &&  value)
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 404 of file CreateGameSessionRequest.h.

◆ SetGameSessionId() [3/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetGameSessionId ( const char *  value)
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 415 of file CreateGameSessionRequest.h.

◆ SetIdempotencyToken() [1/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetIdempotencyToken ( const Aws::String value)
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 482 of file CreateGameSessionRequest.h.

◆ SetIdempotencyToken() [2/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetIdempotencyToken ( Aws::String &&  value)
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 493 of file CreateGameSessionRequest.h.

◆ SetIdempotencyToken() [3/3]

void Aws::GameLift::Model::CreateGameSessionRequest::SetIdempotencyToken ( const char *  value)
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 504 of file CreateGameSessionRequest.h.

◆ SetMaximumPlayerSessionCount()

void Aws::GameLift::Model::CreateGameSessionRequest::SetMaximumPlayerSessionCount ( int  value)
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 174 of file CreateGameSessionRequest.h.

◆ SetName() [1/3]

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 199 of file CreateGameSessionRequest.h.

◆ SetName() [2/3]

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 205 of file CreateGameSessionRequest.h.

◆ SetName() [3/3]

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 211 of file CreateGameSessionRequest.h.

◆ WithAliasId() [1/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithAliasId ( const Aws::String value)
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 141 of file CreateGameSessionRequest.h.

◆ WithAliasId() [2/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithAliasId ( Aws::String &&  value)
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 148 of file CreateGameSessionRequest.h.

◆ WithAliasId() [3/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithAliasId ( const char *  value)
inline

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 155 of file CreateGameSessionRequest.h.

◆ WithCreatorId() [1/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithCreatorId ( const Aws::String value)
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 345 of file CreateGameSessionRequest.h.

◆ WithCreatorId() [2/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithCreatorId ( Aws::String &&  value)
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 352 of file CreateGameSessionRequest.h.

◆ WithCreatorId() [3/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithCreatorId ( const char *  value)
inline

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

Definition at line 359 of file CreateGameSessionRequest.h.

◆ WithFleetId() [1/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithFleetId ( const Aws::String value)
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 86 of file CreateGameSessionRequest.h.

◆ WithFleetId() [2/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithFleetId ( Aws::String &&  value)
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 92 of file CreateGameSessionRequest.h.

◆ WithFleetId() [3/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithFleetId ( const char *  value)
inline

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 98 of file CreateGameSessionRequest.h.

◆ WithGameProperties() [1/2]

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 275 of file CreateGameSessionRequest.h.

◆ WithGameProperties() [2/2]

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

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 284 of file CreateGameSessionRequest.h.

◆ WithGameSessionData() [1/3]

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 592 of file CreateGameSessionRequest.h.

◆ WithGameSessionData() [2/3]

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 601 of file CreateGameSessionRequest.h.

◆ WithGameSessionData() [3/3]

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

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

Definition at line 610 of file CreateGameSessionRequest.h.

◆ WithGameSessionId() [1/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithGameSessionId ( const Aws::String value)
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 426 of file CreateGameSessionRequest.h.

◆ WithGameSessionId() [2/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithGameSessionId ( Aws::String &&  value)
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 437 of file CreateGameSessionRequest.h.

◆ WithGameSessionId() [3/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithGameSessionId ( const char *  value)
inline

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

Definition at line 448 of file CreateGameSessionRequest.h.

◆ WithIdempotencyToken() [1/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithIdempotencyToken ( const Aws::String value)
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 515 of file CreateGameSessionRequest.h.

◆ WithIdempotencyToken() [2/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithIdempotencyToken ( Aws::String &&  value)
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 526 of file CreateGameSessionRequest.h.

◆ WithIdempotencyToken() [3/3]

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithIdempotencyToken ( const char *  value)
inline

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

Definition at line 537 of file CreateGameSessionRequest.h.

◆ WithMaximumPlayerSessionCount()

CreateGameSessionRequest& Aws::GameLift::Model::CreateGameSessionRequest::WithMaximumPlayerSessionCount ( int  value)
inline

Maximum number of players that can be connected simultaneously to the game session.

Definition at line 180 of file CreateGameSessionRequest.h.

◆ WithName() [1/3]

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 217 of file CreateGameSessionRequest.h.

◆ WithName() [2/3]

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 223 of file CreateGameSessionRequest.h.

◆ WithName() [3/3]

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

Descriptive label that is associated with a game session. Session names do not need to be unique.

Definition at line 229 of file CreateGameSessionRequest.h.


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