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.742.tar.gz (252.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file zxkane_cdk_construct_simple_nat-0.2.742.tar.gz.

File metadata

File hashes

Hashes for zxkane_cdk_construct_simple_nat-0.2.742.tar.gz
Algorithm Hash digest
SHA256 76631c47746e7d9ff611bdf2bf0da9e2e4db046bd55c877334ec471b4c08bc8d
MD5 6e429ab616f55134881a96550b2bd0df
BLAKE2b-256 96b56ebf9f0be2ba43969f12fedfd0a23ffa422908370c6453d6e2103a1f8558

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for zxkane.cdk_construct_simple_nat-0.2.742-py3-none-any.whl
Algorithm Hash digest
SHA256 5ab19b9af5ea6179fd953247c2d0ca752e350f3ebf76fd81e89e1c77a1db07f2
MD5 07eef96eb5e7afcccb36e648eafc58cd
BLAKE2b-256 53ba4cce9cfbe3c60f1922b5df2ac035c1fa2008b99f950c1fa48d2a42c51751

See more details on using hashes here.

Supported by

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