com.amazonaws.services.ec2.model

Class DescribeVpnConnectionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVpnConnectionsRequest>, Serializable

public class DescribeVpnConnectionsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeVpnConnectionsRequest>

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

Constructors

Constructor and Description
DescribeVpnConnectionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeVpnConnectionsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() A list of filters used to match properties for VPN Connections.
List<String>	getVpnConnectionIds() A VPN connection ID.
int	hashCode()
void	setFilters(Collection<Filter> filters) A list of filters used to match properties for VPN Connections.
void	setVpnConnectionIds(Collection<String> vpnConnectionIds) A VPN connection ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVpnConnectionsRequest	withFilters(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(Collection<String> vpnConnectionIds) A VPN connection ID.
DescribeVpnConnectionsRequest	withVpnConnectionIds(String... vpnConnectionIds) A VPN connection ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVpnConnectionsRequest

public DescribeVpnConnectionsRequest()

Method Detail

getVpnConnectionIds

public List<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(Collection<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(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.

Returns:

A reference to this updated object so that method calls can be chained together.

withVpnConnectionIds

public DescribeVpnConnectionsRequest withVpnConnectionIds(Collection<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.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public 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(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.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeVpnConnectionsRequest withFilters(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.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeVpnConnectionsRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeVpnConnectionsRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object