software.amazon.awssdk.services.ec2.model

Class DescribeVpnGatewaysRequest

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.DescribeVpnGatewaysRequest

All Implemented Interfaces:

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

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

Contains the parameters for DescribeVpnGateways.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeVpnGatewaysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeVpnGatewaysRequest.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 DescribeVpnGatewaysRequest.Builder>	serializableBuilderClass()
DescribeVpnGatewaysRequest.Builder	toBuilder()
String	toString()
List<String>	vpnGatewayIds() One or more virtual private gateway 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.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

• 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 virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

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

Returns:

One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

• 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 virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

vpnGatewayIds

public List<String> vpnGatewayIds()

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

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

Returns:

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

toBuilder

public DescribeVpnGatewaysRequest.Builder toBuilder()

Specified by:

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

Specified by:

toBuilder in class EC2Request

builder

public static DescribeVpnGatewaysRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeVpnGatewaysRequest.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