Skip to content

ModifyVpnTunnelOptionsSpecification

Source code in docs_src/capo_ec2/types/modify_vpn_tunnel_options_specification.py
class ModifyVpnTunnelOptionsSpecification(TypedDict, closed=True):
    tunnel_inside_cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>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. </p> <p>Constraints: A size /30 CIDR block from the <code>169.254.0.0/16</code> range. The following CIDR blocks are reserved and cannot be used:</p> <ul> <li> <p> <code>169.254.0.0/30</code> </p> </li> <li> <p> <code>169.254.1.0/30</code> </p> </li> <li> <p> <code>169.254.2.0/30</code> </p> </li> <li> <p> <code>169.254.3.0/30</code> </p> </li> <li> <p> <code>169.254.4.0/30</code> </p> </li> <li> <p> <code>169.254.5.0/30</code> </p> </li> <li> <p> <code>169.254.169.252/30</code> </p> </li> </ul>"""
    tunnel_inside_ipv6_cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>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.</p> <p>Constraints: A size /126 CIDR block from the local <code>fd00::/8</code> range.</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> <p>Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).</p>"""
    phase1_lifetime_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The lifetime for phase 1 of the IKE negotiation, in seconds.</p> <p>Constraints: A value between 900 and 28,800.</p> <p>Default: <code>28800</code> </p>"""
    phase2_lifetime_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The lifetime for phase 2 of the IKE negotiation, in seconds.</p> <p>Constraints: A value between 900 and 3,600. The value must be less than the value for <code>Phase1LifetimeSeconds</code>.</p> <p>Default: <code>3600</code> </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. The exact time of the rekey is randomly selected based on the value for <code>RekeyFuzzPercentage</code>.</p> <p>Constraints: A value between 60 and half of <code>Phase2LifetimeSeconds</code>.</p> <p>Default: <code>270</code> </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> <p>Constraints: A value between 0 and 100.</p> <p>Default: <code>100</code> </p>"""
    replay_window_size: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of packets in an IKE replay window.</p> <p>Constraints: A value between 64 and 2048.</p> <p>Default: <code>1024</code> </p>"""
    dpd_timeout_seconds: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.</p> <p>Constraints: A value greater than or equal to 30.</p> <p>Default: <code>40</code> </p>"""
    dpd_timeout_action: NotRequired["capo_ec2.types.string.String"]
    """<p>The action to take after DPD timeout occurs. Specify <code>restart</code> to restart the IKE initiation. Specify <code>clear</code> to end the IKE session.</p> <p>Valid Values: <code>clear</code> | <code>none</code> | <code>restart</code> </p> <p>Default: <code>clear</code> </p>"""
    phase1_encryption_algorithms: NotRequired[
        "capo_ec2.types.phase1_encryption_algorithms_request_list.Phase1EncryptionAlgorithmsRequestList"
    ]
    """<p>One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>AES128</code> | <code>AES256</code> | <code>AES128-GCM-16</code> | <code>AES256-GCM-16</code> </p>"""
    phase2_encryption_algorithms: NotRequired[
        "capo_ec2.types.phase2_encryption_algorithms_request_list.Phase2EncryptionAlgorithmsRequestList"
    ]
    """<p>One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>AES128</code> | <code>AES256</code> | <code>AES128-GCM-16</code> | <code>AES256-GCM-16</code> </p>"""
    phase1_integrity_algorithms: NotRequired[
        "capo_ec2.types.phase1_integrity_algorithms_request_list.Phase1IntegrityAlgorithmsRequestList"
    ]
    """<p>One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>SHA1</code> | <code>SHA2-256</code> | <code>SHA2-384</code> | <code>SHA2-512</code> </p>"""
    phase2_integrity_algorithms: NotRequired[
        "capo_ec2.types.phase2_integrity_algorithms_request_list.Phase2IntegrityAlgorithmsRequestList"
    ]
    """<p>One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>SHA1</code> | <code>SHA2-256</code> | <code>SHA2-384</code> | <code>SHA2-512</code> </p>"""
    phase1_dh_group_numbers: NotRequired[
        "capo_ec2.types.phase1_dh_group_numbers_request_list.Phase1DHGroupNumbersRequestList"
    ]
    """<p>One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.</p> <p>Valid values: <code>2</code> | <code>14</code> | <code>15</code> | <code>16</code> | <code>17</code> | <code>18</code> | <code>19</code> | <code>20</code> | <code>21</code> | <code>22</code> | <code>23</code> | <code>24</code> </p>"""
    phase2_dh_group_numbers: NotRequired[
        "capo_ec2.types.phase2_dh_group_numbers_request_list.Phase2DHGroupNumbersRequestList"
    ]
    """<p>One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.</p> <p>Valid values: <code>2</code> | <code>5</code> | <code>14</code> | <code>15</code> | <code>16</code> | <code>17</code> | <code>18</code> | <code>19</code> | <code>20</code> | <code>21</code> | <code>22</code> | <code>23</code> | <code>24</code> </p>"""
    ike_versions: NotRequired[
        "capo_ec2.types.ike_versions_request_list.IKEVersionsRequestList"
    ]
    """<p>The IKE versions that are permitted for the VPN tunnel.</p> <p>Valid values: <code>ikev1</code> | <code>ikev2</code> </p>"""
    startup_action: NotRequired["capo_ec2.types.string.String"]
    """<p>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 <code>start</code> for Amazon Web Services to initiate the IKE negotiation.</p> <p>Valid Values: <code>add</code> | <code>start</code> </p> <p>Default: <code>add</code> </p>"""
    log_options: NotRequired[
        "capo_ec2.types.vpn_tunnel_log_options_specification.VpnTunnelLogOptionsSpecification"
    ]
    """<p>Options for logging VPN tunnel activity.</p>"""
    enable_tunnel_lifecycle_control: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Turn on or off tunnel endpoint lifecycle control feature.</p>"""

dpd_timeout_action instance-attribute

dpd_timeout_action: NotRequired[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

dpd_timeout_seconds instance-attribute

dpd_timeout_seconds: NotRequired[Integer]

The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.

Constraints: A value greater than or equal to 30.

Default: 40

enable_tunnel_lifecycle_control instance-attribute

enable_tunnel_lifecycle_control: NotRequired[Boolean]

Turn on or off tunnel endpoint lifecycle control feature.

ike_versions instance-attribute

ike_versions: NotRequired[IKEVersionsRequestList]

The IKE versions that are permitted for the VPN tunnel.

Valid values: ikev1 | ikev2

log_options instance-attribute

log_options: NotRequired[VpnTunnelLogOptionsSpecification]

Options for logging VPN tunnel activity.

phase1_dh_group_numbers instance-attribute

phase1_dh_group_numbers: NotRequired[Phase1DHGroupNumbersRequestList]

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

phase1_encryption_algorithms instance-attribute

phase1_encryption_algorithms: NotRequired[Phase1EncryptionAlgorithmsRequestList]

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

phase1_integrity_algorithms instance-attribute

phase1_integrity_algorithms: NotRequired[Phase1IntegrityAlgorithmsRequestList]

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

phase1_lifetime_seconds instance-attribute

phase1_lifetime_seconds: NotRequired[Integer]

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

Constraints: A value between 900 and 28,800.

Default: 28800

phase2_dh_group_numbers instance-attribute

phase2_dh_group_numbers: NotRequired[Phase2DHGroupNumbersRequestList]

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

phase2_encryption_algorithms instance-attribute

phase2_encryption_algorithms: NotRequired[Phase2EncryptionAlgorithmsRequestList]

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

phase2_integrity_algorithms instance-attribute

phase2_integrity_algorithms: NotRequired[Phase2IntegrityAlgorithmsRequestList]

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

phase2_lifetime_seconds instance-attribute

phase2_lifetime_seconds: NotRequired[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

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.

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

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.

Constraints: A value between 0 and 100.

Default: 100

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. 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

replay_window_size instance-attribute

replay_window_size: NotRequired[Integer]

The number of packets in an IKE replay window.

Constraints: A value between 64 and 2048.

Default: 1024

startup_action instance-attribute

startup_action: NotRequired[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 Amazon Web Services to initiate the IKE negotiation.

Valid Values: add | start

Default: add

tunnel_inside_cidr instance-attribute

tunnel_inside_cidr: NotRequired[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

tunnel_inside_ipv6_cidr instance-attribute

tunnel_inside_ipv6_cidr: NotRequired[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.