« blib/lib/Paws/EC2/DescribeVpcsResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeVpnConnectionsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeVpnConnections; | ||
| 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 VpnConnectionIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'VpnConnectionId' ); | |
| 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 => 'DescribeVpnConnections'); | |
| 11 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeVpnConnectionsResult'); | |
| 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::DescribeVpnConnections - Arguments for method DescribeVpnConnections on L<Paws::EC2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeVpnConnections on the | ||
| 24 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeVpnConnections. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeVpnConnections. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ec2 = Paws->service('EC2'); | ||
| 32 | my $DescribeVpnConnectionsResult = $ec2->DescribeVpnConnections( | ||
| 33 | DryRun => 1, # OPTIONAL | ||
| 34 | Filters => [ | ||
| 35 | { | ||
| 36 | Name => 'MyString', # OPTIONAL | ||
| 37 | Values => [ | ||
| 38 | 'MyString', ... # OPTIONAL | ||
| 39 | ], # OPTIONAL | ||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], # OPTIONAL | ||
| 43 | VpnConnectionIds => [ 'MyVpnConnectionId', ... ], # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $VpnConnections = $DescribeVpnConnectionsResult->VpnConnections; | ||
| 48 | |||
| 49 | # Returns a L<Paws::EC2::DescribeVpnConnectionsResult> 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/DescribeVpnConnections> | ||
| 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<customer-gateway-configuration> - The configuration information for | ||
| 75 | the customer gateway. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<customer-gateway-id> - The ID of a customer gateway associated with | ||
| 80 | the VPN connection. | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<state> - The state of the VPN connection (C<pending> | C<available> | | ||
| 85 | C<deleting> | C<deleted>). | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<option.static-routes-only> - Indicates whether the connection has | ||
| 90 | static routes only. Used for devices that do not support Border Gateway | ||
| 91 | Protocol (BGP). | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<route.destination-cidr-block> - The destination CIDR block. This | ||
| 96 | corresponds to the subnet used in a customer data center. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<bgp-asn> - The BGP Autonomous System Number (ASN) associated with a | ||
| 101 | BGP device. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to | ||
| 106 | the resource. Use the tag key in the filter name and the tag value as | ||
| 107 | the filter value. For example, to find all resources that have a tag | ||
| 108 | with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for | ||
| 109 | the filter name and C<TeamA> for the filter value. | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<tag-key> - The key of a tag assigned to the resource. Use this filter | ||
| 114 | to find all resources assigned a tag with a specific key, regardless of | ||
| 115 | the tag value. | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<type> - The type of VPN connection. Currently the only supported type | ||
| 120 | is C<ipsec.1>. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | C<vpn-connection-id> - The ID of the VPN connection. | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | C<vpn-gateway-id> - The ID of a virtual private gateway associated with | ||
| 129 | the VPN connection. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | C<transit-gateway-id> - The ID of a transit gateway associated with the | ||
| 134 | VPN connection. | ||
| 135 | |||
| 136 | =back | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 VpnConnectionIds => ArrayRef[Str|Undef] | ||
| 142 | |||
| 143 | One or more VPN connection IDs. | ||
| 144 | |||
| 145 | Default: Describes your VPN connections. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method DescribeVpnConnections in L<Paws::EC2> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 | |||