File Coverage

blib/lib/Paws/EC2/DescribeVpnGateways.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EC2::DescribeVpnGateways;
3 1     1   284 use Moose;
  1     1   3  
  1         6  
  1         429  
  1         2  
  1         5  
4             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6             has VpnGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'VpnGatewayId' );
7              
8 1     1   5306 use MooseX::ClassAttribute;
  1     1   3  
  1         7  
  1         5968  
  1         2  
  1         6  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeVpnGateways');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeVpnGatewaysResult');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::EC2::DescribeVpnGateways - Arguments for method DescribeVpnGateways on Paws::EC2
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeVpnGateways on the
24             Amazon Elastic Compute Cloud service. Use the attributes of this class
25             as arguments to method DescribeVpnGateways.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeVpnGateways.
28              
29             As an example:
30              
31             $service_obj->DescribeVpnGateways(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 DryRun => Bool
39              
40             Checks whether you have the required permissions for the action,
41             without actually making the request, and provides an error response. If
42             you have the required permissions, the error response is
43             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
44              
45              
46              
47             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
48              
49             One or more filters.
50              
51             =over
52              
53             =item *
54              
55             C<attachment.state> - The current state of the attachment between the
56             gateway and the VPC (C<attaching> | C<attached> | C<detaching> |
57             C<detached>).
58              
59             =item *
60              
61             C<attachment.vpc-id> - The ID of an attached VPC.
62              
63             =item *
64              
65             C<availability-zone> - The Availability Zone for the virtual private
66             gateway (if applicable).
67              
68             =item *
69              
70             C<state> - The state of the virtual private gateway (C<pending> |
71             C<available> | C<deleting> | C<deleted>).
72              
73             =item *
74              
75             C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
76             the resource. Specify the key of the tag in the filter name and the
77             value of the tag in the filter value. For example, for the tag
78             Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
79             filter value.
80              
81             =item *
82              
83             C<tag-key> - The key of a tag assigned to the resource. This filter is
84             independent of the C<tag-value> filter. For example, if you use both
85             the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
86             resources assigned both the tag key Purpose (regardless of what the
87             tag's value is), and the tag value X (regardless of what the tag's key
88             is). If you want to list only resources where Purpose is X, see the
89             C<tag>:I<key>=I<value> filter.
90              
91             =item *
92              
93             C<tag-value> - The value of a tag assigned to the resource. This filter
94             is independent of the C<tag-key> filter.
95              
96             =item *
97              
98             C<type> - The type of virtual private gateway. Currently the only
99             supported type is C<ipsec.1>.
100              
101             =item *
102              
103             C<vpn-gateway-id> - The ID of the virtual private gateway.
104              
105             =back
106              
107              
108              
109              
110             =head2 VpnGatewayIds => ArrayRef[Str|Undef]
111              
112             One or more virtual private gateway IDs.
113              
114             Default: Describes all your virtual private gateways.
115              
116              
117              
118              
119             =head1 SEE ALSO
120              
121             This class forms part of L<Paws>, documenting arguments for method DescribeVpnGateways in L<Paws::EC2>
122              
123             =head1 BUGS and CONTRIBUTIONS
124              
125             The source code is located here: https://github.com/pplu/aws-sdk-perl
126              
127             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
128              
129             =cut
130