Skip to content

EC2  >  Structures  >  VpnConnectionOptionsSpecification

VpnConnectionOptionsSpecification

Structure Class

VpnConnectionOptionsSpecification dataclass

Bases: _SerdeShape

Describes VPN connection options.

Attributes

enable_acceleration class-attribute instance-attribute
enable_acceleration: bool | None = ...

Indicate whether to enable acceleration for the VPN connection.

Default: false

local_ipv4_network_cidr class-attribute instance-attribute
local_ipv4_network_cidr: str | None = ...

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: 0.0.0.0/0

local_ipv6_network_cidr class-attribute instance-attribute
local_ipv6_network_cidr: str | None = ...

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ::/0

outside_ip_address_type class-attribute instance-attribute
outside_ip_address_type: str | None = ...

The type of IP address assigned to the outside interface of the customer gateway device.

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

remote_ipv4_network_cidr class-attribute instance-attribute
remote_ipv4_network_cidr: str | None = ...

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

Default: 0.0.0.0/0

remote_ipv6_network_cidr class-attribute instance-attribute
remote_ipv6_network_cidr: str | None = ...

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ::/0

static_routes_only class-attribute instance-attribute
static_routes_only: bool | None = ...

Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

Default: false

transport_transit_gateway_attachment_id class-attribute instance-attribute
transport_transit_gateway_attachment_id: str | None = ...

The transit gateway attachment ID to use for the VPN tunnel.

Required if OutsideIpAddressType is set to PrivateIpv4.

tunnel_bandwidth class-attribute instance-attribute
tunnel_bandwidth: str | None = ...

The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard. Existing VPN connections without a bandwidth setting will automatically default to standard.

tunnel_inside_ip_version class-attribute instance-attribute
tunnel_inside_ip_version: str | None = ...

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

tunnel_options class-attribute instance-attribute
tunnel_options: list[VpnTunnelOptionsSpecification] | None = ...

The tunnel options for the VPN connection.