cdk-vpc-module construct library is an open-source extension of the AWS Cloud Development Kit (AWS CDK) to deploy configurable aws vpc and its individual components in less than 50 lines of code and human readable configuration which can be managed by pull requests!
- ✅ Option to configure custom IPv4 CIDR(10.10.0.0/24)
- ✅ VPC Peering with route table entry
- ✅ Configurable NACL as per subnet group
- ✅ NATGateway as per availabilityZones
- ✅ Public/private Route 53 hosted zones with optional public ACM certificate
- ✅ VPC Endpoint Services backed by NLB → ALB with configurable NLB health check protocol and path
Using cdk a vpc can be deployed using the following sample code snippet:
import { Network } from "@smallcase/cdk-vpc-module/lib/constructs/network";
import { aws_ec2 as ec2, App, Stack, StackProps } from "aws-cdk-lib";
import { Construct } from "constructs";
export class VPCStack extends Stack {
constructor(scope: Construct, id: string, props: StackProps = {}) {
const s3EndpointIamPermission = new iam.PolicyStatement({
actions: ["s3:*"],
resources: ['arn:aws:s3:::*'],
principals: [new iam.AnyPrincipal()],
})
const monitoringEndpointIamPermission = new iam.PolicyStatement({
actions: ["*"],
resources: ['*'],
principals: [new iam.AnyPrincipal()],
})
super(scope, id, props);
new Network(this, 'NETWORK', {
vpc: {
cidr: '10.10.0.0/16',
subnetConfiguration: [],
},
peeringConfigs: {
"TEST-PEERING": { // this key will be used as your peering id, which you will have to mention below when you configure a route table for your subnets
peeringVpcId: "vpc-0000",
tags: {
"Name": "TEST-PEERING to CREATED-VPC",
"Description": "Connect"
}
}
},
subnets: [
{
subnetGroupName: 'NATGateway',
subnetType: ec2.SubnetType.PUBLIC,
cidrBlock: ['10.10.0.0/28', '10.10.0.16/28', '10.10.0.32/28'],
availabilityZones: ['ap-south-1a', 'ap-south-1b', 'ap-south-1c'],
ingressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
routes: [
],
egressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
},
{
subnetGroupName: 'Public',
subnetType: ec2.SubnetType.PUBLIC,
cidrBlock: ['10.10.2.0/24', '10.10.3.0/24', '10.10.4.0/24'],
availabilityZones: ['ap-south-1a', 'ap-south-1b', 'ap-south-1c'],
ingressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
egressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
routes: [
],
tags: {
// if you use this vpc for your eks cluster, you have to tag your subnets [read more](https://aws.amazon.com/premiumsupport/knowledge-center/eks-vpc-subnet-discovery/)
'kubernetes.io/role/elb': '1',
'kubernetes.io/cluster/TEST-CLUSTER': 'owned',
},
},
{
subnetGroupName: 'Private',
subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,
cidrBlock: ['10.10.5.0/24', '10.10.6.0/24', '10.10.7.0/24'],
availabilityZones: ['ap-south-1a', 'ap-south-1b', 'ap-south-1c'],
ingressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
egressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
routes: [
{
// if you use this vpc for your eks cluster, you have to tag your subnets [read more](https://aws.amazon.com/premiumsupport/knowledge-center/eks-vpc-subnet-discovery/)
routerType: ec2.RouterType.VPC_PEERING_CONNECTION,
destinationCidrBlock: "<destinationCidrBlock>",
//<Your VPC PeeringConfig KEY, in this example TEST-PEERING will be your ID>
existingVpcPeeringRouteKey: "TEST-PEERING"
}
],
tags: {
'kubernetes.io/role/internal-elb': '1',
'kubernetes.io/cluster/TEST-CLUSTER': 'owned',
},
},
{
subnetGroupName: 'Database',
subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,
cidrBlock: ['10.10.14.0/27', '10.10.14.32/27', '10.10.14.64/27'],
availabilityZones: ['ap-south-1a', 'ap-south-1b', 'ap-south-1c'],
ingressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
egressNetworkACL: [
{
cidr: ec2.AclCidr.ipv4('0.0.0.0/0'),
traffic: ec2.AclTraffic.allTraffic(),
},
],
routes: [
],
tags: {
},
},
],
vpcEndpoints: [
{
name: "s3-gw",
service: ec2.GatewayVpcEndpointAwsService.S3,
subnetGroupNames: ["Private","Database"],
externalSubnets: [
{
id: "subnet-<id>",
availabilityZone: "ap-south-1a",
routeTableId: "rtb-<id>"
},
{
id: "subnet-<id>",
availabilityZone: "ap-south-1b",
routeTableId: "rtb-<id>"
}
],
iamPolicyStatements: [s3EndpointIamPermission]
},
{
name: "da-stag-monitoring-vpe",
service: ec2.InterfaceVpcEndpointAwsService.CLOUDWATCH_MONITORING,
subnetGroupNames: ["ManageServicePrivate"],
iamPolicyStatements: [monitoringEndpointIamPermission],
securityGroupRules: [
{
peer: ec2.Peer.ipv4("10.10.0.0/16"),
port: ec2.Port.tcp(443),
description: "From Test VPC"
}
],
},
]
});
}
}
const envDef = {
account: '<AWS-ID>',
region: '<AWS-REGION>',
};
const app = new App();
new VPCStack(app, 'TEST', {
env: envDef,
terminationProtection: true,
tags: {
});
app.synth();Please refer here to check how to use individual resource constructs.
Hosted zones are modeled separately from the Network construct. For private
hosted zones, pass the VPC from the network stack and the zone is associated
with that VPC automatically. ACM certificate creation is supported only for
public hosted zones and creates a certificate for both <host> and *.<host>.
import { HostedZoneStack } from '@smallcase/cdk-vpc-module/lib/constructs/hosted-zone';
const hostedZones = new HostedZoneStack(this, 'HostedZones', {
vpc: network.vpc,
hostedZones: [
{
zoneName: 'example.smallcase.com',
publicZone: true,
createAcmCertificate: true,
},
{
zoneName: 'internal.example.smallcase.com',
publicZone: false,
},
],
});VpcEndpointServiceNestedStack creates a VPC Endpoint Service backed by an NLB that forwards traffic to an ALB.
import { VpcEndpointServiceNestedStack } from '@smallcase/cdk-vpc-module/lib/constructs/vpc-endpoint-service';
import * as elbv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';
new VpcEndpointServiceNestedStack(this, 'VpcEndpointServices', {
vpc: network.vpc,
subnets: network.subnets,
vpcEndpointServiceConfigs: [
{
name: 'my-service',
allowedPrincipals: ['arn:aws:iam::123456789012:root'],
acceptanceRequired: false,
alb: {
existingArn: 'arn:aws:elasticloadbalancing:...',
existingSecurityGroupId: 'sg-xxxxxxxx',
},
nlb: {
subnetGroupName: 'Private',
securityGroupRules: [
{
peer: ec2.Peer.ipv4('10.0.0.0/8'),
port: ec2.Port.tcp(443),
description: 'Allow HTTPS from internal',
},
],
certificates: ['arn:aws:acm:...'],
// Override health check when the ALB is HTTPS-only.
// Defaults to HTTP on / if omitted.
healthCheck: {
protocol: elbv2.Protocol.HTTPS,
path: '/nlb-healthcheck',
port: 443,
},
},
},
],
});| Field | Type | Required | Description |
|---|---|---|---|
subnetGroupName |
string |
yes | Subnet group for the NLB |
securityGroupRules |
SecurityGroupRule[] |
yes | Ingress rules for the NLB security group |
existingSecurityGroupId |
string |
no | Reuse an existing SG instead of creating one |
certificates |
string[] |
no | ACM certificate ARNs — enables TLS listeners on the NLB |
internetFacing |
boolean |
no | Defaults to false |
healthCheck |
NlbHealthCheckConfig |
no | Override the NLB → ALB target group health check |
| Field | Type | Description |
|---|---|---|
protocol |
elbv2.Protocol |
Health check protocol (e.g. HTTPS). Defaults to HTTP if omitted |
path |
string |
Health check path (e.g. /nlb-healthcheck) |
port |
number |
Health check port. Defaults to the target port if omitted |
When to set
healthCheck: The NLB target group defaults to HTTP on/. If the backing ALB is HTTPS-only, setprotocol: elbv2.Protocol.HTTPSand pointpathto an endpoint that returns HTTP 200.
The quick start shows you how to create an AWS-VPC using this module.
- A working
awsCLI installation with access to an account and administrator privileges - You'll need a recent NodeJS installation
To get going you'll need a CDK project. For details please refer to the detailed guide for CDK.
Create an empty directory on your system.
mkdir aws-quick-start-vpc && cd aws-quick-start-vpcBootstrap your CDK project, we will use TypeScript, but you can switch to any other supported language.
npx cdk init sample-vpc --language typescript
npx cdk bootstrap Install using NPM:
npm install @smallcase/cdk-vpc-module
Using yarn
yarn add @smallcase/cdk-vpc-module
Check the changed which are to be deployed
~ -> npx cdk diffDeploy using
~ -> npx cdk deployFeatures Multiple VPC Endpoints: Define and manage multiple VPC Endpoints in one configuration. Flexible Subnet Selection: Attach VPC Endpoints to multiple subnet groups or external subnets. Custom Security Groups: Configure security groups for Interface VPC Endpoints. IAM Policies: Attach custom IAM policies to control access to the VPC Endpoints. Tagging: Apply custom tags to each VPC Endpoint.
Defining VPC Endpoints Configuration You can define multiple VPC Endpoints in the vpcEndpoints: [] configuration array. Each VPC Endpoint can be customized with different subnet groups, IAM policies, security group rules, and tags.
vpcEndpoints: [
{
name: "test-s3-gw",
service: ec2.GatewayVpcEndpointAwsService.S3,
subnetGroupNames: ["ManageServicePrivate", "ToolPrivate", "Database"], // Subnet groups for the endpoint
externalSubnets: [
{
id: "subnet-<id>",
availabilityZone: "ap-south-1a",
routeTableId: "rtb-<id>",
},
{
id: "subnet-<id>",
availabilityZone: "ap-south-1b",
routeTableId: "rtb-<id>",
}
],
iamPolicyStatements: [s3EndpointIamPermission], // Custom IAM policy for the endpoint
},
{
name: "DynamoDbGatewayEndpoint",
service: ec2.GatewayVpcEndpointAwsService.DYNAMODB,
subnetGroupNames: ["private-subnet"],
additionalTags: {
Environment: "Staging",
},
},
],
In this example:
The S3 Gateway Endpoint is created in three subnet groups: ManageServicePrivate, ToolPrivate, and Database. External subnets are specified with their IDs, availability zones, and route table IDs for the S3 endpoint. A custom IAM policy (s3EndpointIamPermission) is attached to control access to the S3 endpoint. A DynamoDB Gateway Endpoint is created in the private-subnet with additional tags specifying the environment and ownership.
Configuration Options Here’s a breakdown of the configuration options available:
- name: A unique name for the VPC Endpoint.
- service: The AWS service the VPC Endpoint connects to (e.g., S3, DynamoDB, Secrets Manager)
- subnetGroupNames: The subnet group names where the VPC Endpoint will be deployed.
- externalSubnets: Specify external subnets if you need to define subnets manually (each with an id, availabilityZone, and routeTableId).
- iamPolicyStatements: (Optional) Attach IAM policy statements to control access to the endpoint.
- additionalTags: (Optional) Add custom tags to the VPC Endpoint for easier identification and tracking.
- ✅ Configurable route table entry naming for subnet routes via
routeTableStringFormat