amazonka-gamelift-1.6.0: Amazon GameLift SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.GameLift.UpdateRuntimeConfiguration

Contents

Description

Updates the current run-time 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 run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while Amazon GameLift simply adds new server processes to fit the current run-time configuration. As a result, the run-time configuration changes are applied gradually as existing processes shut down and new processes are launched in Amazon GameLift's normal process recycling activity.

Fleet-related operations include:

  • CreateFleet
  • ListFleets
  • DeleteFleet
  • Describe fleets:
  • DescribeFleetAttributes
  • DescribeFleetCapacity
  • DescribeFleetPortSettings
  • DescribeFleetUtilization
  • DescribeRuntimeConfiguration
  • DescribeEC2InstanceLimits
  • DescribeFleetEvents
  • Update fleets:
  • UpdateFleetAttributes
  • UpdateFleetCapacity
  • UpdateFleetPortSettings
  • UpdateRuntimeConfiguration
  • Manage fleet actions:
  • StartFleetActions
  • StopFleetActions

Synopsis

Creating a Request

updateRuntimeConfiguration #

Creates a value of UpdateRuntimeConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • urcFleetId - Unique identifier for a fleet to update run-time configuration for.
  • urcRuntimeConfiguration - Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.

data UpdateRuntimeConfiguration #

Represents the input for a request action.

See: updateRuntimeConfiguration smart constructor.

Instances

Eq UpdateRuntimeConfiguration # 
Data UpdateRuntimeConfiguration # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateRuntimeConfiguration -> c UpdateRuntimeConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateRuntimeConfiguration #

toConstr :: UpdateRuntimeConfiguration -> Constr #

dataTypeOf :: UpdateRuntimeConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateRuntimeConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateRuntimeConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> UpdateRuntimeConfiguration -> UpdateRuntimeConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuntimeConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuntimeConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateRuntimeConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateRuntimeConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateRuntimeConfiguration -> m UpdateRuntimeConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuntimeConfiguration -> m UpdateRuntimeConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuntimeConfiguration -> m UpdateRuntimeConfiguration #

Read UpdateRuntimeConfiguration # 
Show UpdateRuntimeConfiguration # 
Generic UpdateRuntimeConfiguration # 
Hashable UpdateRuntimeConfiguration # 
ToJSON UpdateRuntimeConfiguration # 
NFData UpdateRuntimeConfiguration # 
AWSRequest UpdateRuntimeConfiguration # 
ToHeaders UpdateRuntimeConfiguration # 
ToPath UpdateRuntimeConfiguration # 
ToQuery UpdateRuntimeConfiguration # 
type Rep UpdateRuntimeConfiguration # 
type Rep UpdateRuntimeConfiguration = D1 * (MetaData "UpdateRuntimeConfiguration" "Network.AWS.GameLift.UpdateRuntimeConfiguration" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" False) (C1 * (MetaCons "UpdateRuntimeConfiguration'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_urcFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_urcRuntimeConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * RuntimeConfiguration))))
type Rs UpdateRuntimeConfiguration # 

Request Lenses

urcFleetId :: Lens' UpdateRuntimeConfiguration Text #

Unique identifier for a fleet to update run-time configuration for.

urcRuntimeConfiguration :: Lens' UpdateRuntimeConfiguration RuntimeConfiguration #

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.

Destructuring the Response

updateRuntimeConfigurationResponse #

Creates a value of UpdateRuntimeConfigurationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data UpdateRuntimeConfigurationResponse #

Represents the returned data in response to a request action.

See: updateRuntimeConfigurationResponse smart constructor.

Instances

Eq UpdateRuntimeConfigurationResponse # 
Data UpdateRuntimeConfigurationResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateRuntimeConfigurationResponse -> c UpdateRuntimeConfigurationResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateRuntimeConfigurationResponse #

toConstr :: UpdateRuntimeConfigurationResponse -> Constr #

dataTypeOf :: UpdateRuntimeConfigurationResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateRuntimeConfigurationResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateRuntimeConfigurationResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateRuntimeConfigurationResponse -> UpdateRuntimeConfigurationResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuntimeConfigurationResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateRuntimeConfigurationResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateRuntimeConfigurationResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateRuntimeConfigurationResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateRuntimeConfigurationResponse -> m UpdateRuntimeConfigurationResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuntimeConfigurationResponse -> m UpdateRuntimeConfigurationResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateRuntimeConfigurationResponse -> m UpdateRuntimeConfigurationResponse #

Read UpdateRuntimeConfigurationResponse # 
Show UpdateRuntimeConfigurationResponse # 
Generic UpdateRuntimeConfigurationResponse # 
NFData UpdateRuntimeConfigurationResponse # 
type Rep UpdateRuntimeConfigurationResponse # 
type Rep UpdateRuntimeConfigurationResponse = D1 * (MetaData "UpdateRuntimeConfigurationResponse" "Network.AWS.GameLift.UpdateRuntimeConfiguration" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" False) (C1 * (MetaCons "UpdateRuntimeConfigurationResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_urcrsRuntimeConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe RuntimeConfiguration))) (S1 * (MetaSel (Just Symbol "_urcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

urcrsRuntimeConfiguration :: Lens' UpdateRuntimeConfigurationResponse (Maybe RuntimeConfiguration) #

The run-time configuration currently in force. If the update was successful, this object matches the one in the request.