Skip to main content

A CDK construct to build Simple NAT instance on AWS.

Project description

Simple NAT

Release NPM version pypi version coverage

It's a CDK construct to create NAT instances on AWS.

It supports adding specific IP CIDRs to route tables of VPC, the network traffic to those IP CIDRs will be forwarded to the NAT instances.

It supports routing to below services out of box,

  • Github git servers
  • Google
  • Cloudflare

Arch diagram

Install

TypeScript/JavaScript:

yarn add cdk-construct-simple-nat

or

npm install cdk-construct-simple-nat

Usage

import { SimpleNAT } from 'cdk-construct-simple-nat';

new SimpleNAT(this, 'SimpleNAT', {
  vpc,
  natSubnetsSelection: {
    subnetType: SubnetType.PUBLIC,
    onePerAz: true,
  },
})
.withGithubRoute();

See the complete example and API doc.

FAQ

What's the difference between EC2 NAT instances and NAT instances created by this construct

There are below differences,

  • EC2 NAT instance will route all Internet traffic to itself by default
  • NAT instance uses depracated Amazon Linux AMI, this construct always uses latest Amazon Linux 2 AMI
  • NAT instances created by this construct can work with NAT gateways together, you can have multiple NAT instances in one VPC
  • This construct can help when only routing specific traffic(for example, github/gist) to NAT instances which acts as transit proxy

What's the difference between CDK built-in NAT instances and NAT instances created by this construct

  • CDK built-in NAT instances has to be created with VPC stack, this construct can add NAT instances to any existing VPC
  • You can use this construct multiple NAT instances for different purposes
  • This construct allows you customize the instances how to route the traffic

The deployment fails due to the routes in route table exceeds the limit

The default routes in route table is 50, the deployment will fail if adding routes more than the limit of your account. You can increase the limit up to 1000 routes per route table via service quota.

How to exclude IPv6 CIDR with built-in github/google/cloudflare routes

You can exclude IPv6 CIDR like below,

new SimpleNAT(this, 'SimpleNAT', {
  vpc,
})
.withCloudflareRoute({
  excludeIPv6: true,
});

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zxkane.cdk-construct-simple-nat-0.2.624.tar.gz (255.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file zxkane.cdk-construct-simple-nat-0.2.624.tar.gz.

File metadata

File hashes

Hashes for zxkane.cdk-construct-simple-nat-0.2.624.tar.gz
Algorithm Hash digest
SHA256 63da4172197fa4d33bb1e1482cfa2daa74bf913d63b3c1fa227b16f7eb3d26a2
MD5 8530dc6100ef53fdff4138890e5b7f19
BLAKE2b-256 31545bf525f52f7f3bba1049d8dd95cb42dfbe98f9cafc06b0eb603d54e9ef4e

See more details on using hashes here.

File details

Details for the file zxkane.cdk_construct_simple_nat-0.2.624-py3-none-any.whl.

File metadata

File hashes

Hashes for zxkane.cdk_construct_simple_nat-0.2.624-py3-none-any.whl
Algorithm Hash digest
SHA256 9d7516881d09d32538da63b406b83ddcff1f9fa5176fae9f1324cb15b604e083
MD5 87d01c89c0d0605dc0de5f9b2818999e
BLAKE2b-256 2c244a3a49c86002a2eb9781418f679403d120deaf1cde1a1efee9e495db33ef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page