Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.ec2.model
Class DescribeVpnConnectionsRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest
All Implemented Interfaces:
java.io.Serializable

public class DescribeVpnConnectionsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Container for the parameters to the DescribeVpnConnections operation.

Gives you information about your VPN connections.

IMPORTANT: We strongly recommend you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway. You can filter the results to return information only about VPN connections that match criteria you specify. For example, you could ask to get information about a particular VPN connection (or all) only if the VPN's state is pending or available. You can specify multiple filters (e.g., the VPN connection is associated with a particular VPN gateway, and the gateway's state is pending or available). The result includes information for a particular VPN connection only if the VPN connection matches all your filters. If there's no match, no special message is returned; the response is simply empty. The following table shows the available filters.

See Also:
AmazonEC2.describeVpnConnections(DescribeVpnConnectionsRequest), Serialized Form

Constructor Summary
DescribeVpnConnectionsRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.util.List<Filter> getFilters()
          A list of filters used to match properties for VPN Connections.
 java.util.List<java.lang.String> getVpnConnectionIds()
          A VPN connection ID.
 int hashCode()
           
 void setFilters(java.util.Collection<Filter> filters)
          A list of filters used to match properties for VPN Connections.
 void setVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
          A VPN connection ID.
 java.lang.String toString()
          Returns a string representation of this object; useful for testing and debugging.
 DescribeVpnConnectionsRequest withFilters(java.util.Collection<Filter> filters)
          A list of filters used to match properties for VPN Connections.
 DescribeVpnConnectionsRequest withFilters(Filter... filters)
          A list of filters used to match properties for VPN Connections.
 DescribeVpnConnectionsRequest withVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
          A VPN connection ID.
 DescribeVpnConnectionsRequest withVpnConnectionIds(java.lang.String... vpnConnectionIds)
          A VPN connection ID.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DescribeVpnConnectionsRequest

public DescribeVpnConnectionsRequest()
Method Detail

getVpnConnectionIds

public java.util.List<java.lang.String> getVpnConnectionIds()
A VPN connection ID. More than one may be specified per request.

Returns:
A VPN connection ID. More than one may be specified per request.

setVpnConnectionIds

public void setVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
A VPN connection ID. More than one may be specified per request.

Parameters:
vpnConnectionIds - A VPN connection ID. More than one may be specified per request.

withVpnConnectionIds

public DescribeVpnConnectionsRequest withVpnConnectionIds(java.lang.String... vpnConnectionIds)
A VPN connection ID. More than one may be specified per request.

Returns a reference to this object so that method calls can be chained together.

Parameters:
vpnConnectionIds - A VPN connection ID. More than one may be specified per request.

withVpnConnectionIds

public DescribeVpnConnectionsRequest withVpnConnectionIds(java.util.Collection<java.lang.String> vpnConnectionIds)
A VPN connection ID. More than one may be specified per request.

Returns a reference to this object so that method calls can be chained together.

Parameters:
vpnConnectionIds - A VPN connection ID. More than one may be specified per request.

getFilters

public java.util.List<Filter> getFilters()
A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns:
A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

setFilters

public void setFilters(java.util.Collection<Filter> filters)
A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Parameters:
filters - A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeVpnConnectionsRequest withFilters(Filter... filters)
A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:
filters - A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

withFilters

public DescribeVpnConnectionsRequest withFilters(java.util.Collection<Filter> filters)
A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

Returns a reference to this object so that method calls can be chained together.

Parameters:
filters - A list of filters used to match properties for VPN Connections. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

toString

public java.lang.String toString()
Returns a string representation of this object; useful for testing and debugging.

Overrides:
toString in class java.lang.Object
Returns:
A string representation of this object.
See Also:
Object.toString()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.