blib/lib/Paws/EC2/DescribeVpnGateways.pm

filter: Statementstmt 100% 13 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 15 / 15 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeVpnConnectionsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeVpnGatewaysResult.pm »
1  
2 package Paws::EC2::DescribeVpnGateways;
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 VpnGatewayIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'VpnGatewayId' );
7  
8 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeVpnGateways');
11 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeVpnGatewaysResult');
12 1 class_has _result_key => (isa => 'Str', is => 'ro');
13 1 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::EC2::DescribeVpnGateways - Arguments for method DescribeVpnGateways on L<Paws::EC2>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method DescribeVpnGateways on the
24 L<Amazon Elastic Compute Cloud|Paws::EC2> 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 =head1 SYNOPSIS
30  
31 my $ec2 = Paws->service('EC2');
32 my $DescribeVpnGatewaysResult = $ec2->DescribeVpnGateways(
33 DryRun => 1, # OPTIONAL
34 Filters => [
35 {
36 Name => 'MyString', # OPTIONAL
37 Values => [
38 'MyString', ... # OPTIONAL
39 ], # OPTIONAL
40 },
41 ...
42 ], # OPTIONAL
43 VpnGatewayIds => [ 'MyVpnGatewayId', ... ], # OPTIONAL
44 );
45  
46 # Results:
47 my $VpnGateways = $DescribeVpnGatewaysResult->VpnGateways;
48  
49 # Returns a L<Paws::EC2::DescribeVpnGatewaysResult> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeVpnGateways>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 DryRun => Bool
58  
59 Checks whether you have the required permissions for the action,
60 without actually making the request, and provides an error response. If
61 you have the required permissions, the error response is
62 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
63  
64  
65  
66 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
67  
68 One or more filters.
69  
70 =over
71  
72 =item *
73  
74 C<amazon-side-asn> - The Autonomous System Number (ASN) for the Amazon
75 side of the gateway.
76  
77 =item *
78  
79 C<attachment.state> - The current state of the attachment between the
80 gateway and the VPC (C<attaching> | C<attached> | C<detaching> |
81 C<detached>).
82  
83 =item *
84  
85 C<attachment.vpc-id> - The ID of an attached VPC.
86  
87 =item *
88  
89 C<availability-zone> - The Availability Zone for the virtual private
90 gateway (if applicable).
91  
92 =item *
93  
94 C<state> - The state of the virtual private gateway (C<pending> |
95 C<available> | C<deleting> | C<deleted>).
96  
97 =item *
98  
99 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
100 the resource. Use the tag key in the filter name and the tag value as
101 the filter value. For example, to find all resources that have a tag
102 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
103 the filter name and C<TeamA> for the filter value.
104  
105 =item *
106  
107 C<tag-key> - The key of a tag assigned to the resource. Use this filter
108 to find all resources assigned a tag with a specific key, regardless of
109 the tag value.
110  
111 =item *
112  
113 C<type> - The type of virtual private gateway. Currently the only
114 supported type is C<ipsec.1>.
115  
116 =item *
117  
118 C<vpn-gateway-id> - The ID of the virtual private gateway.
119  
120 =back
121  
122  
123  
124  
125 =head2 VpnGatewayIds => ArrayRef[Str|Undef]
126  
127 One or more virtual private gateway IDs.
128  
129 Default: Describes all your virtual private gateways.
130  
131  
132  
133  
134 =head1 SEE ALSO
135  
136 This class forms part of L<Paws>, documenting arguments for method DescribeVpnGateways in L<Paws::EC2>
137  
138 =head1 BUGS and CONTRIBUTIONS
139  
140 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
141  
142 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
143  
144 =cut
145  
« blib/lib/Paws/EC2/DescribeVpnConnectionsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeVpnGatewaysResult.pm »