Package software.amazon.awssdk.services.gamelift.model

Class CreateGameSessionRequest

    • Method Detail

      • fleetId

        public final String fleetId()

        A unique identifier for the 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.

        Returns:
        A unique identifier for the 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.

      • aliasId

        public final String aliasId()

        A unique identifier for the 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.

        Returns:
        A unique identifier for the 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.

      • maximumPlayerSessionCount

        public final Integer maximumPlayerSessionCount()

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

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

      • name

        public final String name()

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

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

      • hasGameProperties

        public final boolean hasGameProperties()
        For responses, this returns true if the service returned a value for the GameProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • gameProperties

        public final List<GameProperty> gameProperties()

        A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. For an example, see Create a game session with custom properties.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGameProperties() method.

        Returns:
        A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. For an example, see Create a game session with custom properties.

      • creatorId

        public final String creatorId()

        A unique identifier for a player or entity creating the game session.

        If you add a resource creation limit policy to a fleet, the CreateGameSession operation requires a CreatorId. Amazon GameLift limits the number of game session creation requests with the same CreatorId in a specified time period.

        If you your fleet doesn't have a resource creation limit policy and you provide a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests to one request per CreatorId per second.

        To not limit CreateGameSession requests with the same CreatorId, don't provide a CreatorId in your CreateGameSession request.

        Returns:
        A unique identifier for a player or entity creating the game session.

        If you add a resource creation limit policy to a fleet, the CreateGameSession operation requires a CreatorId. Amazon GameLift limits the number of game session creation requests with the same CreatorId in a specified time period.

        If you your fleet doesn't have a resource creation limit policy and you provide a CreatorId in your CreateGameSession requests, Amazon GameLift limits requests to one request per CreatorId per second.

        To not limit CreateGameSession requests with the same CreatorId, don't provide a CreatorId in your CreateGameSession request.

      • gameSessionId

        public final String gameSessionId()

        This parameter is deprecated. 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.

        Returns:
        This parameter is deprecated. 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.

      • idempotencyToken

        public final String idempotencyToken()

        Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. 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.

        Returns:
        Custom string that uniquely identifies the new game session request. This is useful for ensuring that game session requests with the same idempotency token are processed only once. Subsequent requests with the same string return the original GameSession object, with an updated status. 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.

      • gameSessionData

        public final String gameSessionData()

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

        Returns:
        A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session).

      • location

        public final String location()

        A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as us-west-2. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom location.

        Returns:
        A fleet's remote location to place the new game session in. If this parameter is not set, the new game session is placed in the fleet's home Region. Specify a remote location with an Amazon Web Services Region code such as us-west-2. When using an Anywhere fleet, this parameter is required and must be set to the Anywhere fleet's custom location.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object