UpdateRuntimeConfiguration
Updates the runtime configuration for the specified fleet. The runtime configuration
tells Amazon GameLift how to launch server processes on computes in the fleet. For managed EC2
fleets, it determines what server processes to run on each fleet instance.
You can update a fleet's runtime configuration at any time after the fleet is created;
it does not need to be in ACTIVE
status.
To update runtime configuration, specify the fleet ID and provide a
RuntimeConfiguration
with an updated set of server process
configurations.
If successful, the fleet's runtime configuration settings are updated. Fleet computes that run game server processes regularly check for and receive updated runtime configurations. The computes immediately take action to comply with the new configuration by launching new server processes or by not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
Setting up Amazon GameLift fleets
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.
Note
In the following list, the required parameters are described first.
- FleetId
-
A unique identifier for the 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 fleet computes. 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, how to launch them, and the number of processes to run concurrently.
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 use by computes in the fleet. If the update is successful, all property changes are shown.
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
- LimitExceededException
-
The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
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: