File Coverage

blib/lib/Paws/GameLift/CreateGameSession.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::GameLift::CreateGameSession;
3 1     1   500 use Moose;
  1         3  
  1         7  
4             has AliasId => (is => 'ro', isa => 'Str');
5             has CreatorId => (is => 'ro', isa => 'Str');
6             has FleetId => (is => 'ro', isa => 'Str');
7             has GameProperties => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::GameProperty]');
8             has GameSessionId => (is => 'ro', isa => 'Str');
9             has IdempotencyToken => (is => 'ro', isa => 'Str');
10             has MaximumPlayerSessionCount => (is => 'ro', isa => 'Int', required => 1);
11             has Name => (is => 'ro', isa => 'Str');
12              
13 1     1   6158 use MooseX::ClassAttribute;
  1         2  
  1         9  
14              
15             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGameSession');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::CreateGameSessionOutput');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::GameLift::CreateGameSession - Arguments for method CreateGameSession on Paws::GameLift
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method CreateGameSession on the
29             Amazon GameLift service. Use the attributes of this class
30             as arguments to method CreateGameSession.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGameSession.
33              
34             As an example:
35              
36             $service_obj->CreateGameSession(Att1 => $value1, Att2 => $value2, ...);
37              
38             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 AliasId => Str
44              
45             Unique identifier for an alias associated with the fleet to create a
46             game session in. Each request must reference either a fleet ID or alias
47             ID, but not both.
48              
49              
50              
51             =head2 CreatorId => Str
52              
53             Unique identifier for a player or entity creating the game session.
54             This ID is used to enforce a resource protection policy (if one exists)
55             that limits the number of concurrent active game sessions one player
56             can have.
57              
58              
59              
60             =head2 FleetId => Str
61              
62             Unique identifier for a fleet to create a game session in. Each request
63             must reference either a fleet ID or alias ID, but not both.
64              
65              
66              
67             =head2 GameProperties => ArrayRef[L<Paws::GameLift::GameProperty>]
68              
69             Set of developer-defined properties for a game session. These
70             properties are passed to the server process hosting the game session.
71              
72              
73              
74             =head2 GameSessionId => Str
75              
76             I<This parameter is no longer preferred. Please use C<IdempotencyToken>
77             instead.> Custom string that uniquely identifies a request for a new
78             game session. Maximum token length is 48 characters. If provided, this
79             string is included in the new game session's ID. (A game session ID has
80             the following format:
81             C<arn:aws:gamelift:E<lt>regionE<gt>::gamesession/E<lt>fleet
82             IDE<gt>/E<lt>custom ID string or idempotency tokenE<gt>>.)
83              
84              
85              
86             =head2 IdempotencyToken => Str
87              
88             Custom string that uniquely identifies a request for a new game
89             session. Maximum token length is 48 characters. If provided, this
90             string is included in the new game session's ID. (A game session ID has
91             the following format:
92             C<arn:aws:gamelift:E<lt>regionE<gt>::gamesession/E<lt>fleet
93             IDE<gt>/E<lt>custom ID string or idempotency tokenE<gt>>.)
94              
95              
96              
97             =head2 B<REQUIRED> MaximumPlayerSessionCount => Int
98              
99             Maximum number of players that can be connected simultaneously to the
100             game session.
101              
102              
103              
104             =head2 Name => Str
105              
106             Descriptive label that is associated with a game session. Session names
107             do not need to be unique.
108              
109              
110              
111              
112             =head1 SEE ALSO
113              
114             This class forms part of L<Paws>, documenting arguments for method CreateGameSession in L<Paws::GameLift>
115              
116             =head1 BUGS and CONTRIBUTIONS
117              
118             The source code is located here: https://github.com/pplu/aws-sdk-perl
119              
120             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
121              
122             =cut
123