File Coverage

blib/lib/Paws/GameLift/CreateFleet.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::CreateFleet;
3 1     1   361 use Moose;
  1         2  
  1         7  
4             has BuildId => (is => 'ro', isa => 'Str', required => 1);
5             has Description => (is => 'ro', isa => 'Str');
6             has EC2InboundPermissions => (is => 'ro', isa => 'ArrayRef[Paws::GameLift::IpPermission]');
7             has EC2InstanceType => (is => 'ro', isa => 'Str', required => 1);
8             has LogPaths => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9             has MetricGroups => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10             has Name => (is => 'ro', isa => 'Str', required => 1);
11             has NewGameSessionProtectionPolicy => (is => 'ro', isa => 'Str');
12             has PeerVpcAwsAccountId => (is => 'ro', isa => 'Str');
13             has PeerVpcId => (is => 'ro', isa => 'Str');
14             has ResourceCreationLimitPolicy => (is => 'ro', isa => 'Paws::GameLift::ResourceCreationLimitPolicy');
15             has RuntimeConfiguration => (is => 'ro', isa => 'Paws::GameLift::RuntimeConfiguration');
16             has ServerLaunchParameters => (is => 'ro', isa => 'Str');
17             has ServerLaunchPath => (is => 'ro', isa => 'Str');
18              
19 1     1   5683 use MooseX::ClassAttribute;
  1         2  
  1         8  
