Class DescribeVpnConnectionsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeVpnConnectionsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeVpnConnectionsRequest extends Ec2Request implements ToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>
Contains the parameters for DescribeVpnConnections.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeVpnConnectionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeVpnConnectionsRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
One or more filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasVpnConnectionIds()
For responses, this returns true if the service returned a value for the VpnConnectionIds property.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeVpnConnectionsRequest.Builder>
serializableBuilderClass()
DescribeVpnConnectionsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.List<String>
vpnConnectionIds()
One or more VPN connection IDs.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final 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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of VPN connection. Currently the only supported type isipsec.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. -
transit-gateway-id
- The ID of a transit gateway associated with the VPN connection.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- 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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
type
- The type of VPN connection. Currently the only supported type isipsec.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. -
transit-gateway-id
- The ID of a transit gateway associated with the VPN connection.
-
-
-
hasVpnConnectionIds
public final boolean hasVpnConnectionIds()
For responses, this returns true if the service returned a value for the VpnConnectionIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
vpnConnectionIds
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVpnConnectionIds()
method.- Returns:
- One or more VPN connection IDs.
Default: Describes your VPN connections.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
public DescribeVpnConnectionsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeVpnConnectionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeVpnConnectionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-