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

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