TunnelOption (AWS Java SDK :: Services :: Amazon EC2 2.10.22 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()`
`Integer`	`dpdTimeoutSeconds()` The number of seconds after which a DPD timeout occurs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<IKEVersionsListValue>`	`ikeVersions()` The IKE versions that are permitted for the VPN tunnel.
`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 AWS 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()`
`TunnelOption.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`tunnelInsideCidr()` The range of inside IP 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 String outsideIpAddress()
```
    The external IP address of the VPN tunnel.
    
    Returns:
    
    The external IP address of the VPN tunnel.
  - tunnelInsideCidr
```
public String tunnelInsideCidr()
```
    The range of inside IP addresses for the tunnel.
    
    Returns:
    
    The range of inside IP addresses for the tunnel.
  - preSharedKey
```
public 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 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 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 Integer rekeyMarginTimeSeconds()
```
    The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
    
    Returns:
    
    The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.
  - rekeyFuzzPercentage
```
public 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 Integer replayWindowSize()
```
    The number of packets in an IKE replay window.
    
    Returns:
    
    The number of packets in an IKE replay window.
  - dpdTimeoutSeconds
```
public Integer dpdTimeoutSeconds()
```
    The number of seconds after which a DPD timeout occurs.
    
    Returns:
    
    The number of seconds after which a DPD timeout occurs.
  - phase1EncryptionAlgorithms
```
public 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.
    
    Returns:
    
    The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
  - phase2EncryptionAlgorithms
```
public 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.
    
    Returns:
    
    The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
  - phase1IntegrityAlgorithms
```
public 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.
    
    Returns:
    
    The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
  - phase2IntegrityAlgorithms
```
public 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.
    
    Returns:
    
    The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
  - phase1DHGroupNumbers
```
public 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.
    
    Returns:
    
    The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
  - phase2DHGroupNumbers
```
public 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.
    
    Returns:
    
    The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
  - ikeVersions
```
public 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.
    
    Returns:
    
    The IKE versions that are permitted for the VPN tunnel.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

preSharedKey

phase1LifetimeSeconds

phase2LifetimeSeconds

rekeyMarginTimeSeconds

rekeyFuzzPercentage

replayWindowSize

dpdTimeoutSeconds

phase1EncryptionAlgorithms

phase2EncryptionAlgorithms

phase1IntegrityAlgorithms

phase2IntegrityAlgorithms

phase1DHGroupNumbers

phase2DHGroupNumbers

ikeVersions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields