File Coverage

blib/lib/Paws/GameLift/Instance.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::Instance;
2 1     1   531 use Moose;
  1         3  
  1         8  
3             has CreationTime => (is => 'ro', isa => 'Str');
4             has FleetId => (is => 'ro', isa => 'Str');
5             has InstanceId => (is => 'ro', isa => 'Str');
6             has IpAddress => (is => 'ro', isa => 'Str');
7             has OperatingSystem => (is => 'ro', isa => 'Str');
8             has Status => (is => 'ro', isa => 'Str');
9             has Type => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::GameLift::Instance
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::GameLift::Instance object:
28              
29             $service_obj->Method(Att1 => { CreationTime => $value, ..., Type => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::Instance object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->CreationTime
37              
38             =head1 DESCRIPTION
39              
40             Properties that describe an instance of a virtual computing resource
41             that hosts one or more game servers. A fleet contains zero or more
42             instances.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 CreationTime => Str
48              
49             Time stamp indicating when this data object was created. Format is a
50             number expressed in Unix time as milliseconds (for example
51             "1469498468.057").
52              
53              
54             =head2 FleetId => Str
55              
56             Unique identifier for a fleet that the instance is in.
57              
58              
59             =head2 InstanceId => Str
60              
61             Unique identifier for an instance.
62              
63              
64             =head2 IpAddress => Str
65              
66             IP address assigned to the instance.
67              
68              
69             =head2 OperatingSystem => Str
70              
71             Operating system that is running on this instance.
72              
73              
74             =head2 Status => Str
75              
76             Current status of the instance. Possible statuses include the
77             following:
78              
79             =over
80              
81             =item *
82              
83             B<PENDING> E<ndash> The instance is in the process of being created and
84             launching server processes as defined in the fleet's run-time
85             configuration.
86              
87             =item *
88              
89             B<ACTIVE> E<ndash> The instance has been successfully created and at
90             least one server process has successfully launched and reported back to
91             Amazon GameLift that it is ready to host a game session. The instance
92             is now considered ready to host game sessions.
93              
94             =item *
95              
96             B<TERMINATING> E<ndash> The instance is in the process of shutting
97             down. This may happen to reduce capacity during a scaling down event or
98             to recycle resources in the event of a problem.
99              
100             =back
101              
102              
103              
104             =head2 Type => Str
105              
106             EC2 instance type that defines the computing resources of this
107             instance.
108              
109              
110              
111             =head1 SEE ALSO
112              
113             This class forms part of L<Paws>, describing an object used in L<Paws::GameLift>
114              
115             =head1 BUGS and CONTRIBUTIONS
116              
117             The source code is located here: https://github.com/pplu/aws-sdk-perl
118              
119             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
120              
121             =cut
122