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

  • Method Details

    • 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 the isEmpty() 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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 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.

      • 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 key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA 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 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.

      • 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 the isEmpty() 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 is UnauthorizedOperation.

      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 is UnauthorizedOperation.
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeVpnConnectionsRequest.Builder,DescribeVpnConnectionsRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T
    • builder

      public static DescribeVpnConnectionsRequest.Builder builder()
    • serializableBuilderClass

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

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.