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.366.tar.gz (258.2 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.366.tar.gz.

File metadata

File hashes

Hashes for zxkane.cdk-construct-simple-nat-0.2.366.tar.gz
Algorithm Hash digest
SHA256 844ba7953c9ffd88bcc3a580e6b0a03aed5b323e0b18baa209c408ffe7e0671b
MD5 aa0f076eab20b3cdc7e809946812922b
BLAKE2b-256 bb5cee349be0e159e3c5351c21f5e01ae05f7b0e162406c1f166a429d0213244

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for zxkane.cdk_construct_simple_nat-0.2.366-py3-none-any.whl
Algorithm Hash digest
SHA256 aa2950f4057de912eade7300b517620b24bb5ca9717461a9e4908fbd9045d6b8
MD5 d1889c4999a555ce711f814af087ddb6
BLAKE2b-256 d371f2c5ec659fc2ef5cf901243caa0f245a7f7efd72893fd4507b359d22b8ce

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