API.md

API Reference

Constructs

Network

Initializers

import { Network } from '@smallcase/cdk-vpc-module'

new Network(scope: Construct, id: string, props: VPCProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	VPCProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: VPCProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.
createSubnet	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

createSubnet

public createSubnet(option: ISubnetsProps, vpc: Vpc, peeringConnectionId?: PeeringConnectionInternalType): Subnet[]

option^Required

• Type: ISubnetsProps

---

vpc^Required

• Type: aws-cdk-lib.aws_ec2.Vpc

---

peeringConnectionId^Optional

• Type: PeeringConnectionInternalType

---

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Network } from '@smallcase/cdk-vpc-module'

Network.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
endpointOutputs	{[ key: string ]: aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint | aws-cdk-lib.aws_ec2.GatewayVpcEndpoint}	No description.
natProvider	aws-cdk-lib.aws_ec2.NatProvider	No description.
securityGroupOutputs	{[ key: string ]: aws-cdk-lib.aws_ec2.SecurityGroup}	No description.
vpc	aws-cdk-lib.aws_ec2.Vpc	No description.
natSubnets	aws-cdk-lib.aws_ec2.PublicSubnet[]	No description.
pbSubnets	aws-cdk-lib.aws_ec2.PublicSubnet[]	No description.
pvSubnets	aws-cdk-lib.aws_ec2.PrivateSubnet[]	No description.
subnets	{[ key: string ]: aws-cdk-lib.aws_ec2.Subnet[]}	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

endpointOutputs^Required

public readonly endpointOutputs: {[ key: string ]: InterfaceVpcEndpoint | GatewayVpcEndpoint};

• Type: {[ key: string ]: aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint | aws-cdk-lib.aws_ec2.GatewayVpcEndpoint}

---

natProvider^Required

public readonly natProvider: NatProvider;

• Type: aws-cdk-lib.aws_ec2.NatProvider

---

securityGroupOutputs^Required

public readonly securityGroupOutputs: {[ key: string ]: SecurityGroup};

• Type: {[ key: string ]: aws-cdk-lib.aws_ec2.SecurityGroup}

---

vpc^Required

public readonly vpc: Vpc;

• Type: aws-cdk-lib.aws_ec2.Vpc

---

natSubnets^Required

public readonly natSubnets: PublicSubnet[];

• Type: aws-cdk-lib.aws_ec2.PublicSubnet[]

---

pbSubnets^Required

public readonly pbSubnets: PublicSubnet[];

• Type: aws-cdk-lib.aws_ec2.PublicSubnet[]

---

pvSubnets^Required

public readonly pvSubnets: PrivateSubnet[];

• Type: aws-cdk-lib.aws_ec2.PrivateSubnet[]

---

subnets^Required

public readonly subnets: {[ key: string ]: Subnet[]};

• Type: {[ key: string ]: aws-cdk-lib.aws_ec2.Subnet[]}

---

Structs

AddRouteOptions

Initializer

import { AddRouteOptions } from '@smallcase/cdk-vpc-module'

const addRouteOptions: AddRouteOptions = { ... }

Properties

Name	Type	Description
routerType	aws-cdk-lib.aws_ec2.RouterType	What type of router to route this traffic to.
destinationCidrBlock	string	IPv4 range this route applies to.
destinationIpv6CidrBlock	string	IPv6 range this route applies to.
enablesInternetConnectivity	boolean	Whether this route will enable internet connectivity.
existingVpcPeeringRouteKey	string	No description.
routerId	string	No description.

---

routerType^Required

public readonly routerType: RouterType;

• Type: aws-cdk-lib.aws_ec2.RouterType

What type of router to route this traffic to.

---

destinationCidrBlock^Optional

public readonly destinationCidrBlock: string;

• Type: string
• Default: '0.0.0.0/0'

IPv4 range this route applies to.

---

destinationIpv6CidrBlock^Optional

public readonly destinationIpv6CidrBlock: string;

• Type: string
• Default: Uses IPv6

IPv6 range this route applies to.

---

enablesInternetConnectivity^Optional

