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

Interface VpnTunnelOptionsSpecification.Builder

    • Method Detail

      • tunnelInsideCidr

        VpnTunnelOptionsSpecification.Builder tunnelInsideCidr​(String tunnelInsideCidr)

        The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.

        Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:

        • 169.254.0.0/30

        • 169.254.1.0/30

        • 169.254.2.0/30

        • 169.254.3.0/30

        • 169.254.4.0/30

        • 169.254.5.0/30

        • 169.254.169.252/30

        Parameters:
        tunnelInsideCidr - The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.

        Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:

        • 169.254.0.0/30

        • 169.254.1.0/30

        • 169.254.2.0/30

        • 169.254.3.0/30

        • 169.254.4.0/30

        • 169.254.5.0/30

        • 169.254.169.252/30

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tunnelInsideIpv6Cidr

        VpnTunnelOptionsSpecification.Builder tunnelInsideIpv6Cidr​(String tunnelInsideIpv6Cidr)

        The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.

        Constraints: A size /126 CIDR block from the local fd00::/8 range.

        Parameters:
        tunnelInsideIpv6Cidr - The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.

        Constraints: A size /126 CIDR block from the local fd00::/8 range.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preSharedKey

        VpnTunnelOptionsSpecification.Builder preSharedKey​(String preSharedKey)

        The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.

        Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).

        Parameters:
        preSharedKey - The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.

        Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1LifetimeSeconds

        VpnTunnelOptionsSpecification.Builder phase1LifetimeSeconds​(Integer phase1LifetimeSeconds)

        The lifetime for phase 1 of the IKE negotiation, in seconds.

        Constraints: A value between 900 and 28,800.

        Default: 28800

        Parameters:
        phase1LifetimeSeconds - The lifetime for phase 1 of the IKE negotiation, in seconds.

        Constraints: A value between 900 and 28,800.

        Default: 28800

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2LifetimeSeconds

        VpnTunnelOptionsSpecification.Builder phase2LifetimeSeconds​(Integer phase2LifetimeSeconds)

        The lifetime for phase 2 of the IKE negotiation, in seconds.

        Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

        Default: 3600

        Parameters:
        phase2LifetimeSeconds - The lifetime for phase 2 of the IKE negotiation, in seconds.

        Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

        Default: 3600

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rekeyMarginTimeSeconds

        VpnTunnelOptionsSpecification.Builder rekeyMarginTimeSeconds​(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. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

        Constraints: A value between 60 and half of Phase2LifetimeSeconds.

        Default: 270

        Parameters:
        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. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

        Constraints: A value between 60 and half of Phase2LifetimeSeconds.

        Default: 270

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • rekeyFuzzPercentage

        VpnTunnelOptionsSpecification.Builder rekeyFuzzPercentage​(Integer rekeyFuzzPercentage)

        The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

        Constraints: A value between 0 and 100.

        Default: 100

        Parameters:
        rekeyFuzzPercentage - The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

        Constraints: A value between 0 and 100.

        Default: 100

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replayWindowSize

        VpnTunnelOptionsSpecification.Builder replayWindowSize​(Integer replayWindowSize)

        The number of packets in an IKE replay window.

        Constraints: A value between 64 and 2048.

        Default: 1024

        Parameters:
        replayWindowSize - The number of packets in an IKE replay window.

        Constraints: A value between 64 and 2048.

        Default: 1024

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dpdTimeoutSeconds

        VpnTunnelOptionsSpecification.Builder dpdTimeoutSeconds​(Integer dpdTimeoutSeconds)

        The number of seconds after which a DPD timeout occurs.

        Constraints: A value greater than or equal to 30.

        Default: 30

        Parameters:
        dpdTimeoutSeconds - The number of seconds after which a DPD timeout occurs.

        Constraints: A value greater than or equal to 30.

        Default: 30

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dpdTimeoutAction

        VpnTunnelOptionsSpecification.Builder dpdTimeoutAction​(String dpdTimeoutAction)

        The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

        Valid Values: clear | none | restart

        Default: clear

        Parameters:
        dpdTimeoutAction - The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.

        Valid Values: clear | none | restart

        Default: clear

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1EncryptionAlgorithms

        VpnTunnelOptionsSpecification.Builder phase1EncryptionAlgorithms​(Collection<Phase1EncryptionAlgorithmsRequestListValue> phase1EncryptionAlgorithms)

        One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Parameters:
        phase1EncryptionAlgorithms - One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1EncryptionAlgorithms

        VpnTunnelOptionsSpecification.Builder phase1EncryptionAlgorithms​(Phase1EncryptionAlgorithmsRequestListValue... phase1EncryptionAlgorithms)

        One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Parameters:
        phase1EncryptionAlgorithms - One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2EncryptionAlgorithms

        VpnTunnelOptionsSpecification.Builder phase2EncryptionAlgorithms​(Collection<Phase2EncryptionAlgorithmsRequestListValue> phase2EncryptionAlgorithms)

        One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Parameters:
        phase2EncryptionAlgorithms - One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2EncryptionAlgorithms

        VpnTunnelOptionsSpecification.Builder phase2EncryptionAlgorithms​(Phase2EncryptionAlgorithmsRequestListValue... phase2EncryptionAlgorithms)

        One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Parameters:
        phase2EncryptionAlgorithms - One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1IntegrityAlgorithms

        VpnTunnelOptionsSpecification.Builder phase1IntegrityAlgorithms​(Collection<Phase1IntegrityAlgorithmsRequestListValue> phase1IntegrityAlgorithms)

        One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Parameters:
        phase1IntegrityAlgorithms - One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1IntegrityAlgorithms

        VpnTunnelOptionsSpecification.Builder phase1IntegrityAlgorithms​(Phase1IntegrityAlgorithmsRequestListValue... phase1IntegrityAlgorithms)

        One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Parameters:
        phase1IntegrityAlgorithms - One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2IntegrityAlgorithms

        VpnTunnelOptionsSpecification.Builder phase2IntegrityAlgorithms​(Collection<Phase2IntegrityAlgorithmsRequestListValue> phase2IntegrityAlgorithms)

        One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Parameters:
        phase2IntegrityAlgorithms - One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2IntegrityAlgorithms

        VpnTunnelOptionsSpecification.Builder phase2IntegrityAlgorithms​(Phase2IntegrityAlgorithmsRequestListValue... phase2IntegrityAlgorithms)

        One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Parameters:
        phase2IntegrityAlgorithms - One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1DHGroupNumbers

        VpnTunnelOptionsSpecification.Builder phase1DHGroupNumbers​(Collection<Phase1DHGroupNumbersRequestListValue> phase1DHGroupNumbers)

        One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Parameters:
        phase1DHGroupNumbers - One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase1DHGroupNumbers

        VpnTunnelOptionsSpecification.Builder phase1DHGroupNumbers​(Phase1DHGroupNumbersRequestListValue... phase1DHGroupNumbers)

        One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Parameters:
        phase1DHGroupNumbers - One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

        Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2DHGroupNumbers

        VpnTunnelOptionsSpecification.Builder phase2DHGroupNumbers​(Collection<Phase2DHGroupNumbersRequestListValue> phase2DHGroupNumbers)

        One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Parameters:
        phase2DHGroupNumbers - One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phase2DHGroupNumbers

        VpnTunnelOptionsSpecification.Builder phase2DHGroupNumbers​(Phase2DHGroupNumbersRequestListValue... phase2DHGroupNumbers)

        One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Parameters:
        phase2DHGroupNumbers - One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

        Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ikeVersions

        VpnTunnelOptionsSpecification.Builder ikeVersions​(Collection<IKEVersionsRequestListValue> ikeVersions)

        The IKE versions that are permitted for the VPN tunnel.

        Valid values: ikev1 | ikev2

        Parameters:
        ikeVersions - The IKE versions that are permitted for the VPN tunnel.

        Valid values: ikev1 | ikev2

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ikeVersions

        VpnTunnelOptionsSpecification.Builder ikeVersions​(IKEVersionsRequestListValue... ikeVersions)

        The IKE versions that are permitted for the VPN tunnel.

        Valid values: ikev1 | ikev2

        Parameters:
        ikeVersions - The IKE versions that are permitted for the VPN tunnel.

        Valid values: ikev1 | ikev2

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startupAction

        VpnTunnelOptionsSpecification.Builder startupAction​(String startupAction)

        The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.

        Valid Values: add | start

        Default: add

        Parameters:
        startupAction - The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.

        Valid Values: add | start

        Default: add

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableTunnelLifecycleControl

        VpnTunnelOptionsSpecification.Builder enableTunnelLifecycleControl​(Boolean enableTunnelLifecycleControl)

        Turn on or off tunnel endpoint lifecycle control feature.

        Parameters:
        enableTunnelLifecycleControl - Turn on or off tunnel endpoint lifecycle control feature.
        Returns:
        Returns a reference to this object so that method calls can be chained together.