Skip to content

/AWS1/CL_EC2VPNCONNOPTIONSSPEC

Describes VPN connection options.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_enableacceleration TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

Indicate whether to enable acceleration for the VPN connection.

Default: false

iv_tunnelinsideipversion TYPE /AWS1/EC2TUNNELINSIDEIPVERSION /AWS1/EC2TUNNELINSIDEIPVERSION

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

it_tunneloptions TYPE /AWS1/CL_EC2VPNTUNNELOPTSSPEC=>TT_VPNTUNNELOPTIONSSPECSLIST TT_VPNTUNNELOPTIONSSPECSLIST

The tunnel options for the VPN connection.

iv_localipv4networkcidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Default: 0.0.0.0/0

iv_remoteipv4networkcidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Default: 0.0.0.0/0

iv_localipv6networkcidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Default: ::/0

iv_remoteipv6networkcidr TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Default: ::/0

iv_outsideipaddresstype TYPE /AWS1/EC2STRING /AWS1/EC2STRING

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

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

iv_transporttgwattachmentid TYPE /AWS1/EC2TGWATTACHMENTID /AWS1/EC2TGWATTACHMENTID

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

Required if OutsideIpAddressType is set to PrivateIpv4.

iv_tunnelbandwidth TYPE /AWS1/EC2VPNTUNNELBANDWIDTH /AWS1/EC2VPNTUNNELBANDWIDTH

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.

iv_staticroutesonly TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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


Queryable Attributes

EnableAcceleration

Indicate whether to enable acceleration for the VPN connection.

Default: false

Accessible with the following methods

Method Description
GET_ENABLEACCELERATION() Getter for ENABLEACCELERATION, with configurable default
ASK_ENABLEACCELERATION() Getter for ENABLEACCELERATION w/ exceptions if field has no
HAS_ENABLEACCELERATION() Determine if ENABLEACCELERATION has a value

TunnelInsideIpVersion

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

Accessible with the following methods

Method Description
GET_TUNNELINSIDEIPVERSION() Getter for TUNNELINSIDEIPVERSION, with configurable default
ASK_TUNNELINSIDEIPVERSION() Getter for TUNNELINSIDEIPVERSION w/ exceptions if field has
HAS_TUNNELINSIDEIPVERSION() Determine if TUNNELINSIDEIPVERSION has a value

TunnelOptions

The tunnel options for the VPN connection.

Accessible with the following methods

Method Description
GET_TUNNELOPTIONS() Getter for TUNNELOPTIONS, with configurable default
ASK_TUNNELOPTIONS() Getter for TUNNELOPTIONS w/ exceptions if field has no value
HAS_TUNNELOPTIONS() Determine if TUNNELOPTIONS has a value

LocalIpv4NetworkCidr

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

Default: 0.0.0.0/0

Accessible with the following methods

Method Description
GET_LOCALIPV4NETWORKCIDR() Getter for LOCALIPV4NETWORKCIDR, with configurable default
ASK_LOCALIPV4NETWORKCIDR() Getter for LOCALIPV4NETWORKCIDR w/ exceptions if field has n
HAS_LOCALIPV4NETWORKCIDR() Determine if LOCALIPV4NETWORKCIDR has a value

RemoteIpv4NetworkCidr

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

Default: 0.0.0.0/0

Accessible with the following methods

Method Description
GET_REMOTEIPV4NETWORKCIDR() Getter for REMOTEIPV4NETWORKCIDR, with configurable default
ASK_REMOTEIPV4NETWORKCIDR() Getter for REMOTEIPV4NETWORKCIDR w/ exceptions if field has
HAS_REMOTEIPV4NETWORKCIDR() Determine if REMOTEIPV4NETWORKCIDR has a value

LocalIpv6NetworkCidr

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

Default: ::/0

Accessible with the following methods

Method Description
GET_LOCALIPV6NETWORKCIDR() Getter for LOCALIPV6NETWORKCIDR, with configurable default
ASK_LOCALIPV6NETWORKCIDR() Getter for LOCALIPV6NETWORKCIDR w/ exceptions if field has n
HAS_LOCALIPV6NETWORKCIDR() Determine if LOCALIPV6NETWORKCIDR has a value

RemoteIpv6NetworkCidr

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

Default: ::/0

Accessible with the following methods

Method Description
GET_REMOTEIPV6NETWORKCIDR() Getter for REMOTEIPV6NETWORKCIDR, with configurable default
ASK_REMOTEIPV6NETWORKCIDR() Getter for REMOTEIPV6NETWORKCIDR w/ exceptions if field has
HAS_REMOTEIPV6NETWORKCIDR() Determine if REMOTEIPV6NETWORKCIDR has a value

OutsideIpAddressType

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

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

Accessible with the following methods

Method Description
GET_OUTSIDEIPADDRESSTYPE() Getter for OUTSIDEIPADDRESSTYPE, with configurable default
ASK_OUTSIDEIPADDRESSTYPE() Getter for OUTSIDEIPADDRESSTYPE w/ exceptions if field has n
HAS_OUTSIDEIPADDRESSTYPE() Determine if OUTSIDEIPADDRESSTYPE has a value

TransportTransitGatewayAttachmentId

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

Required if OutsideIpAddressType is set to PrivateIpv4.

Accessible with the following methods

Method Description
GET_TRANSPORTTGWATTACHMENTID() Getter for TRANSPORTTGWATTACHMENTID, with configurable defau
ASK_TRANSPORTTGWATTACHMENTID() Getter for TRANSPORTTGWATTACHMENTID w/ exceptions if field h
HAS_TRANSPORTTGWATTACHMENTID() Determine if TRANSPORTTGWATTACHMENTID has a value

TunnelBandwidth

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.

Accessible with the following methods

Method Description
GET_TUNNELBANDWIDTH() Getter for TUNNELBANDWIDTH, with configurable default
ASK_TUNNELBANDWIDTH() Getter for TUNNELBANDWIDTH w/ exceptions if field has no val
HAS_TUNNELBANDWIDTH() Determine if TUNNELBANDWIDTH has a value

StaticRoutesOnly

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

Accessible with the following methods

Method Description
GET_STATICROUTESONLY() Getter for STATICROUTESONLY, with configurable default
ASK_STATICROUTESONLY() Getter for STATICROUTESONLY w/ exceptions if field has no va
HAS_STATICROUTESONLY() Determine if STATICROUTESONLY has a value