AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateGameSession operation. This API works with the following fleet types: EC2, Anywhere, Container

Updates the mutable properties of a game session.

To update a game session, specify the game session ID and the values you want to change.

If successful, the updated GameSession object is returned.

All APIs by task

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.UpdateGameSessionRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C# 
public class UpdateGameSessionRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The UpdateGameSessionRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateGameSessionRequest()

Properties

NameTypeDescription
Public Property GameProperties System.Collections.Generic.List<Amazon.GameLift.Model.GameProperty>

Gets and sets the property GameProperties.

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. You can use this parameter to modify game properties in an active game session. This action adds new properties and modifies existing properties. There is no way to delete properties. For an example, see Update the value of a game property.

Public Property GameSessionId System.String

Gets and sets the property GameSessionId.

A unique identifier for the game session to update.

Public Property MaximumPlayerSessionCount System.Int32

Gets and sets the property MaximumPlayerSessionCount.

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

Public Property Name System.String

Gets and sets the property Name.

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

Public Property PlayerSessionCreationPolicy Amazon.GameLift.PlayerSessionCreationPolicy

Gets and sets the property PlayerSessionCreationPolicy.

A policy that determines whether the game session is accepting new players.

Public Property ProtectionPolicy Amazon.GameLift.ProtectionPolicy

Gets and sets the property ProtectionPolicy.

Game session protection policy to apply to this game session only.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5