KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #cli #codex #claude-code #react #dsh-plugin #mcp #open-source #dsh #deepseek-harness

guidance-for-cross-network-traffic-inspection-with-aws-network-firewall

★ 46 Open GitHub ↗

This Guidance demonstrates how to automate the deployment of centralized network security infrastructure that inspects and filters traffic across multiple cloud environments

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

**[Guidance for Cross Network Traffic Inspection with AWS Network Firewall](https://aws.amazon.com/solutions/guidance/cross-network-traffic-inspection-with-aws-network-firewall/)** | **[🚧 Feature request](https://github.com/aws-solutions-library-samples/centralized-network-inspection-on-aws/issues/new?assignees=&labels=feature-request%2C+enhancement&template=feature_request.md&title=)** | **[🐛 Bug Report](https://github.com/aws-solutions-library-samples/centralized-network-inspection-on-aws/issues/new?assignees=&labels=bug%2C+triage&template=bug_report.md&title=)**

## Table of Contents

1.  [Overview](#overview)
    - [Cost](#cost)
2.  [Prerequisites](#prerequisites)
    - [Operating System](#operating-system)
3.  [Deployment Steps](#deployment-steps)
4.  [Deployment Validation](#deployment-validation)
5.  [Running the Guidance](#running-the-guidance)
6.  [Next Steps](#next-steps)
7.  [Cleanup](#cleanup)

8.  [FAQ, known issues, additional considerations, and
    limitations](#faq-known-issues-additional-considerations-and-limitations)
9.  [Notices](#notices)

## Overview

**Guidance for AWS Network Firewall cross-network traffic inspection (formerly Centralized Network Inspection on AWS**) configures the AWS resources needed to filter network traffic.
>
This guidance saves you time by automating the process of provisioning a centralized AWS Network Firewall to inspect traffic between your Amazon Virtual Private Clouds (Amazon VPCs).

File Structure

### Cost

You are responsible for the cost of the AWS services used while running this guidance. As of this revision, the cost for running this guidance with the default settings in the US East (N. Virginia) Region is approximately **\$620.55 per month**. These costs are for the resources shown in the [Sample cost table](#_bookmark11).
>
]We recommend creating a [budget](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-create.html)
through [AWS Cost Explorer](https://aws.amazon.com/aws-cost-management/aws-cost-explorer/)
to help manage costs. Prices are subject to change. For full details, see the pricing webpage for each [AWS service used in this](#_bookmark6) [solution](#_bookmark6).

### Cost Table

The following table provides a sample cost breakdown for deploying this
Guidance with the default parameters in the US East (N. Virginia) `us-east-1` Region
for one month.

| AWS service                     | Dimensions                  | Cost \[USD\]              |
| ----------- | --------------- | ------------ |
| AWS Network Firewall  (endpoint) | (\$0.395/endpoint/hour)     |                   |         
| AWS Network Firewall (data    | 5 GB (\$0.65/GB)            | \$9.75                    |
| processed)                    |                             |                           |
| AWS Transit Gateway (VPC      | 24 hours (\$0.05/hour)      | \$36.00                   |
| attachment)                   |                             |                           |
| AWS Transit Gateway (data     | 10 GB (\$0.02/GB)           | \$6.00                    |
| processed)                    |                             |                           |
| Amazon CodePipeline           |                             | Depends on number of      |
|                               |                             | CodePipeline executions   |
| Amazon CodeBuild              |                             | Depends on number of      |
|                               |                             | CodePipeline executions   |
| Amazon CodeCommit             |                             | Depends on number of      |
|                               |                             | CodePipeline executions   |
| Amazon S3                     |                             | Depends on number of      |
|                               |                             | CodePipeline executions   |
|                               |                             | and Network Firewall log  |
|                               |                             | activity                  |
|                               | Total                       | \$620.55                  |

## Prerequisites

### Operating System

Node.js version:

**Node.js > 16**

### AWS account requirements

Supported Regions This guidance uses Network Firewall, which is not currently available in all AWS Regions. You must launch this guidance in
an AWS Region where AWS Network Firewall is available. For the most current availability of AWS services by Region, see the [AWS Regional
Services List](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/).

![](https://raw.githubusercontent.com/aws-solutions-library-samples/guidance-for-cross-network-traffic-inspection-with-aws-network-firewall/main/media/image2.png)

## Deployment Steps

The high-level process ﬂow for the guidance components deployed with the CloudFormation template is
as follows:

![](https://raw.githubusercontent.com/aws-solutions-library-samples/guidance-for-cross-network-traffic-inspection-with-aws-network-firewall/main/assets/architecture.png)

1.  The CloudFormation template deploys an [inspection VPC](https://aws.amazon.com/blogs/networking-and-content-delivery/deployment-models-for-aws-network-firewall/) with four subnets in randomly- selected Availability Zones in the Region where the guidance is deployed.

a.  The guidance uses two of the subnets to create [AWS Transit Gateway](https://aws.amazon.com/transit-gateway/)
        attachments for your VPCs if you provide an existing transit gateway ID.

b.  The guidance uses the other two subnets to create [AWS Network Firewall](https://aws.amazon.com/network-firewall/)
        endpoints in two randomly-selected Availability Zones in the Region where the guidance is deployed.

2.  The CloudFormation template creates a new [AWS CodeCommit](https://aws.amazon.com/codecommit/) repository and a default network ﬁrewall conﬁguration that allows all traﬃc. This initiates [AWS CodePipeline](https://aws.amazon.com/codepipeline/) to run the following stages:

a.  Validation stage -- The guidance validates the Network Firewall conﬁguration by using Network Firewall application programming
        interfaces (APIs) with dry run mode enabled. This allows the user to ﬁnd unexpected issues before attempting an actual change. This stage
        also checks whether all the referenced ﬁles in the conﬁguration exist in the JSON ﬁle structure.

b.  Deployment stage -- The guidance creates a new
        [ﬁrewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewalls.html),
        [ﬁrewall policy](https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-policies.html),
        and [rule groups](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups.html).
        If any of the resources already exist, the guidance updates these resources. This stage also helps with detecting any changes and
        remediates by applying the latest conﬁguration from the CodeCommit repository. The rule group changes roll back to the original state
        if one of the rule group changes fails. The appliance mode activates for the Transit Gateway to [Amazon VPC](https://aws.amazon.com/vpc/)  attachment          to avoid asymmetric traﬃc. For more information, refer to [Appliance in a](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-appliance-scenario.html) [shared services VPC](https://docs.aws.amazon.com/vpc/latest/tgw/transit-gateway-appliance-scenario.html).

3.  The guidance creates [Amazon VPC route tables](https://docs.aws.amazon.com/vpc/latest/userguide/RouteTables.html) for each Availability Zone. The default route destination target for each is the Amazon VPC endpoint for Network Firewall.

4.  The guidance creates a shared route table with ﬁrewall subnets. The default route destination target is the transit gateway ID. This
    route is only created if the transit gateway ID is provided in the CloudFormation input parameters.

Follow the steps for deploying your custom version of the guidance.

- Create an S3 bucket with the bucket appended with the region in which the deployment is to be made. example, if the deployment is to be made
  in us-east-1 create a bucket name as `\[BUCKET_NAME\]-us-east-1`.

- Create the distribution files using the script provided in the build section above.

- Create the S3 Key in the bucket `centralized-network-inspection/\[VERSION_ID\]/`

- Create the S3 Key in the bucket `centralized-network-inspection/latest/`

- Copy the file
  `./deployment/regional-s3-assets/centralized-network-inspection.zip` to
  the location
  `s3://\[BUCKET_NAME\]-\[REGION\]/centralized-network-inspection/\[VERSION_ID\]/`

- Copy the file
  `./deployment/regional-s3-assets/centralized-network-inspection-configuration.zip`
  to the location
  `s3://\[BUCKET_NAME\]-\[REGION\]/centralized-network-inspection/latest/`

Once the above steps are completed, use the file
`./deployment/global-s3-assets/centralized-network-inspection-on-aws.template` to create a stack in CloudFormation.

1.  Build the CDK code

```bash
cd source/
npm run build
```
2.  Build the Centralized Network Inspection guidance CodeBuild source code

```bash
cd source/centralizedNetworkInspection
tsc
```
3.  Build the templates for custom deployments

```bash
cd deployments/
chmod +x ./build-s3-dist.sh
./build-s3-dist.sh \[SOLUTION_DIST_BUCKET\]
centralized-network-inspection \[VERSION_ID\]
```

## Deployment Validation

[]{#running-the-guidance-required .anchor}
Run the following commands to validate the deployment:
```bash
cd \<rootDir\>/deployment
chmod +x ./run-unit-tests.sh
./run-unit-tests.sh
```

## Next Steps

Provide suggestions and recommendations about how customers can modify the parameters and the components of the Guidance to further enhance it
according to their requirements.

## Cleanup

Uninstall the guidance from the AWS Management Console or by using the [AWS
Command](https://aws.amazon.com/cli/) [Line Interface](https://aws.amazon.com/cli/) (AWS CLI).
Manually delete [several resources](#manually-uninstalling-resources) created by this guidance. This guidance doesn\'t automatically delete these resources in case you have stored data to retain.

### Using the AWS Management Console

1.  Sign in to the [CloudFormation console](https://console.aws.amazon.com/cloudformation/home).

2.  On the **Stacks** page, select this guidance\'s installation stack.

3.  Choose **Delete**.

### Using AWS Command Line Interface

Determine whether the AWS CLI is available in your environment. For
installation instructions, see [What Is the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) in the *AWS CLI User Guide*. After conﬁrming that the AWS CLI is available, run the following command.

### Manually uninstalling resources

The following resources will be retained even after the guidance is deleted. Refer to the following links to manually delete the resources:

- [AWS CodeCommit repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-delete-repository.html)

- [Amazon CloudWatch log groups](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html)

- [Amazon S3 CodePipeline artifact bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html)

- [Amazon S3 CodeBuild source code bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html)

- [AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-deleting.html)

- [AWS Network Firewall ﬁrewall policy](https://docs.aws.amazon.com/network-firewall/latest/developerguide/firewall-policy-deleting.html)

- [AWS Network Firewall rule groups](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-group-deleting.html)

- [Inspection VPC](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html#VPC_Deleting)

- [AWS Transit Gateway attachment](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#delete-vpc-attachment)

## FAQ, known issues, additional considerations, and limitations

**Known issues**

### Problem: Missing Network Firewall resources

The CloudFormation stack has completed successfully, but not all the Network Firewall resources are created.

#### Resolution

After the CloudFormation stack is complete, the CodePipeline stage created by the guidance might still be in the In-Progress state. Once the CodePipeline stage is completed, all the Network Firewall resources will be available in the AWS Network Firewall console.

### Problem: Failed CodePipeline stage

The CodePipeline stage is failing.

#### Resolution

If the CodePipeline stage is in Failed state, it means that this guidance hasn\'t been able to complete the create or update network ﬁrewall resources operation. Refer to the logs in the CodePipeline stages to ensure that the CodeBuild stages are successful.

If a JSON ﬁle is not valid or has incorrect information, the CodeBuild stage that validates the ﬁles will list the errors along with the ﬁle names.

For more information, refer to the [AWS CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html).

## Notices

Legal disclaimer

**Example:** *Customers are responsible for making their own independent assessment of the information in this Guidance. This Guidance: (a) is
for informational purposes only, (b) represents AWS current product offerings and practices, which are subject to change without notice, and
(c) does not create any commitments or assurances from AWS and its affiliates, suppliers or licensors. AWS products or services are
provided "as is" without warranties, representations, or conditions of any kind, whether express or implied. AWS responsibilities and
liabilities to its customers are controlled by AWS agreements, and this Guidance is not part of, nor does it modify, any agreement between AWS
and its customers.*

guidance-for-cross-network-traffic-inspection-with-aws-network-firewall

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README