public readonly enablesInternetConnectivity: boolean;

• Type: boolean
• Default: false

Whether this route will enable internet connectivity.

If true, this route will be added before any AWS resources that depend on internet connectivity in the VPC will be created.

---

existingVpcPeeringRouteKey^Optional

public readonly existingVpcPeeringRouteKey: string;

• Type: string

---

routerId^Optional

public readonly routerId: string;

• Type: string

---

LoadBalancerConfig

Initializer

import { LoadBalancerConfig } from '@smallcase/cdk-vpc-module'

const loadBalancerConfig: LoadBalancerConfig = { ... }

Properties

Name	Type	Description
certificates	string[]	No description.
existingArn	string	No description.
existingSecurityGroupId	string	No description.
internetFacing	boolean	No description.
securityGroupRules	SecurityGroupRule[]	No description.
subnetGroupName	string	No description.
targetGroups	TargetGroupConfig[]	No description.

---

certificates^Optional

public readonly certificates: string[];

• Type: string[]

---

existingArn^Optional

public readonly existingArn: string;

• Type: string

---

existingSecurityGroupId^Optional

public readonly existingSecurityGroupId: string;

• Type: string

---

internetFacing^Optional

public readonly internetFacing: boolean;

• Type: boolean

---

securityGroupRules^Optional

public readonly securityGroupRules: SecurityGroupRule[];

• Type: SecurityGroupRule[]

---

subnetGroupName^Optional

public readonly subnetGroupName: string;

• Type: string

---

targetGroups^Optional

public readonly targetGroups: TargetGroupConfig[];

• Type: TargetGroupConfig[]

---

NetworkACL

Initializer

import { NetworkACL } from '@smallcase/cdk-vpc-module'

const networkACL: NetworkACL = { ... }

Properties

Name	Type	Description
cidr	aws-cdk-lib.aws_ec2.AclCidr	No description.
traffic	aws-cdk-lib.aws_ec2.AclTraffic	No description.

---

cidr^Required

public readonly cidr: AclCidr;

• Type: aws-cdk-lib.aws_ec2.AclCidr

---

traffic^Required

public readonly traffic: AclTraffic;

• Type: aws-cdk-lib.aws_ec2.AclTraffic

---

NetworkLoadBalancerConfig

Initializer

import { NetworkLoadBalancerConfig } from '@smallcase/cdk-vpc-module'

const networkLoadBalancerConfig: NetworkLoadBalancerConfig = { ... }

Properties

Name	Type	Description
securityGroupRules	SecurityGroupRule[]	No description.
subnetGroupName	string	No description.
certificates	string[]	No description.
existingSecurityGroupId	string	No description.
internetFacing	boolean	No description.

---

securityGroupRules^Required

public readonly securityGroupRules: SecurityGroupRule[];

• Type: SecurityGroupRule[]

---

subnetGroupName^Required

public readonly subnetGroupName: string;

• Type: string

---

certificates^Optional

public readonly certificates: string[];

• Type: string[]

---

existingSecurityGroupId^Optional

public readonly existingSecurityGroupId: string;

• Type: string

---

internetFacing^Optional

public readonly internetFacing: boolean;

• Type: boolean

---

PeeringConfig

Initializer

import { PeeringConfig } from '@smallcase/cdk-vpc-module'

const peeringConfig: PeeringConfig = { ... }

Properties

Name	Type	Description
peeringVpcId	string	No description.
tags	{[ key: string ]: string}	No description.
peerAssumeRoleArn	string	No description.
peerOwnerId	string	No description.
peerRegion	string	No description.

---

peeringVpcId^Required

public readonly peeringVpcId: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

peerAssumeRoleArn^Optional

public readonly peerAssumeRoleArn: string;

• Type: string

---

peerOwnerId^Optional

public readonly peerOwnerId: string;

• Type: string

---

peerRegion^Optional

public readonly peerRegion: string;

• Type: string

---

PeeringConnectionInternalType

Initializer

import { PeeringConnectionInternalType } from '@smallcase/cdk-vpc-module'

const peeringConnectionInternalType: PeeringConnectionInternalType = { ... }

