Interface GameServer.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<GameServer.Builder,
,GameServer> SdkBuilder<GameServer.Builder,
,GameServer> SdkPojo
- Enclosing class:
GameServer
-
Method Summary
Modifier and TypeMethodDescriptionclaimStatus
(String claimStatus) Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game.claimStatus
(GameServerClaimStatus claimStatus) Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game.connectionInfo
(String connectionInfo) The port and IP address that must be used to establish a client connection to the game server.gameServerData
(String gameServerData) A set of custom game server properties, formatted as a single string value.gameServerGroupArn
(String gameServerGroupArn) The ARN identifier for the game server group where the game server is located.gameServerGroupName
(String gameServerGroupName) A unique identifier for the game server group where the game server is running.gameServerId
(String gameServerId) A custom string that uniquely identifies the game server.instanceId
(String instanceId) The unique identifier for the instance where the game server is running.lastClaimTime
(Instant lastClaimTime) Timestamp that indicates the last time the game server was claimed.lastHealthCheckTime
(Instant lastHealthCheckTime) Timestamp that indicates the last time the game server was updated with health status.registrationTime
(Instant registrationTime) Timestamp that indicates when the game server registered.utilizationStatus
(String utilizationStatus) Indicates whether the game server is currently available for new games or is busy.utilizationStatus
(GameServerUtilizationStatus utilizationStatus) Indicates whether the game server is currently available for new games or is busy.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
gameServerGroupName
A unique identifier for the game server group where the game server is running.
- Parameters:
gameServerGroupName
- A unique identifier for the game server group where the game server is running.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameServerGroupArn
The ARN identifier for the game server group where the game server is located.
- Parameters:
gameServerGroupArn
- The ARN identifier for the game server group where the game server is located.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameServerId
A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an Amazon Web Services account.
- Parameters:
gameServerId
- A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an Amazon Web Services account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceId
The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example:
i-1234567890abcdef0
.- Parameters:
instanceId
- The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example:i-1234567890abcdef0
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectionInfo
The port and IP address that must be used to establish a client connection to the game server.
- Parameters:
connectionInfo
- The port and IP address that must be used to establish a client connection to the game server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
gameServerData
A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.
- Parameters:
gameServerData
- A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
claimStatus
Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in
CLAIMED
status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.- Parameters:
claimStatus
- Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains inCLAIMED
status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
claimStatus
Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in
CLAIMED
status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.- Parameters:
claimStatus
- Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains inCLAIMED
status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
utilizationStatus
Indicates whether the game server is currently available for new games or is busy. Possible statuses include:
-
AVAILABLE
- The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity. -
UTILIZED
- The game server is currently hosting a game session with players.
- Parameters:
utilizationStatus
- Indicates whether the game server is currently available for new games or is busy. Possible statuses include:-
AVAILABLE
- The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity. -
UTILIZED
- The game server is currently hosting a game session with players.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
utilizationStatus
Indicates whether the game server is currently available for new games or is busy. Possible statuses include:
-
AVAILABLE
- The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity. -
UTILIZED
- The game server is currently hosting a game session with players.
- Parameters:
utilizationStatus
- Indicates whether the game server is currently available for new games or is busy. Possible statuses include:-
AVAILABLE
- The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity. -
UTILIZED
- The game server is currently hosting a game session with players.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
registrationTime
Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example
"1469498468.057"
).- Parameters:
registrationTime
- Timestamp that indicates when the game server registered. The format is a number expressed in Unix time as milliseconds (for example"1469498468.057"
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastClaimTime
Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example
"1469498468.057"
). This value is used to calculate when a claimed game server's status should revert to null.- Parameters:
lastClaimTime
- Timestamp that indicates the last time the game server was claimed. The format is a number expressed in Unix time as milliseconds (for example"1469498468.057"
). This value is used to calculate when a claimed game server's status should revert to null.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastHealthCheckTime
Timestamp that indicates the last time the game server was updated with health status. The format is a number expressed in Unix time as milliseconds (for example
"1469498468.057"
). After game server registration, this property is only changed when a game server update specifies a health check value.- Parameters:
lastHealthCheckTime
- Timestamp that indicates the last time the game server was updated with health status. The format is a number expressed in Unix time as milliseconds (for example"1469498468.057"
). After game server registration, this property is only changed when a game server update specifies a health check value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-