You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass RoutingStrategy data as a hash:

{
  type: "SIMPLE", # accepts SIMPLE, TERMINAL
  fleet_id: "FleetId",
  message: "FreeText",
}

The routing configuration for a fleet alias.

  • CreateAlias

  • ListAliases

  • DescribeAlias

  • UpdateAlias

  • DeleteAlias

  • ResolveAlias

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

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

Returns:

  • (String)


5977
5978
5979
5980
5981
5982
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5977

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

#messageString

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

Returns:

  • (String)


5977
5978
5979
5980
5981
5982
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5977

class RoutingStrategy < Struct.new(
  :type,
  :fleet_id,
  :message)
  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 RoutingStrategy message embedded.

Returns:

  • (String)


5977
5978
5979
5980
5981
5982
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5977

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