Skip to content

TunnelOption

Source code in docs_src/capo_ec2/types/tunnel_option.py
class TunnelOption(TypedDict, closed=True):
    outside_ip_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The external IP address of the VPN tunnel.</p>"""
    tunnel_inside_cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The range of inside IPv4 addresses for the tunnel.</p>"""
    tunnel_inside_ipv6_cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The range of inside IPv6 addresses for the tunnel.</p>"""
    pre_shared_key: NotRequired["capo_ec2.types.pre_shared_key.preSharedKey"]
    """<p>The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.</p>"""
    phase1_lifetime_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The lifetime for phase 1 of the IKE negotiation, in seconds.</p>"""
    phase2_lifetime_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The lifetime for phase 2 of the IKE negotiation, in seconds.</p>"""
    rekey_margin_time_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>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.</p>"""
    rekey_fuzz_percentage: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The percentage of the rekey window determined by <code>RekeyMarginTimeSeconds</code> during which the rekey time is randomly selected.</p>"""
    replay_window_size: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of packets in an IKE replay window.</p>"""
    dpd_timeout_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of seconds after which a DPD timeout occurs.</p>"""
    dpd_timeout_action: NotRequired["capo_ec2.types.string.String"]
    """<p>The action to take after a DPD timeout occurs.</p>"""
    phase1_encryption_algorithms: NotRequired[
        "capo_ec2.types.phase1_encryption_algorithms_list.Phase1EncryptionAlgorithmsList"
    ]
    """<p>The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.</p>"""
    phase2_encryption_algorithms: NotRequired[
        "capo_ec2.types.phase2_encryption_algorithms_list.Phase2EncryptionAlgorithmsList"
    ]
    """<p>The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.</p>"""
    phase1_integrity_algorithms: NotRequired[
        "capo_ec2.types.phase1_integrity_algorithms_list.Phase1IntegrityAlgorithmsList"
    ]
    """<p>The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.</p>"""
    phase2_integrity_algorithms: NotRequired[
        "capo_ec2.types.phase2_integrity_algorithms_list.Phase2IntegrityAlgorithmsList"
    ]
    """<p>The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.</p>"""
    phase1_dh_group_numbers: NotRequired[
        "capo_ec2.types.phase1_dh_group_numbers_list.Phase1DHGroupNumbersList"
    ]
    """<p>The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.</p>"""
    phase2_dh_group_numbers: NotRequired[
        "capo_ec2.types.phase2_dh_group_numbers_list.Phase2DHGroupNumbersList"
    ]
    """<p>The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.</p>"""
    ike_versions: NotRequired["capo_ec2.types.ike_versions_list.IKEVersionsList"]
    """<p>The IKE versions that are permitted for the VPN tunnel.</p>"""
    startup_action: NotRequired["capo_ec2.types.string.String"]
    """<p>The action to take when the establishing the VPN tunnels for a VPN connection.</p>"""
    log_options: NotRequired[
        "capo_ec2.types.vpn_tunnel_log_options.VpnTunnelLogOptions"
    ]
    """<p>Options for logging VPN tunnel activity.</p>"""
    enable_tunnel_lifecycle_control: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Status of tunnel endpoint lifecycle control feature.</p>"""

dpd_timeout_action instance-attribute

dpd_timeout_action: NotRequired[String]

The action to take after a DPD timeout occurs.

dpd_timeout_seconds instance-attribute

dpd_timeout_seconds: NotRequired[Integer]

The number of seconds after which a DPD timeout occurs.

enable_tunnel_lifecycle_control instance-attribute

enable_tunnel_lifecycle_control: NotRequired[Boolean]

Status of tunnel endpoint lifecycle control feature.

ike_versions instance-attribute

ike_versions: NotRequired[IKEVersionsList]

The IKE versions that are permitted for the VPN tunnel.

log_options instance-attribute

log_options: NotRequired[VpnTunnelLogOptions]

Options for logging VPN tunnel activity.

outside_ip_address instance-attribute

outside_ip_address: NotRequired[String]

The external IP address of the VPN tunnel.

phase1_dh_group_numbers instance-attribute

phase1_dh_group_numbers: NotRequired[Phase1DHGroupNumbersList]

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

phase1_encryption_algorithms instance-attribute

phase1_encryption_algorithms: NotRequired[Phase1EncryptionAlgorithmsList]

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.

phase1_integrity_algorithms instance-attribute

phase1_integrity_algorithms: NotRequired[Phase1IntegrityAlgorithmsList]

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

phase1_lifetime_seconds instance-attribute

phase1_lifetime_seconds: NotRequired[Integer]

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

phase2_dh_group_numbers instance-attribute

phase2_dh_group_numbers: NotRequired[Phase2DHGroupNumbersList]

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

phase2_encryption_algorithms instance-attribute

phase2_encryption_algorithms: NotRequired[Phase2EncryptionAlgorithmsList]

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

phase2_integrity_algorithms instance-attribute

phase2_integrity_algorithms: NotRequired[Phase2IntegrityAlgorithmsList]

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

phase2_lifetime_seconds instance-attribute

phase2_lifetime_seconds: NotRequired[Integer]

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

pre_shared_key instance-attribute

pre_shared_key: NotRequired[preSharedKey]

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

rekey_fuzz_percentage instance-attribute

rekey_fuzz_percentage: NotRequired[Integer]

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

rekey_margin_time_seconds instance-attribute

rekey_margin_time_seconds: NotRequired[Integer]

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.

replay_window_size instance-attribute

replay_window_size: NotRequired[Integer]

The number of packets in an IKE replay window.

startup_action instance-attribute

startup_action: NotRequired[String]

The action to take when the establishing the VPN tunnels for a VPN connection.

tunnel_inside_cidr instance-attribute

tunnel_inside_cidr: NotRequired[String]

The range of inside IPv4 addresses for the tunnel.

tunnel_inside_ipv6_cidr instance-attribute

tunnel_inside_ipv6_cidr: NotRequired[String]

The range of inside IPv6 addresses for the tunnel.