SecurityGroupRule

Initializer

import { SecurityGroupRule } from '@smallcase/cdk-vpc-module'

const securityGroupRule: SecurityGroupRule = { ... }

Properties

Name	Type	Description
peer	aws-cdk-lib.aws_ec2.IPeer | aws-cdk-lib.aws_ec2.ISecurityGroup	No description.
port	aws-cdk-lib.aws_ec2.Port	No description.
description	string	No description.

---

peer^Required

public readonly peer: IPeer | ISecurityGroup;

• Type: aws-cdk-lib.aws_ec2.IPeer | aws-cdk-lib.aws_ec2.ISecurityGroup

---

port^Required

public readonly port: Port;

• Type: aws-cdk-lib.aws_ec2.Port

---

description^Optional

public readonly description: string;

• Type: string

---

TargetGroupConfig

Initializer

import { TargetGroupConfig } from '@smallcase/cdk-vpc-module'

const targetGroupConfig: TargetGroupConfig = { ... }

Properties

Name	Type	Description
applicationPort	number	No description.
host	string	No description.
healthCheckPath	string	No description.
healthCheckPort	number	No description.
healthCheckProtocol	aws-cdk-lib.aws_elasticloadbalancingv2.Protocol	No description.
priority	number	No description.
protocol	aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol	No description.
protocolVersion	aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion	No description.

---

applicationPort^Required

public readonly applicationPort: number;

• Type: number

---

host^Required

public readonly host: string;

• Type: string

---

healthCheckPath^Optional

public readonly healthCheckPath: string;

• Type: string

---

healthCheckPort^Optional

public readonly healthCheckPort: number;

• Type: number

---

healthCheckProtocol^Optional

public readonly healthCheckProtocol: Protocol;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.Protocol

---

priority^Optional

public readonly priority: number;

• Type: number

---

protocol^Optional

public readonly protocol: ApplicationProtocol;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocol

---

protocolVersion^Optional

public readonly protocolVersion: ApplicationProtocolVersion;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationProtocolVersion

---

VpcEndpointConfig

Initializer

import { VpcEndpointConfig } from '@smallcase/cdk-vpc-module'

const vpcEndpointConfig: VpcEndpointConfig = { ... }

Properties

