Gives you information about your VPN gateways.
Declaration Syntax| C# |
public class DescribeVpnGatewaysRequest : EC2Request
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DescribeVpnGatewaysRequest()()()() | Initializes a new instance of the DescribeVpnGatewaysRequest class |
| Equals(Object) | (Inherited from Object.) |
 | Filter |
The filter to apply on the results of DescribeVpnGateways.
Filters can be:
a. state - The state of the VPN gateway. (pending, available, deleting, deleted).
b. type - The type of VPN gateway. Currently the only supported type is ipsec.1.
c. availabilityZone - The Availability Zone the VPN gateway is in.
|
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| IsSetFilter()()()() |
Checks if Filter property is set
|
| IsSetVpnGatewayId()()()() |
Checks if VpnGatewayId property is set
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| VpnGatewayId |
One or more VPN gateway IDs.
|
| WithFilter(array<Filter>[]()[][]) | Obsolete.
Sets the filter to apply on the results of DescribeVpnGateways.
|
| WithVpnGatewayId(array<String>[]()[][]) | Obsolete.
Sets VPN gateway IDs.
|
Remarks
You can filter the results to return information
only about VPN gateways that match criteria you specify. For example,
you could ask to get information about a particular VPN gateway (or all) only
if the gateway's state is pending or available. You can specify
multiple filters (e.g., the VPN gateway is in a particular
Availability Zone and the gateway's state is pending or available).
The result includes information for a particular VPN gateway only if
the gateway matches all your filters. If there's no match, no
special message is returned; the response is simply empty.
The returned information consists of:
1. The VPN gateway ID - The current state of the VPN gateway
(pending, available, deleting, deleted)
2. The type of VPN connection the VPN gateway supports.
3. The Availability Zone where the VPN gateway was created.
4. The VPCs the VPN gateway is attached to and the state of each
attachment (attaching, attached, detaching, detached)
Inheritance Hierarchy| Object | ||
 | EC2Request | |
| DescribeVpnGatewaysRequest | |