Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.Types.RoutingStrategy

Description

Synopsis

Documentation

data RoutingStrategy Source #

The routing configuration for a fleet alias.

Related actions

All APIs by task

See: newRoutingStrategy smart constructor.

Constructors

RoutingStrategy'

Fields

fleetId :: Maybe Text
A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
message :: Maybe Text
The message text to be used with a terminal routing strategy.
type' :: Maybe RoutingStrategyType
The type of routing strategy for the alias.
Possible routing types include the following:
- SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
- TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.

Instances

Instances details

FromJSON RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods parseJSON :: Value -> Parser RoutingStrategy # parseJSONList :: Value -> Parser [RoutingStrategy] #
ToJSON RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods toJSON :: RoutingStrategy -> Value # toEncoding :: RoutingStrategy -> Encoding # toJSONList :: [RoutingStrategy] -> Value # toEncodingList :: [RoutingStrategy] -> Encoding #
Generic RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Associated Types type Rep RoutingStrategy :: Type -> Type # Methods from :: RoutingStrategy -> Rep RoutingStrategy x # to :: Rep RoutingStrategy x -> RoutingStrategy #
Read RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods readsPrec :: Int -> ReadS RoutingStrategy # readList :: ReadS [RoutingStrategy] # readPrec :: ReadPrec RoutingStrategy # readListPrec :: ReadPrec [RoutingStrategy] #
Show RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods showsPrec :: Int -> RoutingStrategy -> ShowS # show :: RoutingStrategy -> String # showList :: [RoutingStrategy] -> ShowS #
NFData RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods rnf :: RoutingStrategy -> () #
Eq RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods (==) :: RoutingStrategy -> RoutingStrategy -> Bool # (/=) :: RoutingStrategy -> RoutingStrategy -> Bool #
Hashable RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy Methods hashWithSalt :: Int -> RoutingStrategy -> Int # hash :: RoutingStrategy -> Int #
type Rep RoutingStrategy Source #
Instance details Defined in Amazonka.GameLift.Types.RoutingStrategy type Rep RoutingStrategy = D1 ('MetaData "RoutingStrategy" "Amazonka.GameLift.Types.RoutingStrategy" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "RoutingStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingStrategyType)))))

newRoutingStrategy :: RoutingStrategy Source #

Create a value of RoutingStrategy 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:RoutingStrategy', routingStrategy_fleetId - A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

$sel:message:RoutingStrategy', routingStrategy_message - The message text to be used with a terminal routing strategy.

$sel:type':RoutingStrategy', routingStrategy_type - The type of routing strategy for the alias.

Possible routing types include the following:

SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.

routingStrategy_fleetId :: Lens' RoutingStrategy (Maybe Text) Source #

A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.

routingStrategy_message :: Lens' RoutingStrategy (Maybe Text) Source #

The message text to be used with a terminal routing strategy.

routingStrategy_type :: Lens' RoutingStrategy (Maybe RoutingStrategyType) Source #

The type of routing strategy for the alias.

Possible routing types include the following:

SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.