blib/lib/Paws/EC2/DescribeSecurityGroups.pm

filter: Statementstmt 100% 16 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 18 / 18 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeRouteTablesResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSecurityGroupsResult.pm »
1  
2 package Paws::EC2::DescribeSecurityGroups;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6 1 has GroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'GroupId' );
7 1 has GroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'GroupName' );
8 1 has MaxResults => (is => 'ro', isa => 'Int');
9 1 has NextToken => (is => 'ro', isa => 'Str');
10  
11 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSecurityGroups');
14 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSecurityGroupsResult');
15 1 class_has _result_key => (isa => 'Str', is => 'ro');
16 1 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::EC2::DescribeSecurityGroups - Arguments for method DescribeSecurityGroups on L<Paws::EC2>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method DescribeSecurityGroups on the
27 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
28 as arguments to method DescribeSecurityGroups.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSecurityGroups.
31  
32 =head1 SYNOPSIS
33  
34 my $ec2 = Paws->service('EC2');
35 # To describe a security group
36 # This example describes the specified security group.
37 my $DescribeSecurityGroupsResult =
38 $ec2->DescribeSecurityGroups( 'GroupIds' => ['sg-903004f8'] );
39  
40 # To describe a tagged security group
41 # This example describes the security groups that include the specified tag
42 # (Purpose=test).
43 my $DescribeSecurityGroupsResult = $ec2->DescribeSecurityGroups(
44 'Filters' => [
45  
46 {
47 'Name' => 'tag:Purpose',
48 'Values' => ['test']
49 }
50 ]
51 );
52  
53  
54 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.
55 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeSecurityGroups>
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 DryRun => Bool
61  
62 Checks whether you have the required permissions for the action,
63 without actually making the request, and provides an error response. If
64 you have the required permissions, the error response is
65 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
66  
67  
68  
69 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
70  
71 The filters. If using multiple filters for rules, the results include
72 security groups for which any combination of rules - not necessarily a
73 single rule - match all filters.
74  
75 =over
76  
77 =item *
78  
79 C<description> - The description of the security group.
80  
81 =item *
82  
83 C<egress.ip-permission.cidr> - An IPv4 CIDR block for an outbound
84 security group rule.
85  
86 =item *
87  
88 C<egress.ip-permission.from-port> - For an outbound rule, the start of
89 port range for the TCP and UDP protocols, or an ICMP type number.
90  
91 =item *
92  
93 C<egress.ip-permission.group-id> - The ID of a security group that has
94 been referenced in an outbound security group rule.
95  
96 =item *
97  
98 C<egress.ip-permission.group-name> - The name of a security group that
99 is referenced in an outbound security group rule.
100  
101 =item *
102  
103 C<egress.ip-permission.ipv6-cidr> - An IPv6 CIDR block for an outbound
104 security group rule.
105  
106 =item *
107  
108 C<egress.ip-permission.prefix-list-id> - The ID of a prefix list to
109 which a security group rule allows outbound access.
110  
111 =item *
112  
113 C<egress.ip-permission.protocol> - The IP protocol for an outbound
114 security group rule (C<tcp> | C<udp> | C<icmp>, a protocol number, or
115 -1 for all protocols).
116  
117 =item *
118  
119 C<egress.ip-permission.to-port> - For an outbound rule, the end of port
120 range for the TCP and UDP protocols, or an ICMP code.
121  
122 =item *
123  
124 C<egress.ip-permission.user-id> - The ID of an AWS account that has
125 been referenced in an outbound security group rule.
126  
127 =item *
128  
129 C<group-id> - The ID of the security group.
130  
131 =item *
132  
133 C<group-name> - The name of the security group.
134  
135 =item *
136  
137 C<ip-permission.cidr> - An IPv4 CIDR block for an inbound security
138 group rule.
139  
140 =item *
141  
142 C<ip-permission.from-port> - For an inbound rule, the start of port
143 range for the TCP and UDP protocols, or an ICMP type number.
144  
145 =item *
146  
147 C<ip-permission.group-id> - The ID of a security group that has been
148 referenced in an inbound security group rule.
149  
150 =item *
151  
152 C<ip-permission.group-name> - The name of a security group that is
153 referenced in an inbound security group rule.
154  
155 =item *
156  
157 C<ip-permission.ipv6-cidr> - An IPv6 CIDR block for an inbound security
158 group rule.
159  
160 =item *
161  
162 C<ip-permission.prefix-list-id> - The ID of a prefix list from which a
163 security group rule allows inbound access.
164  
165 =item *
166  
167 C<ip-permission.protocol> - The IP protocol for an inbound security
168 group rule (C<tcp> | C<udp> | C<icmp>, a protocol number, or -1 for all
169 protocols).
170  
171 =item *
172  
173 C<ip-permission.to-port> - For an inbound rule, the end of port range
174 for the TCP and UDP protocols, or an ICMP code.
175  
176 =item *
177  
178 C<ip-permission.user-id> - The ID of an AWS account that has been
179 referenced in an inbound security group rule.
180  
181 =item *
182  
183 C<owner-id> - The AWS account ID of the owner of the security group.
184  
185 =item *
186  
187 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
188 the resource. Use the tag key in the filter name and the tag value as
189 the filter value. For example, to find all resources that have a tag
190 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
191 the filter name and C<TeamA> for the filter value.
192  
193 =item *
194  
195 C<tag-key> - The key of a tag assigned to the resource. Use this filter
196 to find all resources assigned a tag with a specific key, regardless of
197 the tag value.
198  
199 =item *
200  
201 C<vpc-id> - The ID of the VPC specified when the security group was
202 created.
203  
204 =back
205  
206  
207  
208  
209 =head2 GroupIds => ArrayRef[Str|Undef]
210  
211 The IDs of the security groups. Required for security groups in a
212 nondefault VPC.
213  
214 Default: Describes all your security groups.
215  
216  
217  
218 =head2 GroupNames => ArrayRef[Str|Undef]
219  
220 [EC2-Classic and default VPC only] The names of the security groups.
221 You can specify either the security group name or the security group
222 ID. For security groups in a nondefault VPC, use the C<group-name>
223 filter to describe security groups by name.
224  
225 Default: Describes all your security groups.
226  
227  
228  
229 =head2 MaxResults => Int
230  
231 The maximum number of results to return in a single call. To retrieve
232 the remaining results, make another request with the returned
233 C<NextToken> value. This value can be between 5 and 1000. If this
234 parameter is not specified, then all results are returned.
235  
236  
237  
238 =head2 NextToken => Str
239  
240 The token to request the next page of results.
241  
242  
243  
244  
245 =head1 SEE ALSO
246  
247 This class forms part of L<Paws>, documenting arguments for method DescribeSecurityGroups in L<Paws::EC2>
248  
249 =head1 BUGS and CONTRIBUTIONS
250  
251 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
252  
253 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
254  
255 =cut
256  
« blib/lib/Paws/EC2/DescribeRouteTablesResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSecurityGroupsResult.pm »