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.UpdateFleetAttributes

Contents

Description

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

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

updateFleetAttributes Source #

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

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

  • ufaNewGameSessionProtectionPolicy - Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession . * NoProtection -- The game session can be terminated during a scale-down event. * FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
  • ufaName - Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
  • ufaMetricGroups - Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.
  • ufaDescription - Human-readable description of a fleet.
  • ufaResourceCreationLimitPolicy - Policy that limits the number of game sessions an individual player can create over a span of time.
  • ufaFleetId - Unique identifier for a fleet to update attribute metadata for.

data UpdateFleetAttributes Source #

Represents the input for a request action.

See: updateFleetAttributes smart constructor.

Instances
Eq UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Data UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Methods

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

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

toConstr :: UpdateFleetAttributes -> Constr #

dataTypeOf :: UpdateFleetAttributes -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Show UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Generic UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Associated Types

type Rep UpdateFleetAttributes :: Type -> Type #

Hashable UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

ToJSON UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

AWSRequest UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Associated Types

type Rs UpdateFleetAttributes :: Type #

ToHeaders UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

ToPath UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

ToQuery UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

NFData UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Methods

rnf :: UpdateFleetAttributes -> () #

type Rep UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

type Rep UpdateFleetAttributes = D1 (MetaData "UpdateFleetAttributes" "Network.AWS.GameLift.UpdateFleetAttributes" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "UpdateFleetAttributes'" PrefixI True) ((S1 (MetaSel (Just "_ufaNewGameSessionProtectionPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ProtectionPolicy)) :*: (S1 (MetaSel (Just "_ufaName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ufaMetricGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: (S1 (MetaSel (Just "_ufaDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ufaResourceCreationLimitPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ResourceCreationLimitPolicy)) :*: S1 (MetaSel (Just "_ufaFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs UpdateFleetAttributes Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Request Lenses

ufaNewGameSessionProtectionPolicy :: Lens' UpdateFleetAttributes (Maybe ProtectionPolicy) Source #

Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession . * NoProtection -- The game session can be terminated during a scale-down event. * FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

ufaName :: Lens' UpdateFleetAttributes (Maybe Text) Source #

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

ufaMetricGroups :: Lens' UpdateFleetAttributes [Text] Source #

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

ufaDescription :: Lens' UpdateFleetAttributes (Maybe Text) Source #

Human-readable description of a fleet.

ufaResourceCreationLimitPolicy :: Lens' UpdateFleetAttributes (Maybe ResourceCreationLimitPolicy) Source #

Policy that limits the number of game sessions an individual player can create over a span of time.

ufaFleetId :: Lens' UpdateFleetAttributes Text Source #

Unique identifier for a fleet to update attribute metadata for.

Destructuring the Response

updateFleetAttributesResponse Source #

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

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

data UpdateFleetAttributesResponse Source #

Represents the returned data in response to a request action.

See: updateFleetAttributesResponse smart constructor.

Instances
Eq UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Data UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Methods

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

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

toConstr :: UpdateFleetAttributesResponse -> Constr #

dataTypeOf :: UpdateFleetAttributesResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Show UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Generic UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

Associated Types

type Rep UpdateFleetAttributesResponse :: Type -> Type #

NFData UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

type Rep UpdateFleetAttributesResponse Source # 
Instance details

Defined in Network.AWS.GameLift.UpdateFleetAttributes

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

Response Lenses

ufarsFleetId :: Lens' UpdateFleetAttributesResponse (Maybe Text) Source #

Unique identifier for a fleet that was updated.