public static interface CreateGameSessionRequest.Builder extends GameLiftRequest.Builder, CopyableBuilder<CreateGameSessionRequest.Builder,CreateGameSessionRequest>
Modifier and Type | Method and Description |
---|---|
CreateGameSessionRequest.Builder |
aliasId(String aliasId)
Unique identifier for an alias associated with the fleet to create a game session in.
|
CreateGameSessionRequest.Builder |
creatorId(String creatorId)
Unique identifier for a player or entity creating the game session.
|
CreateGameSessionRequest.Builder |
fleetId(String fleetId)
Unique identifier for a fleet to create a game session in.
|
CreateGameSessionRequest.Builder |
gameProperties(Collection<GameProperty> gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
CreateGameSessionRequest.Builder |
gameProperties(Consumer<GameProperty.Builder>... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
CreateGameSessionRequest.Builder |
gameProperties(GameProperty... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs.
|
CreateGameSessionRequest.Builder |
gameSessionData(String gameSessionData)
Set of developer-defined game session properties, formatted as a single string value.
|
CreateGameSessionRequest.Builder |
gameSessionId(String gameSessionId)
This parameter is no longer preferred.
|
CreateGameSessionRequest.Builder |
idempotencyToken(String idempotencyToken)
Custom string that uniquely identifies a request for a new game session.
|
CreateGameSessionRequest.Builder |
maximumPlayerSessionCount(Integer maximumPlayerSessionCount)
Maximum number of players that can be connected simultaneously to the game session.
|
CreateGameSessionRequest.Builder |
name(String name)
Descriptive label that is associated with a game session.
|
CreateGameSessionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateGameSessionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
build
overrideConfiguration
copy
applyMutation, build
CreateGameSessionRequest.Builder fleetId(String fleetId)
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.
fleetId
- 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.CreateGameSessionRequest.Builder aliasId(String aliasId)
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.
aliasId
- 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.CreateGameSessionRequest.Builder maximumPlayerSessionCount(Integer maximumPlayerSessionCount)
Maximum number of players that can be connected simultaneously to the game session.
maximumPlayerSessionCount
- Maximum number of players that can be connected simultaneously to the game session.CreateGameSessionRequest.Builder name(String name)
Descriptive label that is associated with a game session. Session names do not need to be unique.
name
- Descriptive label that is associated with a game session. Session names do not need to be unique.CreateGameSessionRequest.Builder gameProperties(Collection<GameProperty> gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
gameProperties
- Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These
properties are included in the GameSession object, which is passed to the game server with a
request to start a new game session (see Start a Game Session).CreateGameSessionRequest.Builder gameProperties(GameProperty... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
gameProperties
- Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These
properties are included in the GameSession object, which is passed to the game server with a
request to start a new game session (see Start a Game Session).CreateGameSessionRequest.Builder gameProperties(Consumer<GameProperty.Builder>... gameProperties)
Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #gameProperties(List)
.gameProperties
- a consumer that will call methods on List.Builder
#gameProperties(List)
CreateGameSessionRequest.Builder creatorId(String creatorId)
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.
creatorId
- 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.CreateGameSessionRequest.Builder gameSessionId(String gameSessionId)
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>
.)
gameSessionId
- 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>
.)CreateGameSessionRequest.Builder idempotencyToken(String idempotencyToken)
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.
idempotencyToken
- 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.CreateGameSessionRequest.Builder gameSessionData(String gameSessionData)
Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session).
gameSessionData
- Set of developer-defined game session properties, formatted as a single string value. This data is
included in the GameSession object, which is passed to the game server with a request to start
a new game session (see Start a Game Session).CreateGameSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateGameSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.