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

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