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",
}

Routing configuration for a fleet alias.

Fleet-related operations include:

  • CreateFleet

  • ListFleets

  • Describe fleets:

    • DescribeFleetAttributes

    • DescribeFleetPortSettings

    • DescribeFleetUtilization

    • DescribeRuntimeConfiguration

    • DescribeFleetEvents

  • Update fleets:

    • UpdateFleetAttributes

    • UpdateFleetCapacity

    • UpdateFleetPortSettings

    • UpdateRuntimeConfiguration

  • Manage fleet capacity:

    • DescribeFleetCapacity

    • UpdateFleetCapacity

    • PutScalingPolicy (automatic scaling)

    • DescribeScalingPolicies (automatic scaling)

    • DeleteScalingPolicy (automatic scaling)

    • DescribeEC2InstanceLimits

  • DeleteFleet

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

Unique identifier for a fleet that the alias points to.

Returns:

  • (String)


4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4761

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

#messageString

Message text to be used with a terminal routing strategy.

Returns:

  • (String)


4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4761

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

#typeString

Type of routing strategy.

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)


4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4761

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