File Coverage

blib/lib/Paws/GameLift/CreateMatchmakingConfiguration.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::CreateMatchmakingConfiguration;
3 1     1   450 use Moose;
  1         3  
  1         7  
4             has AcceptanceRequired => (is => 'ro', isa => 'Bool', required => 1);
5             has AcceptanceTimeoutSeconds => (is => 'ro', isa => 'Int');
6             has AdditionalPlayerCount => (is => 'ro', isa => 'Int');
7             has CustomEventData => (is => 'ro', isa => 'Str');
8             has Description => (is => 'ro', isa => 'Str');
9             has GameProperties => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::GameProperty]');
10             has GameSessionData => (is => 'ro', isa => 'Str');
11             has GameSessionQueueArns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
12             has Name => (is => 'ro', isa => 'Str', required => 1);
13             has NotificationTarget => (is => 'ro', isa => 'Str');
14             has RequestTimeoutSeconds => (is => 'ro', isa => 'Int', required => 1);
15             has RuleSetName => (is => 'ro', isa => 'Str', required => 1);
16              
17 1     1   6899 use MooseX::ClassAttribute;
  1         4  
  1         9  
18              
19             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMatchmakingConfiguration');
20             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::CreateMatchmakingConfigurationOutput');
21             class_has _result_key => (isa => 'Str', is => 'ro');
22             1;
23              
24             ### main pod documentation begin ###
25              
26             =head1 NAME
27              
28             Paws::GameLift::CreateMatchmakingConfiguration - Arguments for method CreateMatchmakingConfiguration on Paws::GameLift
29              
30             =head1 DESCRIPTION
31              
32             This class represents the parameters used for calling the method CreateMatchmakingConfiguration on the
33             Amazon GameLift service. Use the attributes of this class
34             as arguments to method CreateMatchmakingConfiguration.
35              
36             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMatchmakingConfiguration.
37              
38             As an example:
39              
40             $service_obj->CreateMatchmakingConfiguration(Att1 => $value1, Att2 => $value2, ...);
41              
42             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.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 B<REQUIRED> AcceptanceRequired => Bool
48              
49             Flag that determines whether or not a match that was created with this
50             configuration must be accepted by the matched players. To require
51             acceptance, set to TRUE.
52              
53              
54              
55             =head2 AcceptanceTimeoutSeconds => Int
56              
57             Length of time (in seconds) to wait for players to accept a proposed
58             match. If any player rejects the match or fails to accept before the
59             timeout, the ticket continues to look for an acceptable match.
60              
61              
62              
63             =head2 AdditionalPlayerCount => Int
64              
65             Number of player slots in a match to keep open for future players. For
66             example, if the configuration's rule set specifies a match for a single
67             12-person team, and the additional player count is set to 2, only 10
68             players are selected for the match.
69              
70              
71              
72             =head2 CustomEventData => Str
73              
74             Information to attached to all events related to the matchmaking
75             configuration.
76              
77              
78              
79             =head2 Description => Str
80              
81             Meaningful description of the matchmaking configuration.
82              
83              
84              
85             =head2 GameProperties => ArrayRef[L<Paws::GameLift::GameProperty>]
86              
87             Set of developer-defined properties for a game session, formatted as a
88             set of type:value pairs. These properties are included in the
89             GameSession object, which is passed to the game server with a request
90             to start a new game session (see Start a Game Session). This
91             information is added to the new GameSession object that is created for
92             a successful match.
93              
94              
95              
96             =head2 GameSessionData => Str
97              
98             Set of developer-defined game session properties, formatted as a single
99             string value. This data is included in the GameSession object, which is
100             passed to the game server with a request to start a new game session
101             (see Start a Game Session). This information is added to the new
102             GameSession object that is created for a successful match.
103              
104              
105              
106             =head2 B<REQUIRED> GameSessionQueueArns => ArrayRef[Str|Undef]
107              
108             Amazon Resource Name (ARN) that is assigned to a game session queue and
109             uniquely identifies it. Format is
110             C<arn:aws:gamelift:E<lt>regionE<gt>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912>.
111             These queues are used when placing game sessions for matches that are
112             created with this matchmaking configuration. Queues can be located in
113             any region.
114              
115              
116              
117             =head2 B<REQUIRED> Name => Str
118              
119             Unique identifier for a matchmaking configuration. This name is used to
120             identify the configuration associated with a matchmaking request or
121             ticket.
122              
123              
124              
125             =head2 NotificationTarget => Str
126              
127             SNS topic ARN that is set up to receive matchmaking notifications.
128              
129              
130              
131             =head2 B<REQUIRED> RequestTimeoutSeconds => Int
132              
133             Maximum duration, in seconds, that a matchmaking ticket can remain in
134             process before timing out. Requests that time out can be resubmitted as
135             needed.
136              
137              
138              
139             =head2 B<REQUIRED> RuleSetName => Str
140              
141             Unique identifier for a matchmaking rule set to use with this
142             configuration. A matchmaking configuration can only use rule sets that
143             are defined in the same region.
144              
145              
146              
147              
148             =head1 SEE ALSO
149              
150             This class forms part of L<Paws>, documenting arguments for method CreateMatchmakingConfiguration in L<Paws::GameLift>
151              
152             =head1 BUGS and CONTRIBUTIONS
153              
154             The source code is located here: https://github.com/pplu/aws-sdk-perl
155              
156             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
157              
158             =cut
159