Class VpnConnectionOptionsSpecification

java.lang.Object
software.amazon.awssdk.services.ec2.model.VpnConnectionOptionsSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<VpnConnectionOptionsSpecification.Builder,VpnConnectionOptionsSpecification>

@Generated("software.amazon.awssdk:codegen") public final class VpnConnectionOptionsSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<VpnConnectionOptionsSpecification.Builder,VpnConnectionOptionsSpecification>

Describes VPN connection options.

See Also:
  • Method Details

    • enableAcceleration

      public final Boolean enableAcceleration()

      Indicate whether to enable acceleration for the VPN connection.

      Default: false

      Returns:
      Indicate whether to enable acceleration for the VPN connection.

      Default: false

    • staticRoutesOnly

      public final Boolean staticRoutesOnly()

      Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

      Default: false

      Returns:
      Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

      Default: false

    • tunnelInsideIpVersion

      public final TunnelInsideIpVersion tunnelInsideIpVersion()

      Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

      Default: ipv4

      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:
      Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

      Default: ipv4

      See Also:
    • tunnelInsideIpVersionAsString

      public final String tunnelInsideIpVersionAsString()

      Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

      Default: ipv4

      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:
      Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

      Default: ipv4

      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<VpnTunnelOptionsSpecification> tunnelOptions()

      The tunnel options for 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 hasTunnelOptions() method.

      Returns:
      The tunnel options for the VPN connection.
    • localIpv4NetworkCidr

      public final String localIpv4NetworkCidr()

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

      Default: 0.0.0.0/0

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

      Default: 0.0.0.0/0

    • remoteIpv4NetworkCidr

      public final String remoteIpv4NetworkCidr()

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

      Default: 0.0.0.0/0

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

      Default: 0.0.0.0/0

    • localIpv6NetworkCidr

      public final String localIpv6NetworkCidr()

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

      Default: ::/0

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

      Default: ::/0

    • remoteIpv6NetworkCidr

      public final String remoteIpv6NetworkCidr()

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

      Default: ::/0

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

      Default: ::/0

    • outsideIpAddressType

      public final String outsideIpAddressType()

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

      Valid values: PrivateIpv4 | PublicIpv4

      Default: PublicIpv4

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

      Valid values: PrivateIpv4 | PublicIpv4

      Default: PublicIpv4

    • transportTransitGatewayAttachmentId

      public final String transportTransitGatewayAttachmentId()

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

      Required if OutsideIpAddressType is set to PrivateIpv4.

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

      Required if OutsideIpAddressType is set to PrivateIpv4.

    • 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<VpnConnectionOptionsSpecification.Builder,VpnConnectionOptionsSpecification>
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends VpnConnectionOptionsSpecification.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)
      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)
    • 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.