AWS SDK for C++  1.8.95
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 operation.

See Also:

AWS API Reference

Definition at line 26 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 291 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 300 of file CreateGameSessionRequest.h.

◆ AliasIdHasBeenSet()

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 111 of file CreateGameSessionRequest.h.

◆ CreatorIdHasBeenSet()

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

A 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 315 of file CreateGameSessionRequest.h.

◆ FleetIdHasBeenSet()

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 54 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 246 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 554 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 380 of file CreateGameSessionRequest.h.

◆ GetAliasId()

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 104 of file CreateGameSessionRequest.h.

◆ GetCreatorId()

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

A 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 308 of file CreateGameSessionRequest.h.

◆ GetFleetId()

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 47 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 237 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 545 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 369 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 458 of file CreateGameSessionRequest.h.

◆ GetMaximumPlayerSessionCount()

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

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

Definition at line 160 of file CreateGameSessionRequest.h.

◆ GetName()

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

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

Definition at line 185 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 35 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 469 of file CreateGameSessionRequest.h.

◆ MaximumPlayerSessionCountHasBeenSet()

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

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

Definition at line 166 of file CreateGameSessionRequest.h.

◆ NameHasBeenSet()

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

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

Definition at line 191 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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 118 of file CreateGameSessionRequest.h.

◆ SetAliasId() [2/3]

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 125 of file CreateGameSessionRequest.h.

◆ SetAliasId() [3/3]

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 132 of file CreateGameSessionRequest.h.

◆ SetCreatorId() [1/3]

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

A 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 322 of file CreateGameSessionRequest.h.

◆ SetCreatorId() [2/3]

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

A 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 329 of file CreateGameSessionRequest.h.

◆ SetCreatorId() [3/3]

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

A 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 336 of file CreateGameSessionRequest.h.

◆ SetFleetId() [1/3]

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 61 of file CreateGameSessionRequest.h.

◆ SetFleetId() [2/3]

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 68 of file CreateGameSessionRequest.h.

◆ SetFleetId() [3/3]

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 75 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 255 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 264 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 563 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 572 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 581 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 391 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 402 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 413 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 480 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 491 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 502 of file CreateGameSessionRequest.h.

◆ SetMaximumPlayerSessionCount()

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

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

Definition at line 172 of file CreateGameSessionRequest.h.

◆ SetName() [1/3]

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

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

Definition at line 197 of file CreateGameSessionRequest.h.

◆ SetName() [2/3]

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

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

Definition at line 203 of file CreateGameSessionRequest.h.

◆ SetName() [3/3]

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

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

Definition at line 209 of file CreateGameSessionRequest.h.

◆ WithAliasId() [1/3]

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 139 of file CreateGameSessionRequest.h.

◆ WithAliasId() [2/3]

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 146 of file CreateGameSessionRequest.h.

◆ WithAliasId() [3/3]

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

A unique identifier for an alias associated with the fleet to create a game session in. You can use either the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 153 of file CreateGameSessionRequest.h.

◆ WithCreatorId() [1/3]

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

A 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 343 of file CreateGameSessionRequest.h.

◆ WithCreatorId() [2/3]

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

A 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 350 of file CreateGameSessionRequest.h.

◆ WithCreatorId() [3/3]

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

A 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 357 of file CreateGameSessionRequest.h.

◆ WithFleetId() [1/3]

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 82 of file CreateGameSessionRequest.h.

◆ WithFleetId() [2/3]

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 89 of file CreateGameSessionRequest.h.

◆ WithFleetId() [3/3]

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

A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.

Definition at line 96 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 273 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 282 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 590 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 599 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 608 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 424 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 435 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 446 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 513 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 524 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 535 of file CreateGameSessionRequest.h.

◆ WithMaximumPlayerSessionCount()

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

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

Definition at line 178 of file CreateGameSessionRequest.h.

◆ WithName() [1/3]

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

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

Definition at line 215 of file CreateGameSessionRequest.h.

◆ WithName() [2/3]

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

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

Definition at line 221 of file CreateGameSessionRequest.h.

◆ WithName() [3/3]

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

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

Definition at line 227 of file CreateGameSessionRequest.h.


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