UpdateRuntimeConfiguration
Updates the current runtime configuration for the specified fleet, which tells Amazon
GameLift
how to launch server processes on instances in the fleet. You can update a fleet's
runtime configuration at any time after the fleet is created; it does not need to
be in
an ACTIVE
status.
To update runtime configuration, specify the fleet ID and provide a
RuntimeConfiguration
object with an updated set of server process
configurations.
Each instance in a Amazon GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; runtime configuration changes are applied gradually as existing processes shut down and new processes are launched during Amazon GameLift's normal process recycling activity.
Learn more
Related operations
-
Update fleets:
-
UpdateRuntimeConfiguration
Request Syntax
{
"FleetId": "string
",
"RuntimeConfiguration": {
"GameSessionActivationTimeoutSeconds": number
,
"MaxConcurrentGameSessionActivations": number
,
"ServerProcesses": [
{
"ConcurrentExecutions": number
,
"LaunchPath": "string
",
"Parameters": "string
"
}
]
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
In the following list, the required parameters are described first.
- FleetId
-
A unique identifier for a fleet to update runtime configuration for. You can use either the fleet ID or ARN value.
Type: String
Pattern:
^fleet-\S+|^arn:.*:fleet\/fleet-\S+
Required: Yes
- RuntimeConfiguration
-
Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance and includes the following configuration settings: the server executable or launch script file, launch parameters, and the number of processes to run concurrently on each instance. A CreateFleet request must include a runtime configuration with at least one server process configuration.
Type: RuntimeConfiguration object
Required: Yes
Response Syntax
{
"RuntimeConfiguration": {
"GameSessionActivationTimeoutSeconds": number,
"MaxConcurrentGameSessionActivations": number,
"ServerProcesses": [
{
"ConcurrentExecutions": number,
"LaunchPath": "string",
"Parameters": "string"
}
]
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- RuntimeConfiguration
-
The runtime configuration currently in force. If the update was successful, this object matches the one in the request.
Type: RuntimeConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidFleetStatusException
-
The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.
HTTP Status Code: 400
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
A service resource associated with the request could not be found. Clients should not retry such requests.
HTTP Status Code: 400
- UnauthorizedException
-
The client failed authentication. Clients should not retry such requests.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: