You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::VpnTunnelOptionsSpecification

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing VpnTunnelOptionsSpecification as input to an Aws::Client method, you can use a vanilla Hash:

{
  tunnel_inside_cidr: "String",
  tunnel_inside_ipv_6_cidr: "String",
  pre_shared_key: "String",
  phase_1_lifetime_seconds: 1,
  phase_2_lifetime_seconds: 1,
  rekey_margin_time_seconds: 1,
  rekey_fuzz_percentage: 1,
  replay_window_size: 1,
  dpd_timeout_seconds: 1,
  dpd_timeout_action: "String",
  phase_1_encryption_algorithms: [
    {
      value: "String",
    },
  ],
  phase_2_encryption_algorithms: [
    {
      value: "String",
    },
  ],
  phase_1_integrity_algorithms: [
    {
      value: "String",
    },
  ],
  phase_2_integrity_algorithms: [
    {
      value: "String",
    },
  ],
  phase_1_dh_group_numbers: [
    {
      value: 1,
    },
  ],
  phase_2_dh_group_numbers: [
    {
      value: 1,
    },
  ],
  ike_versions: [
    {
      value: "String",
    },
  ],
  startup_action: "String",
}

The tunnel options for a single VPN tunnel.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dpd_timeout_action ⇒ String

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:

  • (String) —

    The action to take after DPD timeout occurs.

#dpd_timeout_seconds ⇒ Integer

The number of seconds after which a DPD timeout occurs.

Constraints: A value between 0 and 30.

Default: 30

Returns:

  • (Integer) —

    The number of seconds after which a DPD timeout occurs.

#ike_versions ⇒ Array<Types::IKEVersionsRequestListValue>

The IKE versions that are permitted for the VPN tunnel.

Valid values: ikev1 | ikev2

Returns:

#phase_1_dh_group_numbers ⇒ Array<Types::Phase1DHGroupNumbersRequestListValue>

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:

#phase_1_encryption_algorithms ⇒ Array<Types::Phase1EncryptionAlgorithmsRequestListValue>

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:

#phase_1_integrity_algorithms ⇒ Array<Types::Phase1IntegrityAlgorithmsRequestListValue>

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:

#phase_1_lifetime_seconds ⇒ Integer

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

Constraints: A value between 900 and 28,800.

Default: 28800

Returns:

  • (Integer) —

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

#phase_2_dh_group_numbers ⇒ Array<Types::Phase2DHGroupNumbersRequestListValue>

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:

#phase_2_encryption_algorithms ⇒ Array<Types::Phase2EncryptionAlgorithmsRequestListValue>

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:

#phase_2_integrity_algorithms ⇒ Array<Types::Phase2IntegrityAlgorithmsRequestListValue>

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:

#phase_2_lifetime_seconds ⇒ Integer

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:

  • (Integer) —

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

#pre_shared_key ⇒ String

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:

  • (String) —

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

#rekey_fuzz_percentage ⇒ Integer

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:

  • (Integer) —

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

#rekey_margin_time_seconds ⇒ Integer

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS 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: 540

Returns:

  • (Integer) —

    The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.

#replay_window_size ⇒ Integer

The number of packets in an IKE replay window.

Constraints: A value between 64 and 2048.

Default: 1024

Returns:

  • (Integer) —

    The number of packets in an IKE replay window.

#startup_action ⇒ String

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 AWS to initiate the IKE negotiation.

Valid Values: add | start

Default: add

Returns:

  • (String) —

    The action to take when the establishing the tunnel for the VPN connection.

#tunnel_inside_cidr ⇒ String

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:

  • (String) —

    The range of inside IPv4 addresses for the tunnel.

#tunnel_inside_ipv_6_cidr ⇒ String

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:

  • (String) —

    The range of inside IPv6 addresses for the tunnel.