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

Interface CreateGameSessionRequest.Builder

    • Method Detail

      • fleetId

        CreateGameSessionRequest.Builder fleetId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • aliasId

        CreateGameSessionRequest.Builder aliasId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • maximumPlayerSessionCount

        CreateGameSessionRequest.Builder maximumPlayerSessionCount​(Integer maximumPlayerSessionCount)

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

        Parameters:
        maximumPlayerSessionCount - The maximum number of players that can be connected simultaneously to the game session.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        CreateGameSessionRequest.Builder name​(String name)

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

        Parameters:
        name - A descriptive label that is associated with a game session. Session names do not need to be unique.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creatorId

        CreateGameSessionRequest.Builder creatorId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • gameSessionId

        CreateGameSessionRequest.Builder gameSessionId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • idempotencyToken

        CreateGameSessionRequest.Builder idempotencyToken​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • gameSessionData

        CreateGameSessionRequest.Builder gameSessionData​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • location

        CreateGameSessionRequest.Builder location​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.