20              
21             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFleet');
22             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::GameLift::CreateFleetOutput');
23             class_has _result_key => (isa => 'Str', is => 'ro');
24             1;
25              
26             ### main pod documentation begin ###
27              
28             =head1 NAME
29              
30             Paws::GameLift::CreateFleet - Arguments for method CreateFleet on Paws::GameLift
31              
32             =head1 DESCRIPTION
33              
34             This class represents the parameters used for calling the method CreateFleet on the
35             Amazon GameLift service. Use the attributes of this class
36             as arguments to method CreateFleet.
37              
38             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFleet.
39              
40             As an example:
41              
42             $service_obj->CreateFleet(Att1 => $value1, Att2 => $value2, ...);
43              
44             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.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 B<REQUIRED> BuildId => Str
50              
51             Unique identifier for a build to be deployed on the new fleet. The
52             build must have been successfully uploaded to Amazon GameLift and be in
53             a C<READY> status. This fleet setting cannot be changed once the fleet
54             is created.
55              
56              
57              
58             =head2 Description => Str
59              
60             Human-readable description of a fleet.
61              
62              
63              
64             =head2 EC2InboundPermissions => ArrayRef[L<Paws::GameLift::IpPermission>]
65              
66             Range of IP addresses and port settings that permit inbound traffic to
67             access server processes running on the fleet. If no inbound permissions
68             are set, including both IP address range and port range, the server
69             processes in the fleet cannot accept connections. You can specify one
70             or more sets of permissions for a fleet.
71              
72              
73              
74             =head2 B<REQUIRED> EC2InstanceType => Str
75              
76             Name of an EC2 instance type that is supported in Amazon GameLift. A
77             fleet instance type determines the computing resources of each instance
78             in the fleet, including CPU, memory, storage, and networking capacity.
79             Amazon GameLift supports the following EC2 instance types. See Amazon
80             EC2 Instance Types for detailed descriptions.
81              
82             Valid values are: C<"t2.micro">, C<"t2.small">, C<"t2.medium">, C<"t2.large">, C<"c3.large">, C<"c3.xlarge">, C<"c3.2xlarge">, C<"c3.4xlarge">, C<"c3.8xlarge">, C<"c4.large">, C<"c4.xlarge">, C<"c4.2xlarge">, C<"c4.4xlarge">, C<"c4.8xlarge">, C<"r3.large">, C<"r3.xlarge">, C<"r3.2xlarge">, C<"r3.4xlarge">, C<"r3.8xlarge">, C<"r4.large">, C<"r4.xlarge">, C<"r4.2xlarge">, C<"r4.4xlarge">, C<"r4.8xlarge">, C<"r4.16xlarge">, C<"m3.medium">, C<"m3.large">, C<"m3.xlarge">, C<"m3.2xlarge">, C<"m4.large">, C<"m4.xlarge">, C<"m4.2xlarge">, C<"m4.4xlarge">, C<"m4.10xlarge">
83              
84             =head2 LogPaths => ArrayRef[Str|Undef]
85              
86             This parameter is no longer used. Instead, to specify where Amazon
87             GameLift should store log files once a server process shuts down, use
88             the Amazon GameLift server API C<ProcessReady()> and specify one or
89             more directory paths in C<logParameters>. See more information in the
90             Server API Reference.
91              
92              
93              
94             =head2 MetricGroups => ArrayRef[Str|Undef]
95              
96             Names of metric groups to add this fleet to. Use an existing metric
97             group name to add this fleet to the group. Or use a new name to create
98             a new metric group. A fleet can only be included in one metric group at
99             a time.
100              
101              
102              
103             =head2 B<REQUIRED> Name => Str
104              
105             Descriptive label that is associated with a fleet. Fleet names do not
106             need to be unique.
107              
108              
109              
110             =head2 NewGameSessionProtectionPolicy => Str
111              
112             Game session protection policy to apply to all instances in this fleet.
113             If this parameter is not set, instances in this fleet default to no
114             protection. You can change a fleet's protection policy using
115             UpdateFleetAttributes, but this change will only affect sessions
116             created after the policy change. You can also set protection for
117             individual instances using UpdateGameSession.
118              
119             =over
120              
121             =item *
122              
123             B<NoProtection> -- The game session can be terminated during a
124             scale-down event.
125              
126             =item *
127              
128             B<FullProtection> -- If the game session is in an C<ACTIVE> status, it
129             cannot be terminated during a scale-down event.
130              
131             =back
132              
133              
134             Valid values are: C<"NoProtection">, C<"FullProtection">
135              
136             =head2 PeerVpcAwsAccountId => Str
137              
138             Unique identifier for the AWS account with the VPC that you want to
139             peer your Amazon GameLift fleet with. You can find your Account ID in
140             the AWS Management Console under account settings.
141              
142              
143              
144             =head2 PeerVpcId => Str
145              
146             Unique identifier for a VPC with resources to be accessed by your
147             Amazon GameLift fleet. The VPC must be in the same region where your
148             fleet is deployed. To get VPC information, including IDs, use the
149             Virtual Private Cloud service tools, including the VPC Dashboard in the
150             AWS Management Console.
151              
152              
153              
154             =head2 ResourceCreationLimitPolicy => L<Paws::GameLift::ResourceCreationLimitPolicy>
155              
156             Policy that limits the number of game sessions an individual player can
157             create over a span of time for this fleet.
158              
159              
160              
161             =head2 RuntimeConfiguration => L<Paws::GameLift::RuntimeConfiguration>
162              
163             Instructions for launching server processes on each instance in the
164             fleet. The run-time configuration for a fleet has a collection of
165             server process configurations, one for each type of server process to
166             run on an instance. A server process configuration specifies the
167             location of the server executable, launch parameters, and the number of
168             concurrent processes with that configuration to maintain on each
169             instance. A CreateFleet request must include a run-time configuration
170             with at least one server process configuration; otherwise the request
171             fails with an invalid request exception. (This parameter replaces the
172             parameters C<ServerLaunchPath> and C<ServerLaunchParameters>; requests
173             that contain values for these parameters instead of a run-time
174             configuration will continue to work.)
175              
176              
177              
178             =head2 ServerLaunchParameters => Str
179              
180             This parameter is no longer used. Instead, specify server launch
181             parameters in the C<RuntimeConfiguration> parameter. (Requests that
182             specify a server launch path and launch parameters instead of a
183             run-time configuration will continue to work.)
184              
185              
186              
187             =head2 ServerLaunchPath => Str
188              
189             This parameter is no longer used. Instead, specify a server launch path
190             using the C<RuntimeConfiguration> parameter. (Requests that specify a
191             server launch path and launch parameters instead of a run-time
192             configuration will continue to work.)
193              
194              
195              
196              
197             =head1 SEE ALSO
198              
199             This class forms part of L<Paws>, documenting arguments for method CreateFleet in L<Paws::GameLift>
200              
201             =head1 BUGS and CONTRIBUTIONS
202              
203             The source code is located here: https://github.com/pplu/aws-sdk-perl
204              
205             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
206              
207             =cut
208