Name	Type	Description
name	string	No description.
service	aws-cdk-lib.aws_ec2.InterfaceVpcEndpointAwsService | aws-cdk-lib.aws_ec2.GatewayVpcEndpointAwsService | aws-cdk-lib.aws_ec2.InterfaceVpcEndpointService	No description.
subnetGroupNames	string[]	No description.
additionalTags	{[ key: string ]: string}	No description.
externalSubnets	IExternalVPEndpointSubnets[]	No description.
iamPolicyStatements	aws-cdk-lib.aws_iam.PolicyStatement[]	No description.
securityGroupRules	SecurityGroupRule[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

service^Required

public readonly service: InterfaceVpcEndpointAwsService | GatewayVpcEndpointAwsService | InterfaceVpcEndpointService;

• Type: aws-cdk-lib.aws_ec2.InterfaceVpcEndpointAwsService | aws-cdk-lib.aws_ec2.GatewayVpcEndpointAwsService | aws-cdk-lib.aws_ec2.InterfaceVpcEndpointService

---

subnetGroupNames^Required

public readonly subnetGroupNames: string[];

• Type: string[]

---

additionalTags^Optional

public readonly additionalTags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

externalSubnets^Optional

public readonly externalSubnets: IExternalVPEndpointSubnets[];

• Type: IExternalVPEndpointSubnets[]

---

iamPolicyStatements^Optional

public readonly iamPolicyStatements: PolicyStatement[];

• Type: aws-cdk-lib.aws_iam.PolicyStatement[]

---

securityGroupRules^Optional

public readonly securityGroupRules: SecurityGroupRule[];

• Type: SecurityGroupRule[]

---

VpcEndpontServiceConfig

Initializer

import { VpcEndpontServiceConfig } from '@smallcase/cdk-vpc-module'

const vpcEndpontServiceConfig: VpcEndpontServiceConfig = { ... }

Properties

Name	Type	Description
alb	LoadBalancerConfig	No description.
name	string	No description.
nlb	NetworkLoadBalancerConfig	No description.
acceptanceRequired	boolean	No description.
additionalTags	{[ key: string ]: string}	No description.
allowedPrincipals	string[]	No description.

---

alb^Required

public readonly alb: LoadBalancerConfig;

• Type: LoadBalancerConfig

---

name^Required

public readonly name: string;

• Type: string

---

nlb^Required

public readonly nlb: NetworkLoadBalancerConfig;

• Type: NetworkLoadBalancerConfig

---

acceptanceRequired^Optional

public readonly acceptanceRequired: boolean;

• Type: boolean

---

additionalTags^Optional

public readonly additionalTags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

allowedPrincipals^Optional

public readonly allowedPrincipals: string[];

• Type: string[]

---

VPCProps

Initializer

import { VPCProps } from '@smallcase/cdk-vpc-module'

const vPCProps: VPCProps = { ... }

Properties

Name	Type	Description
subnets	ISubnetsProps[]	No description.
vpc	aws-cdk-lib.aws_ec2.VpcProps	No description.
natEipAllocationIds	string[]	No description.
peeringConfigs	{[ key: string ]: PeeringConfig}	No description.
vpcEndpoints	VpcEndpointConfig[]	No description.
vpcEndpointServices	VpcEndpontServiceConfig[]	No description.

---

subnets^Required

public readonly subnets: ISubnetsProps[];

• Type: ISubnetsProps[]

---

vpc^Required

public readonly vpc: VpcProps;

• Type: aws-cdk-lib.aws_ec2.VpcProps

---

natEipAllocationIds^Optional

public readonly natEipAllocationIds: string[];

• Type: string[]

---

peeringConfigs^Optional

public readonly peeringConfigs: {[ key: string ]: PeeringConfig};

• Type: {[ key: string ]: PeeringConfig}

---

vpcEndpoints^Optional

public readonly vpcEndpoints: VpcEndpointConfig[];

• Type: VpcEndpointConfig[]

---

vpcEndpointServices^Optional

public readonly vpcEndpointServices: VpcEndpontServiceConfig[];

• Type: VpcEndpontServiceConfig[]

---

Protocols

IExternalVPEndpointSubnets

• Implemented By: IExternalVPEndpointSubnets

Properties

Name	Type	Description
availabilityZone	string	No description.
id	string	No description.
routeTableId	string	No description.

---

availabilityZone^Required

public readonly availabilityZone: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

routeTableId^Required

public readonly routeTableId: string;

• Type: string

---

ISubnetsProps

• Implemented By: ISubnetsProps

Properties

Name	Type	Description
availabilityZones	string[]	No description.
cidrBlock	string[]	No description.
subnetGroupName	string	No description.
subnetType	aws-cdk-lib.aws_ec2.SubnetType	No description.
egressNetworkACL	NetworkACL[]	No description.
ingressNetworkACL	NetworkACL[]	No description.
routes	AddRouteOptions[]	No description.
tags	{[ key: string ]: string}	No description.
useSubnetForNAT	boolean	No description.

---

availabilityZones^Required

public readonly availabilityZones: string[];

• Type: string[]

---

cidrBlock^Required

public readonly cidrBlock: string[];

• Type: string[]

---

subnetGroupName^Required

public readonly subnetGroupName: string;

• Type: string

---

subnetType^Required

public readonly subnetType: SubnetType;

• Type: aws-cdk-lib.aws_ec2.SubnetType

---

egressNetworkACL^Optional

public readonly egressNetworkACL: NetworkACL[];

• Type: NetworkACL[]

---

ingressNetworkACL^Optional

public readonly ingressNetworkACL: NetworkACL[];

• Type: NetworkACL[]

---

routes^Optional

public readonly routes: AddRouteOptions[];

• Type: AddRouteOptions[]

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

useSubnetForNAT^Optional

public readonly useSubnetForNAT: boolean;

• Type: boolean

---