Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VpnConnectionConfig

NetworkConfig / CustomerGatewayConfig / VpnConnectionConfig

VPN Connection configuration. Used to define the VPN Connection and its termination point.

example
- name: accelerator-vpn
  transitGateway: Network-Main
  routeTableAssociations:
    - Network-Main-Core
  routeTablePropagations:
    - Network-Main-Core
  staticRoutesOnly: false
  tunnelSpecifications:
    - tunnelInsideCidr: 169.254.200.0/30
      preSharedKey: Key1-AbcXyz
    - tunnelInsideCidr: 169.254.200.100/30

Hierarchy

  • VpnConnectionConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly name

name: "" = ''

The name of the VPN Connection.

The value of this property will be utilized as the logical id for this resource. Any references to this object should specify this value.

Readonly routeTableAssociations

routeTableAssociations: undefined | string[] = undefined

(OPTIONAL) An array of Transit Gateway route table names to associate the VPN attachment to

remarks

This is the name property of the Transit Gateway route table

This property should only be defined if creating a VPN connection to a Transit Gateway. Leave undefined for VPN connections to virtual private gateways.

Readonly routeTablePropagations

routeTablePropagations: undefined | string[] = undefined

(OPTIONAL) An array of Transit Gateway route table names to propagate the VPN attachment to

remarks

This is the name property of the Transit Gateway route table

This property should only be defined if creating a VPN connection to a Transit Gateway. Leave undefined for VPN connections to virtual private gateways.

Readonly staticRoutesOnly

staticRoutesOnly: undefined | boolean = true
remarks

If creating a VPN connection for a device that doesn't support Border Gateway Protocol (BGP) declare true as a value, otherwise, use false.

Readonly tags

tags: undefined | Tag[] = undefined

An array of tags for the VPN Connection.

Readonly transitGateway

transitGateway: undefined | string = undefined

The logical name of the Transit Gateway that the customer Gateway is attached to so that a VPN connection is established.

remarks

Must specify either the Transit Gateway name or the Virtual Private Gateway, not both.

Readonly tunnelSpecifications

tunnelSpecifications: VpnTunnelOptionsSpecificationsConfig[] = []

Define the optional VPN Tunnel configuration

see

VpnTunnelOptionsSpecificationsConfig

Readonly vpc

vpc: undefined | string = undefined

The logical name of the Virtual Private Cloud that a Virtual Private Gateway is attached to.

remarks

Must specify either the Transit Gateway name or the Virtual Private Gateway, not both.

Generated using TypeDoc