amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.Types.LocationState

Description

 
Synopsis

Documentation

data LocationState Source #

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

  • NEW -- A new fleet location has been defined and desired instances is set to 1.
  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.
  • ACTIVE -- Hosts can now accept game sessions.
  • ERROR -- An error occurred when downloading, validating, building, or activating the fleet location.
  • DELETING -- Hosts are responding to a delete fleet location request.
  • TERMINATED -- The fleet location no longer exists.
  • NOT_FOUND -- The fleet location was not found. This could be because the custom location was removed or not created.

See: newLocationState smart constructor.

Constructors

LocationState' 

Fields

Instances

Instances details
FromJSON LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Methods

parseJSON :: Value -> Parser LocationState #

parseJSONList :: Value -> Parser [LocationState] #

Generic LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Associated Types

type Rep LocationState :: Type -> Type #

Methods

from :: LocationState -> Rep LocationState x #

to :: Rep LocationState x -> LocationState #

Read LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Methods

readsPrec :: Int -> ReadS LocationState #

readList :: ReadS [LocationState] #

readPrec :: ReadPrec LocationState #

readListPrec :: ReadPrec [LocationState] #

Show LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Methods

showsPrec :: Int -> LocationState -> ShowS #

show :: LocationState -> String #

showList :: [LocationState] -> ShowS #

NFData LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Methods

rnf :: LocationState -> () #

Eq LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Methods

(==) :: LocationState -> LocationState -> Bool #

(/=) :: LocationState -> LocationState -> Bool #

Hashable LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

Methods

hashWithSalt :: Int -> LocationState -> Int #

hash :: LocationState -> Int #

type Rep LocationState Source # 
Instance details

Defined in Amazonka.GameLift.Types.LocationState

type Rep LocationState = D1 ('MetaData "LocationState" "Amazonka.GameLift.Types.LocationState" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "LocationState'" 'PrefixI 'True) (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetStatus))))

newLocationState :: LocationState Source #

Create a value of LocationState 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:location:LocationState', locationState_location - The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.

$sel:status:LocationState', locationState_status - The life-cycle status of a fleet location.

locationState_location :: Lens' LocationState (Maybe Text) Source #

The fleet location, expressed as an Amazon Web Services Region code such as us-west-2.

locationState_status :: Lens' LocationState (Maybe FleetStatus) Source #

The life-cycle status of a fleet location.