| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.GameLift.UpdateRuntimeConfiguration
Description
Updates the current runtime configuration for the specified fleet, which
tells GameLift how to launch server processes on all 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 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. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet's runtime configuration never affects existing server processes.
Learn more
Related actions
CreateFleetLocations | UpdateFleetAttributes | UpdateFleetCapacity | UpdateFleetPortSettings | UpdateRuntimeConfiguration | StopFleetActions | StartFleetActions | PutScalingPolicy | DeleteFleet | DeleteFleetLocations | DeleteScalingPolicy | All APIs by task
Synopsis
- data UpdateRuntimeConfiguration = UpdateRuntimeConfiguration' {}
- newUpdateRuntimeConfiguration :: Text -> RuntimeConfiguration -> UpdateRuntimeConfiguration
- updateRuntimeConfiguration_fleetId :: Lens' UpdateRuntimeConfiguration Text
- updateRuntimeConfiguration_runtimeConfiguration :: Lens' UpdateRuntimeConfiguration RuntimeConfiguration
- data UpdateRuntimeConfigurationResponse = UpdateRuntimeConfigurationResponse' {}
- newUpdateRuntimeConfigurationResponse :: Int -> UpdateRuntimeConfigurationResponse
- updateRuntimeConfigurationResponse_runtimeConfiguration :: Lens' UpdateRuntimeConfigurationResponse (Maybe RuntimeConfiguration)
- updateRuntimeConfigurationResponse_httpStatus :: Lens' UpdateRuntimeConfigurationResponse Int
Creating a Request
data UpdateRuntimeConfiguration Source #
Represents the input for a request operation.
See: newUpdateRuntimeConfiguration smart constructor.
Constructors
| UpdateRuntimeConfiguration' | |
Fields
| |
Instances
newUpdateRuntimeConfiguration Source #
Arguments
| :: Text | |
| -> RuntimeConfiguration | |
| -> UpdateRuntimeConfiguration |
Create a value of UpdateRuntimeConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleetId:UpdateRuntimeConfiguration', updateRuntimeConfiguration_fleetId - A unique identifier for the fleet to update runtime configuration for.
You can use either the fleet ID or ARN value.
$sel:runtimeConfiguration:UpdateRuntimeConfiguration', updateRuntimeConfiguration_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, how to launch them, and the
number of processes to run concurrently.
Request Lenses
updateRuntimeConfiguration_fleetId :: Lens' UpdateRuntimeConfiguration Text Source #
A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.
updateRuntimeConfiguration_runtimeConfiguration :: Lens' UpdateRuntimeConfiguration RuntimeConfiguration Source #
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, how to launch them, and the number of processes to run concurrently.
Destructuring the Response
data UpdateRuntimeConfigurationResponse Source #
Represents the returned data in response to a request operation.
See: newUpdateRuntimeConfigurationResponse smart constructor.
Constructors
| UpdateRuntimeConfigurationResponse' | |
Fields
| |
Instances
newUpdateRuntimeConfigurationResponse Source #
Arguments
| :: Int | |
| -> UpdateRuntimeConfigurationResponse |
Create a value of UpdateRuntimeConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:runtimeConfiguration:UpdateRuntimeConfiguration', updateRuntimeConfigurationResponse_runtimeConfiguration - The runtime configuration currently in use by all instances in the
fleet. If the update was successful, all property changes are shown.
$sel:httpStatus:UpdateRuntimeConfigurationResponse', updateRuntimeConfigurationResponse_httpStatus - The response's http status code.
Response Lenses
updateRuntimeConfigurationResponse_runtimeConfiguration :: Lens' UpdateRuntimeConfigurationResponse (Maybe RuntimeConfiguration) Source #
The runtime configuration currently in use by all instances in the fleet. If the update was successful, all property changes are shown.
updateRuntimeConfigurationResponse_httpStatus :: Lens' UpdateRuntimeConfigurationResponse Int Source #
The response's http status code.