File Coverage

blib/lib/Paws/GameLift/RoutingStrategy.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::GameLift::RoutingStrategy;
2 1     1   425 use Moose;
  1         4  
  1         7  
3             has FleetId => (is => 'ro', isa => 'Str');
4             has Message => (is => 'ro', isa => 'Str');
5             has Type => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::GameLift::RoutingStrategy
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::GameLift::RoutingStrategy object:
24              
25             $service_obj->Method(Att1 => { FleetId => $value, ..., Type => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::RoutingStrategy object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->FleetId
33              
34             =head1 DESCRIPTION
35              
36             Routing configuration for a fleet alias.
37              
38             Fleet-related operations include:
39              
40             =over
41              
42             =item *
43              
44             CreateFleet
45              
46             =item *
47              
48             ListFleets
49              
50             =item *
51              
52             Describe fleets:
53              
54             =over
55              
56             =item *
57              
58             DescribeFleetAttributes
59              
60             =item *
61              
62             DescribeFleetPortSettings
63              
64             =item *
65              
66             DescribeFleetUtilization
67              
68             =item *
69              
70             DescribeRuntimeConfiguration
71              
72             =item *
73              
74             DescribeFleetEvents
75              
76             =back
77              
78             =item *
79              
80             Update fleets:
81              
82             =over
83              
84             =item *
85              
86             UpdateFleetAttributes
87              
88             =item *
89              
90             UpdateFleetCapacity
91              
92             =item *
93              
94             UpdateFleetPortSettings
95              
96             =item *
97              
98             UpdateRuntimeConfiguration
99              
100             =back
101              
102             =item *
103              
104             Manage fleet capacity:
105              
106             =over
107              
108             =item *
109              
110             DescribeFleetCapacity
111              
112             =item *
113              
114             UpdateFleetCapacity
115              
116             =item *
117              
118             PutScalingPolicy (automatic scaling)
119              
120             =item *
121              
122             DescribeScalingPolicies (automatic scaling)
123              
124             =item *
125              
126             DeleteScalingPolicy (automatic scaling)
127              
128             =item *
129              
130             DescribeEC2InstanceLimits
131              
132             =back
133              
134             =item *
135              
136             DeleteFleet
137              
138             =back
139              
140              
141             =head1 ATTRIBUTES
142              
143              
144             =head2 FleetId => Str
145              
146             Unique identifier for a fleet that the alias points to.
147              
148              
149             =head2 Message => Str
150              
151             Message text to be used with a terminal routing strategy.
152              
153              
154             =head2 Type => Str
155              
156             Type of routing strategy.
157              
158             Possible routing types include the following:
159              
160             =over
161              
162             =item *
163              
164             B<SIMPLE> -- The alias resolves to one specific fleet. Use this type
165             when routing to active fleets.
166              
167             =item *
168              
169             B<TERMINAL> -- The alias does not resolve to a fleet but instead can be
170             used to display a message to the user. A terminal alias throws a
171             TerminalRoutingStrategyException with the RoutingStrategy message
172             embedded.
173              
174             =back
175              
176              
177              
178              
179             =head1 SEE ALSO
180              
181             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
182              
183             =head1 BUGS and CONTRIBUTIONS
184              
185             The source code is located here: https://github.com/pplu/aws-sdk-perl
186              
187             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
188              
189             =cut
190