File Coverage

blib/lib/Paws/EC2/DescribeCustomerGateways.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::DescribeCustomerGateways;
3 1     1   348 use Moose;
  1     1   3  
  1         5  
  1         500  
  1         2  
  1         9  
4             has CustomerGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'CustomerGatewayId' );
5             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
6             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
7              
8 1     1   5461 use MooseX::ClassAttribute;
  1     1   3  
  1         7  
  1         6926  
  1         2  
  1         10  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCustomerGateways');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeCustomerGatewaysResult');
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::DescribeCustomerGateways - Arguments for method DescribeCustomerGateways on Paws::EC2
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeCustomerGateways on the
24             Amazon Elastic Compute Cloud service. Use the attributes of this class
25             as arguments to method DescribeCustomerGateways.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCustomerGateways.
28              
29             As an example:
30              
31             $service_obj->DescribeCustomerGateways(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 CustomerGatewayIds => ArrayRef[Str|Undef]
39              
40             One or more customer gateway IDs.
41              
42             Default: Describes all your customer gateways.
43              
44              
45              
46             =head2 DryRun => Bool
47              
48             Checks whether you have the required permissions for the action,
49             without actually making the request, and provides an error response. If
50             you have the required permissions, the error response is
51             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
52              
53              
54              
55             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
56              
57             One or more filters.
58              
59             =over
60              
61             =item *
62              
63             C<bgp-asn> - The customer gateway's Border Gateway Protocol (BGP)
64             Autonomous System Number (ASN).
65              
66             =item *
67              
68             C<customer-gateway-id> - The ID of the customer gateway.
69              
70             =item *
71              
72             C<ip-address> - The IP address of the customer gateway's
73             Internet-routable external interface.
74              
75             =item *
76              
77             C<state> - The state of the customer gateway (C<pending> | C<available>
78             | C<deleting> | C<deleted>).
79              
80             =item *
81              
82             C<type> - The type of customer gateway. Currently, the only supported
83             type is C<ipsec.1>.
84              
85             =item *
86              
87             C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
88             the resource. Specify the key of the tag in the filter name and the
89             value of the tag in the filter value. For example, for the tag
90             Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
91             filter value.
92              
93             =item *
94              
95             C<tag-key> - The key of a tag assigned to the resource. This filter is
96             independent of the C<tag-value> filter. For example, if you use both
97             the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
98             resources assigned both the tag key Purpose (regardless of what the
99             tag's value is), and the tag value X (regardless of what the tag's key
100             is). If you want to list only resources where Purpose is X, see the
101             C<tag>:I<key>=I<value> filter.
102              
103             =item *
104              
105             C<tag-value> - The value of a tag assigned to the resource. This filter
106             is independent of the C<tag-key> filter.
107              
108             =back
109              
110              
111              
112              
113              
114             =head1 SEE ALSO
115              
116             This class forms part of L<Paws>, documenting arguments for method DescribeCustomerGateways in L<Paws::EC2>
117              
118             =head1 BUGS and CONTRIBUTIONS
119              
120             The source code is located here: https://github.com/pplu/aws-sdk-perl
121              
122             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
123              
124             =cut
125