Class TransitGatewayConfig

NetworkConfig / TransitGatewayConfig

Transit Gateway (TGW) configuration. Use this configuration to define Transit Gateways for your environment. A transit gateway acts as a virtual router for traffic flowing between your virtual private clouds (VPCs) and on-premises networks.

The following example creates a TGW called Network-Main in the Network account in the us-east-1 region.

Example

transitGateways:
  - name: Network-Main
    account: Network
    region: us-east-1
    shareTargets:
      organizationalUnits: []
    asn: 65000
    dnsSupport: enable
    vpnEcmpSupport: enable
    defaultRouteTableAssociation: disable
    defaultRouteTablePropagation: disable
    autoAcceptSharingAttachments: enable
    routeTables: []
    tags: []

Hierarchy

  • TransitGatewayConfig

Implements

Constructors

constructor

Properties

account asn autoAcceptSharingAttachments defaultRouteTableAssociation defaultRouteTablePropagation dnsSupport name region routeTables shareTargets tags vpnEcmpSupport

Constructors

constructor

Properties

Readonly account

account: string = ''

The friendly name of the account to deploy the Transit Gateway.

Remarks

This is the logical name property of the account as defined in accounts-config.yaml.

Readonly asn

asn: number = 65521

A Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Remarks

CAUTION: Changing this value after initial deployment will cause the Transit Gateway to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

The range is 64512 to 65534 for 16-bit ASNs.

The range is 4200000000 to 4294967294 for 32-bit ASNs.

Readonly autoAcceptSharingAttachments

autoAcceptSharingAttachments: "enable" | "disable" = 'disable'

Enable this option to automatically accept cross-account attachments.

Readonly defaultRouteTableAssociation

defaultRouteTableAssociation: "enable" | "disable" = 'enable'

Configure default route table association.

Remarks

Enable this option to automatically associate transit gateway attachments with the default route table for the transit gateway.

Readonly defaultRouteTablePropagation

defaultRouteTablePropagation: "enable" | "disable" = 'enable'

Configure default route table propagation.

Remarks

Enable this option to automatically propagate transit gateway attachments to the default route table for the transit gateway.

Readonly dnsSupport

dnsSupport: "enable" | "disable" = 'enable'

Configure DNS support between VPCs.

Remarks

Enable this option if you need the VPC to resolve public IPv4 DNS host names to private IPv4 addresses when queried from instances in another VPC attached to the transit gateway.

Readonly name

name: string = ''

A friendly name for the Transit Gateway.

Remarks

CAUTION: Changing this value after initial deployment will cause the Transit Gateway to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Readonly region

region: string = 'us-east-1'

The region name to deploy the Transit Gateway.

Readonly routeTables

routeTables: TransitGatewayRouteTableConfig[] = []

An array of Transit Gateway route table configuration objects.

See

TransitGatewayRouteTableConfig

Readonly shareTargets

shareTargets: undefined | ShareTargets = undefined

(OPTIONAL) Resource Access Manager (RAM) share targets.

Remarks

Targets can be account names and/or organizational units.

See

ShareTargets

Readonly tags

tags: undefined | Tag[] = undefined

(OPTIONAL) An array of tag objects for the Transit Gateway.

Readonly vpnEcmpSupport

vpnEcmpSupport: "enable" | "disable" = 'enable'

Equal Cost Multipath (ECMP) routing support between VPN tunnels.

Remarks

Enable this option if you need Equal Cost Multipath (ECMP) routing support between VPN tunnels. If connections advertise the same CIDRs, the traffic is distributed equally between them.

Settings

Member Visibility

Theme

Generated using TypeDoc