software.amazon.awssdk.services.ec2.model

Class DescribeVpnConnectionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.core.AwsRequest

software.amazon.awssdk.services.ec2.model.EC2Request

software.amazon.awssdk.services.ec2.model.DescribeVpnConnectionsRequest

All Implemented Interfaces:

software.amazon.awssdk.utils.builder.ToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeVpnConnectionsRequest
extends EC2Request
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>

Contains the parameters for DescribeVpnConnections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeVpnConnectionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeVpnConnectionsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
static Class<? extends DescribeVpnConnectionsRequest.Builder>	serializableBuilderClass()
DescribeVpnConnectionsRequest.Builder	toBuilder()
String	toString()
List<String>	vpnConnectionIds() One or more VPN connection IDs.

Methods inherited from class software.amazon.awssdk.core.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

filters

public List<Filter> filters()

One or more filters.

• customer-gateway-configuration - The configuration information for the customer gateway.

• customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

• state - The state of the VPN connection (pending | available | deleting | deleted).

• option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

• route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

• bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• type - The type of VPN connection. Currently the only supported type is ipsec.1.

• vpn-connection-id - The ID of the VPN connection.

• vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more filters.

• customer-gateway-configuration - The configuration information for the customer gateway.

• customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

• state - The state of the VPN connection (pending | available | deleting | deleted).

• option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

• route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

• bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• type - The type of VPN connection. Currently the only supported type is ipsec.1 .

• vpn-connection-id - The ID of the VPN connection.

• vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

vpnConnectionIds

public List<String> vpnConnectionIds()

One or more VPN connection IDs.

Default: Describes your VPN connections.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

One or more VPN connection IDs.

Default: Describes your VPN connections.

toBuilder

public DescribeVpnConnectionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>

Specified by:

toBuilder in class EC2Request

builder

public static DescribeVpnConnectionsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeVpnConnectionsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest