TunnelOption (AWS Java SDK :: Services :: Amazon EC2 2.20.53 API)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.TunnelOption

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TunnelOption.Builder,TunnelOption>

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

The VPN tunnel options.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TunnelOption.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TunnelOption.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TunnelOption.Builder`	`builder()`
`String`	`dpdTimeoutAction()` The action to take after a DPD timeout occurs.
`Integer`	`dpdTimeoutSeconds()` The number of seconds after which a DPD timeout occurs.
`Boolean`	`enableTunnelLifecycleControl()` Status of tunnel endpoint lifecycle control feature.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIkeVersions()` For responses, this returns true if the service returned a value for the IkeVersions property.
`boolean`	`hasPhase1DHGroupNumbers()` For responses, this returns true if the service returned a value for the Phase1DHGroupNumbers property.
`boolean`	`hasPhase1EncryptionAlgorithms()` For responses, this returns true if the service returned a value for the Phase1EncryptionAlgorithms property.
`boolean`	`hasPhase1IntegrityAlgorithms()` For responses, this returns true if the service returned a value for the Phase1IntegrityAlgorithms property.
`boolean`	`hasPhase2DHGroupNumbers()` For responses, this returns true if the service returned a value for the Phase2DHGroupNumbers property.
`boolean`	`hasPhase2EncryptionAlgorithms()` For responses, this returns true if the service returned a value for the Phase2EncryptionAlgorithms property.
`boolean`	`hasPhase2IntegrityAlgorithms()` For responses, this returns true if the service returned a value for the Phase2IntegrityAlgorithms property.
`List<IKEVersionsListValue>`	`ikeVersions()` The IKE versions that are permitted for the VPN tunnel.
`VpnTunnelLogOptions`	`logOptions()` Options for logging VPN tunnel activity.
`String`	`outsideIpAddress()` The external IP address of the VPN tunnel.
`List<Phase1DHGroupNumbersListValue>`	`phase1DHGroupNumbers()` The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
`List<Phase1EncryptionAlgorithmsListValue>`	`phase1EncryptionAlgorithms()` The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
`List<Phase1IntegrityAlgorithmsListValue>`	`phase1IntegrityAlgorithms()` The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
`Integer`	`phase1LifetimeSeconds()` The lifetime for phase 1 of the IKE negotiation, in seconds.
`List<Phase2DHGroupNumbersListValue>`	`phase2DHGroupNumbers()` The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
`List<Phase2EncryptionAlgorithmsListValue>`	`phase2EncryptionAlgorithms()` The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
`List<Phase2IntegrityAlgorithmsListValue>`	`phase2IntegrityAlgorithms()` The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
`Integer`	`phase2LifetimeSeconds()` The lifetime for phase 2 of the IKE negotiation, in seconds.
`String`	`preSharedKey()` The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
`Integer`	`rekeyFuzzPercentage()` The percentage of the rekey window determined by `RekeyMarginTimeSeconds` during which the rekey time is randomly selected.
`Integer`	`rekeyMarginTimeSeconds()` The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
`Integer`	`replayWindowSize()` The number of packets in an IKE replay window.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TunnelOption.Builder>`	`serializableBuilderClass()`
`String`	`startupAction()` The action to take when the establishing the VPN tunnels for a VPN connection.
`TunnelOption.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`tunnelInsideCidr()` The range of inside IPv4 addresses for the tunnel.
`String`	`tunnelInsideIpv6Cidr()` The range of inside IPv6 addresses for the tunnel.

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
  - outsideIpAddress
```
public final String outsideIpAddress()
```
    The external IP address of the VPN tunnel.
    
    Returns:
    
    The external IP address of the VPN tunnel.
  - tunnelInsideCidr
```
public final String tunnelInsideCidr()
```
    The range of inside IPv4 addresses for the tunnel.
    
    Returns:
    
    The range of inside IPv4 addresses for the tunnel.
  - tunnelInsideIpv6Cidr
```
public final String tunnelInsideIpv6Cidr()
```
    The range of inside IPv6 addresses for the tunnel.
    
    Returns:
    
    The range of inside IPv6 addresses for the tunnel.
  - preSharedKey
```
public final String preSharedKey()
```
    The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
    
    Returns:
    
    The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
  - phase1LifetimeSeconds
```
public final Integer phase1LifetimeSeconds()
```
    The lifetime for phase 1 of the IKE negotiation, in seconds.
    
    Returns:
    
    The lifetime for phase 1 of the IKE negotiation, in seconds.
  - phase2LifetimeSeconds
```
public final Integer phase2LifetimeSeconds()
```
    The lifetime for phase 2 of the IKE negotiation, in seconds.
    
    Returns:
    
    The lifetime for phase 2 of the IKE negotiation, in seconds.
  - rekeyMarginTimeSeconds
```
public final Integer rekeyMarginTimeSeconds()
```
    The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
    
    Returns:
    
    The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
  - rekeyFuzzPercentage
```
public final Integer rekeyFuzzPercentage()
```
    The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
    
    Returns:
    
    The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
  - replayWindowSize
```
public final Integer replayWindowSize()
```
    The number of packets in an IKE replay window.
    
    Returns:
    
    The number of packets in an IKE replay window.
  - dpdTimeoutSeconds
```
public final Integer dpdTimeoutSeconds()
```
    The number of seconds after which a DPD timeout occurs.
    
    Returns:
    
    The number of seconds after which a DPD timeout occurs.
  - dpdTimeoutAction
```
public final String dpdTimeoutAction()
```
    The action to take after a DPD timeout occurs.
    
    Returns:
    
    The action to take after a DPD timeout occurs.
  - hasPhase1EncryptionAlgorithms
```
public final boolean hasPhase1EncryptionAlgorithms()
```
    For responses, this returns true if the service returned a value for the Phase1EncryptionAlgorithms 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.
  - phase1EncryptionAlgorithms
```
public final List<Phase1EncryptionAlgorithmsListValue> phase1EncryptionAlgorithms()
```
    The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
    
    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 hasPhase1EncryptionAlgorithms() method.
    
    Returns:
    
    The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
  - hasPhase2EncryptionAlgorithms
```
public final boolean hasPhase2EncryptionAlgorithms()
```
    For responses, this returns true if the service returned a value for the Phase2EncryptionAlgorithms 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.
  - phase2EncryptionAlgorithms
```
public final List<Phase2EncryptionAlgorithmsListValue> phase2EncryptionAlgorithms()
```
    The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
    
    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 hasPhase2EncryptionAlgorithms() method.
    
    Returns:
    
    The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
  - hasPhase1IntegrityAlgorithms
```
public final boolean hasPhase1IntegrityAlgorithms()
```
    For responses, this returns true if the service returned a value for the Phase1IntegrityAlgorithms 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.
  - phase1IntegrityAlgorithms
```
public final List<Phase1IntegrityAlgorithmsListValue> phase1IntegrityAlgorithms()
```
    The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
    
    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 hasPhase1IntegrityAlgorithms() method.
    
    Returns:
    
    The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
  - hasPhase2IntegrityAlgorithms
```
public final boolean hasPhase2IntegrityAlgorithms()
```
    For responses, this returns true if the service returned a value for the Phase2IntegrityAlgorithms 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.
  - phase2IntegrityAlgorithms
```
public final List<Phase2IntegrityAlgorithmsListValue> phase2IntegrityAlgorithms()
```
    The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
    
    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 hasPhase2IntegrityAlgorithms() method.
    
    Returns:
    
    The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
  - hasPhase1DHGroupNumbers
```
public final boolean hasPhase1DHGroupNumbers()
```
    For responses, this returns true if the service returned a value for the Phase1DHGroupNumbers 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.
  - phase1DHGroupNumbers
```
public final List<Phase1DHGroupNumbersListValue> phase1DHGroupNumbers()
```
    The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
    
    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 hasPhase1DHGroupNumbers() method.
    
    Returns:
    
    The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
  - hasPhase2DHGroupNumbers
```
public final boolean hasPhase2DHGroupNumbers()
```
    For responses, this returns true if the service returned a value for the Phase2DHGroupNumbers 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.
  - phase2DHGroupNumbers
```
public final List<Phase2DHGroupNumbersListValue> phase2DHGroupNumbers()
```
    The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
    
    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 hasPhase2DHGroupNumbers() method.
    
    Returns:
    
    The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
  - hasIkeVersions
```
public final boolean hasIkeVersions()
```
    For responses, this returns true if the service returned a value for the IkeVersions 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.
  - ikeVersions
```
public final List<IKEVersionsListValue> ikeVersions()
```
    The IKE versions that are permitted for the VPN tunnel.
    
    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 hasIkeVersions() method.
    
    Returns:
    
    The IKE versions that are permitted for the VPN tunnel.
  - startupAction
```
public final String startupAction()
```
    The action to take when the establishing the VPN tunnels for a VPN connection.
    
    Returns:
    
    The action to take when the establishing the VPN tunnels for a VPN connection.
  - logOptions
```
public final VpnTunnelLogOptions logOptions()
```
    Options for logging VPN tunnel activity.
    
    Returns:
    
    Options for logging VPN tunnel activity.
  - enableTunnelLifecycleControl
```
public final Boolean enableTunnelLifecycleControl()
```
    Status of tunnel endpoint lifecycle control feature.
    
    Returns:
    
    Status of tunnel endpoint lifecycle control feature.
  - toBuilder
```
public TunnelOption.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TunnelOption.Builder,TunnelOption>
  - builder
```
public static TunnelOption.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TunnelOption.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

Class TunnelOption

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

outsideIpAddress

tunnelInsideCidr

tunnelInsideIpv6Cidr

preSharedKey

phase1LifetimeSeconds

phase2LifetimeSeconds

rekeyMarginTimeSeconds

rekeyFuzzPercentage

replayWindowSize

dpdTimeoutSeconds

dpdTimeoutAction

hasPhase1EncryptionAlgorithms

phase1EncryptionAlgorithms

hasPhase2EncryptionAlgorithms

phase2EncryptionAlgorithms

hasPhase1IntegrityAlgorithms

phase1IntegrityAlgorithms

hasPhase2IntegrityAlgorithms

phase2IntegrityAlgorithms

hasPhase1DHGroupNumbers

phase1DHGroupNumbers

hasPhase2DHGroupNumbers

phase2DHGroupNumbers

hasIkeVersions

ikeVersions

startupAction

logOptions

enableTunnelLifecycleControl

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields