blib/lib/Paws/Lightsail/InstancePortInfo.pm untested

filter: Statementstmt 0.0% 0 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Lightsail::InstancePortInfo;
3 use Moose;
4 has AccessDirection => (is => 'ro', isa => 'Str', request_name => 'accessDirection', traits => ['NameInRequest']);
5 has AccessFrom => (is => 'ro', isa => 'Str', request_name => 'accessFrom', traits => ['NameInRequest']);
6 has AccessType => (is => 'ro', isa => 'Str', request_name => 'accessType', traits => ['NameInRequest']);
7 has CidrListAliases => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'cidrListAliases', traits => ['NameInRequest']);
8 has Cidrs => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'cidrs', traits => ['NameInRequest']);
9 has CommonName => (is => 'ro', isa => 'Str', request_name => 'commonName', traits => ['NameInRequest']);
10 has FromPort => (is => 'ro', isa => 'Int', request_name => 'fromPort', traits => ['NameInRequest']);
11 has Ipv6Cidrs => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ipv6Cidrs', traits => ['NameInRequest']);
12 has Protocol => (is => 'ro', isa => 'Str', request_name => 'protocol', traits => ['NameInRequest']);
13 has ToPort => (is => 'ro', isa => 'Int', request_name => 'toPort', traits => ['NameInRequest']);
14  
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Lightsail::InstancePortInfo
22  
23 =head1 USAGE
24  
25 This class represents one of two things:
26  
27 =head3 Arguments in a call to a service
28  
29 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30 Each attribute should be used as a named argument in the calls that expect this type of object.
31  
32 As an example, if Att1 is expected to be a Paws::Lightsail::InstancePortInfo object:
33  
34 $service_obj->Method(Att1 => { AccessDirection => $value, ..., ToPort => $value });
35  
36 =head3 Results returned from an API call
37  
38 Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::InstancePortInfo object:
39  
40 $result = $service_obj->Method(...);
41 $result->Att1->AccessDirection
42  
43 =head1 DESCRIPTION
44  
45 Describes information about ports for an Amazon Lightsail instance.
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 AccessDirection => Str
51  
52 The access direction (C<inbound> or C<outbound>).
53  
54 Lightsail currently supports only C<inbound> access direction.
55  
56  
57 =head2 AccessFrom => Str
58  
59 The location from which access is allowed. For example, C<Anywhere
60 (0.0.0.0/0)>, or C<Custom> if a specific IP address or range of IP
61 addresses is allowed.
62  
63  
64 =head2 AccessType => Str
65  
66 The type of access (C<Public> or C<Private>).
67  
68  
69 =head2 CidrListAliases => ArrayRef[Str|Undef]
70  
71 An alias that defines access for a preconfigured range of IP addresses.
72  
73 The only alias currently supported is C<lightsail-connect>, which
74 allows IP addresses of the browser-based RDP/SSH client in the
75 Lightsail console to connect to your instance.
76  
77  
78 =head2 Cidrs => ArrayRef[Str|Undef]
79  
80 The IPv4 address, or range of IPv4 addresses (in CIDR notation) that
81 are allowed to connect to an instance through the ports, and the
82 protocol.
83  
84 The C<ipv6Cidrs> parameter lists the IPv6 addresses that are allowed to
85 connect to an instance.
86  
87 For more information about CIDR block notation, see Classless
88 Inter-Domain Routing
89 (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
90 on I<Wikipedia>.
91  
92  
93 =head2 CommonName => Str
94  
95 The common name of the port information.
96  
97  
98 =head2 FromPort => Int
99  
100 The first port in a range of open ports on an instance.
101  
102 Allowed ports:
103  
104 =over
105  
106 =item *
107  
108 TCP and UDP - C<0> to C<65535>
109  
110 =item *
111  
112 ICMP - The ICMP type for IPv4 addresses. For example, specify C<8> as
113 the C<fromPort> (ICMP type), and C<-1> as the C<toPort> (ICMP code), to
114 enable ICMP Ping. For more information, see Control Messages
115 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
116 on I<Wikipedia>.
117  
118 =item *
119  
120 ICMPv6 - The ICMP type for IPv6 addresses. For example, specify C<128>
121 as the C<fromPort> (ICMPv6 type), and C<0> as C<toPort> (ICMPv6 code).
122 For more information, see Internet Control Message Protocol for IPv6
123 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
124  
125 =back
126  
127  
128  
129 =head2 Ipv6Cidrs => ArrayRef[Str|Undef]
130  
131 The IPv6 address, or range of IPv6 addresses (in CIDR notation) that
132 are allowed to connect to an instance through the ports, and the
133 protocol. Only devices with an IPv6 address can connect to an instance
134 through IPv6; otherwise, IPv4 should be used.
135  
136 The C<cidrs> parameter lists the IPv4 addresses that are allowed to
137 connect to an instance.
138  
139 For more information about CIDR block notation, see Classless
140 Inter-Domain Routing
141 (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)
142 on I<Wikipedia>.
143  
144  
145 =head2 Protocol => Str
146  
147 The IP protocol name.
148  
149 The name can be one of the following:
150  
151 =over
152  
153 =item *
154  
155 C<tcp> - Transmission Control Protocol (TCP) provides reliable,
156 ordered, and error-checked delivery of streamed data between
157 applications running on hosts communicating by an IP network. If you
158 have an application that doesn't require reliable data stream service,
159 use UDP instead.
160  
161 =item *
162  
163 C<all> - All transport layer protocol types. For more general
164 information, see Transport layer
165 (https://en.wikipedia.org/wiki/Transport_layer) on I<Wikipedia>.
166  
167 =item *
168  
169 C<udp> - With User Datagram Protocol (UDP), computer applications can
170 send messages (or datagrams) to other hosts on an Internet Protocol
171 (IP) network. Prior communications are not required to set up
172 transmission channels or data paths. Applications that don't require
173 reliable data stream service can use UDP, which provides a
174 connectionless datagram service that emphasizes reduced latency over
175 reliability. If you do require reliable data stream service, use TCP
176 instead.
177  
178 =item *
179  
180 C<icmp> - Internet Control Message Protocol (ICMP) is used to send
181 error messages and operational information indicating success or
182 failure when communicating with an instance. For example, an error is
183 indicated when an instance could not be reached. When you specify
184 C<icmp> as the C<protocol>, you must specify the ICMP type using the
185 C<fromPort> parameter, and ICMP code using the C<toPort> parameter.
186  
187 =back
188  
189  
190  
191 =head2 ToPort => Int
192  
193 The last port in a range of open ports on an instance.
194  
195 Allowed ports:
196  
197 =over
198  
199 =item *
200  
201 TCP and UDP - C<0> to C<65535>
202  
203 =item *
204  
205 ICMP - The ICMP code for IPv4 addresses. For example, specify C<8> as
206 the C<fromPort> (ICMP type), and C<-1> as the C<toPort> (ICMP code), to
207 enable ICMP Ping. For more information, see Control Messages
208 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages)
209 on I<Wikipedia>.
210  
211 =item *
212  
213 ICMPv6 - The ICMP code for IPv6 addresses. For example, specify C<128>
214 as the C<fromPort> (ICMPv6 type), and C<0> as C<toPort> (ICMPv6 code).
215 For more information, see Internet Control Message Protocol for IPv6
216 (https://en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6).
217  
218 =back
219  
220  
221  
222  
223 =head1 SEE ALSO
224  
225 This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail>
226  
227 =head1 BUGS and CONTRIBUTIONS
228  
229 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
230  
231 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
232  
233 =cut
234