Package software.amazon.awssdk.services.ec2.model

Class VpnConnectionOptions

java.lang.Object
software.amazon.awssdk.services.ec2.model.VpnConnectionOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VpnConnectionOptions.Builder,VpnConnectionOptions>
@Generated("software.amazon.awssdk:codegen") public final class VpnConnectionOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpnConnectionOptions.Builder,VpnConnectionOptions>

Describes VPN connection options.

See Also:

  • Method Details

    • enableAcceleration

      public final Boolean enableAcceleration()

      Indicates whether acceleration is enabled for the VPN connection.

      Returns:
      Indicates whether acceleration is enabled for the VPN connection.

    • staticRoutesOnly

      public final Boolean staticRoutesOnly()

      Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

      Returns:
      Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

    • localIpv4NetworkCidr

      public final String localIpv4NetworkCidr()

      The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

      Returns:
      The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

    • remoteIpv4NetworkCidr

      public final String remoteIpv4NetworkCidr()

      The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

      Returns:
      The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

    • localIpv6NetworkCidr

      public final String localIpv6NetworkCidr()

      The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

      Returns:
      The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

    • remoteIpv6NetworkCidr

      public final String remoteIpv6NetworkCidr()

      The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

      Returns:
      The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

    • outsideIpAddressType

      public final String outsideIpAddressType()

      The type of IPv4 address assigned to the outside interface of the customer gateway.

      Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

      Default: PublicIpv4

      Returns:
      The type of IPv4 address assigned to the outside interface of the customer gateway.

      Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

      Default: PublicIpv4

    • transportTransitGatewayAttachmentId

      public final String transportTransitGatewayAttachmentId()

      The transit gateway attachment ID in use for the VPN tunnel.

      Returns:
      The transit gateway attachment ID in use for the VPN tunnel.

    • tunnelInsideIpVersion

      public final TunnelInsideIpVersion tunnelInsideIpVersion()

      Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

      If the service returns an enum value that is not available in the current SDK version, tunnelInsideIpVersion will return TunnelInsideIpVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tunnelInsideIpVersionAsString().

      Returns:
      Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
      See Also:

    • tunnelInsideIpVersionAsString

      public final String tunnelInsideIpVersionAsString()

      Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.

      If the service returns an enum value that is not available in the current SDK version, tunnelInsideIpVersion will return TunnelInsideIpVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tunnelInsideIpVersionAsString().

      Returns:
      Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.
      See Also:

    • hasTunnelOptions

      public final boolean hasTunnelOptions()
      For responses, this returns true if the service returned a value for the TunnelOptions 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.

    • tunnelOptions

      public final List<TunnelOption> tunnelOptions()

      Indicates the VPN tunnel options.

      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 hasTunnelOptions() method.

      Returns:
      Indicates the VPN tunnel options.

    • tunnelBandwidth

      public final VpnTunnelBandwidth tunnelBandwidth()

      The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.

      If the service returns an enum value that is not available in the current SDK version, tunnelBandwidth will return VpnTunnelBandwidth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tunnelBandwidthAsString().

      Returns:
      The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
      See Also:

    • tunnelBandwidthAsString

      public final String tunnelBandwidthAsString()

      The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.

      If the service returns an enum value that is not available in the current SDK version, tunnelBandwidth will return VpnTunnelBandwidth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tunnelBandwidthAsString().

      Returns:
      The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. standard tunnel bandwidth supports up to 1.25 Gbps per tunnel while large supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, standard is used as the default value.
      See Also:

    • toBuilder

      public VpnConnectionOptions.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<VpnConnectionOptions.Builder,VpnConnectionOptions>

    • builder

      public static VpnConnectionOptions.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo