amazonka-gamelift-1.6.1: 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.UpdateFleetCapacity

Contents

Description

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy ) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity . If the desired instance count is higher than the instance type's limit, the "Limit Exceeded" exception occurs.

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

updateFleetCapacity Source #

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

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

  • ufcMaxSize - Maximum value allowed for the fleet's instance count. Default if not set is 1.
  • ufcMinSize - Minimum value allowed for the fleet's instance count. Default if not set is 0.
  • ufcDesiredInstances - Number of EC2 instances you want this fleet to host.
  • ufcFleetId - Unique identifier for a fleet to update capacity for.

data UpdateFleetCapacity Source #

Represents the input for a request action.

See: updateFleetCapacity smart constructor.

Instances
Eq UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Data UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Methods

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

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

toConstr :: UpdateFleetCapacity -> Constr #

dataTypeOf :: UpdateFleetCapacity -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Show UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Generic UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Associated Types

type Rep UpdateFleetCapacity :: Type -> Type #

Hashable UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

ToJSON UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

AWSRequest UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Associated Types

type Rs UpdateFleetCapacity :: Type #

ToHeaders UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

ToPath UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

ToQuery UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

NFData UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Methods

rnf :: UpdateFleetCapacity -> () #

type Rep UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

type Rep UpdateFleetCapacity = D1 (MetaData "UpdateFleetCapacity" "Network.AWS.GameLift.UpdateFleetCapacity" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "UpdateFleetCapacity'" PrefixI True) ((S1 (MetaSel (Just "_ufcMaxSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_ufcMinSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) :*: (S1 (MetaSel (Just "_ufcDesiredInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_ufcFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs UpdateFleetCapacity Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Request Lenses

ufcMaxSize :: Lens' UpdateFleetCapacity (Maybe Natural) Source #

Maximum value allowed for the fleet's instance count. Default if not set is 1.

ufcMinSize :: Lens' UpdateFleetCapacity (Maybe Natural) Source #

Minimum value allowed for the fleet's instance count. Default if not set is 0.

ufcDesiredInstances :: Lens' UpdateFleetCapacity (Maybe Natural) Source #

Number of EC2 instances you want this fleet to host.

ufcFleetId :: Lens' UpdateFleetCapacity Text Source #

Unique identifier for a fleet to update capacity for.

Destructuring the Response

updateFleetCapacityResponse Source #

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

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

data UpdateFleetCapacityResponse Source #

Represents the returned data in response to a request action.

See: updateFleetCapacityResponse smart constructor.

Instances
Eq UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Data UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Methods

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

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

toConstr :: UpdateFleetCapacityResponse -> Constr #

dataTypeOf :: UpdateFleetCapacityResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Show UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Generic UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

Associated Types

type Rep UpdateFleetCapacityResponse :: Type -> Type #

NFData UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

type Rep UpdateFleetCapacityResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetCapacity

type Rep UpdateFleetCapacityResponse = D1 (MetaData "UpdateFleetCapacityResponse" "Network.AWS.GameLift.UpdateFleetCapacity" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "UpdateFleetCapacityResponse'" PrefixI True) (S1 (MetaSel (Just "_ufcrsFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ufcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ufcrsFleetId :: Lens' UpdateFleetCapacityResponse (Maybe Text) Source #

Unique identifier for a fleet that was updated.