Class: Aws::GameLift::Types::RoutingStrategy

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-gamelift/types.rb

Overview

The routing configuration for a fleet alias.

**Related actions**

All APIs by task][1

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

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

Returns:

  • (String)


9635
9636
9637
9638
9639
9640
9641
# File 'lib/aws-sdk-gamelift/types.rb', line 9635

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#messageString

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

Returns:

  • (String)


9635
9636
9637
9638
9639
9640
9641
# File 'lib/aws-sdk-gamelift/types.rb', line 9635

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

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.

Returns:

  • (String)


9635
9636
9637
9638
9639
9640
9641
# File 'lib/aws-sdk-gamelift/types.rb', line 9635

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  SENSITIVE = []
  include Aws::Structure
end