Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RouteTableEntryConfig

NetworkConfig / VpcConfig | VpcTemplatesConfig / RouteTableConfig / RouteTableEntryConfig

VPC route table entry configuration. Used to define static route entries in a VPC route table.

example

Transit Gateway Attachment

- name: TgwRoute
  destination: 0.0.0.0/0
  type: transitGateway
  target: Network-Main
example

NAT Gateway

- name: NatRoute
  destination: 0.0.0.0/0
  type: natGateway
  target: Nat-A
example

Internet Gateway

- name: IgwRoute
  destination: 0.0.0.0/0
  type: internetGateway
example

VPC Peering

- name: PeerRoute
  destination: 10.0.0.0/16
  type: vpcPeering
  target: Peering
example

Network Firewall

- name: NfwRoute
  destination: 0.0.0.0/0
  type: networkFirewall
  target: accelerator-firewall
  targetAvailabilityZone: a
example

Gateway Load Balancer Endpoint

- name: GwlbRoute
  destination: 0.0.0.0/0
  type: gatewayLoadBalancerEndpoint
  target: Endpoint-A

Hierarchy

  • RouteTableEntryConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly destination

destination: undefined | string = undefined

The destination CIDR block for the route table entry.

remarks

Use CIDR notation, i.e. 10.0.0.0/16

Either destination or destinationPrefixList must be specified for the following route entry types: transitGateway, natGateway, internetGateway, networkInterface, vpcPeering, virtualPrivateGateway.

destination MUST be specified for route entry type networkFirewall or gatewayLoadBalancerEndpoint.

Leave undefined for route entry type gatewayEndpoint.

Readonly destinationPrefixList

destinationPrefixList: undefined | string = undefined

The friendly name of the destination prefix list for the route table entry.

remarks

Either destination or destinationPrefixList must be specified for the following route entry types: transitGateway, natGateway, internetGateway, networkInterface, vpcPeering, virtualPrivateGateway.

Cannot be specified for route entry type networkFirewall or gatewayLoadBalancerEndpoint. Use destination instead.

Leave undefined for route entry type gatewayEndpoint.

Readonly name

name: string = ''

A friendly name for the route table.

Readonly target

target: undefined | string = undefined

The friendly name of the destination target.

remarks

Use s3 or dynamodb as the string when specifying a route entry type of gatewayEndpoint.

Leave undefined for route entry type internetGateway or virtualPrivateGateway.

Readonly targetAvailabilityZone

targetAvailabilityZone: undefined | string = undefined

The Availability Zone (AZ) the target resides in.

remarks

Include only the letter of the AZ name (i.e. 'a' for 'us-east-1a').

Leave undefined for targets of route entry types other than networkFirewall.

Readonly type

type: undefined | "transitGateway" | "natGateway" | "internetGateway" | "local" | "localGateway" | "gatewayEndpoint" | "gatewayLoadBalancerEndpoint" | "networkInterface" | "networkFirewall" | "virtualPrivateGateway" | "vpcPeering" = undefined

The destination type of route table entry.

see

NetworkConfigTypes.routeTableEntryTypeEnum

Generated using TypeDoc