Documentation

Welcome to the Proxylity's documentation. Here you will find information on how to use Proxylity, including configuration, features, and best practices. If you have any questions or need assistance, please feel free to contact us.

Why Proxylity?

Proxylity eliminates the cost and overhead of running network services on VMs (EC2, Fargate, EKS, etc.) by providing the network connections (IP addresses and ports) for your service traffic and delivering the packets that arrive on them to resources in your AWS account (Lambda, StepFunctions, S3, DDB, SNS, etc.). You have complete control over your data -- how and where it is processed and stored. Proxylity does not store or inspect network traffic beyond what's necessary to deliver it to your serverless backend (which is very little).

Getting Started

Once subscribed, there are two paths available for making use of Proxylity in your organization:

The "IaC First" approach in which UDP Gateway resources are created and managed using CloudFormation, and
The "Click Ops" approach where roles and resources are manually managed.

Proxylity supports either method of interacting with our services, but many organizations prefer an IaC-based approach, so let's start there.

Connecting Your AWS Account

To connect your AWS account to Proxylity, follow these steps:

First, subscribe to UDP Gateway from your AWS account.
Once subscribed, click the "Setup Product" button, then the "Setup Account" button which will take you to the Proxylity application.
To give permission to Proxylity to use resources in your account a Role is needed. The role will be assumed by Proxylity's services to operate. We recommend using per-destination, least privilege roles. To help with creating destination roles, we provide a template generator in under the "Account" section of the web application. Navigate there, select the services you'd like to use with UDP Gateway, then download the generated CloudFormation and deploy it to your account in the AWS CloudFormation console.

Listeners

Listeners in Proxylity represent the IP ports you've enabled and contain settings for the Destination(s) to which packets are to be delivered, and the Client Restrictions controlling which traffic sources (clients) to allow.

Destinations

Destinations in Proxylity represent the AWS resources that will receive the packets delivered by the UDP Gateway. This can be any AWS service that can be invoked via an API call, such as Lambda, Step Functions, Firehose, DynamoDB, SNS, SQS, S3, and CloudWatch Logs.

JSON Packet Format

Proxylity delivers packets to your AWS resources in a JSON format. This format includes metadata about the packet, such as the source IP address and port, as well as the packet data itself.

Multi-Region Destinations

Proxylity supports multi-region destinations, allowing you to deliver packets to AWS resources in multiple regions for increased availability and redundancy.

Batching Configuration

Proxylity supports batching of packets to reduce the number of API calls made to your AWS resources. This can help reduce costs and improve performance.

Proxylity Docs

Why Proxylity?

Getting Started

Connecting Your AWS Account

Listeners

Destinations

JSON Packet Format

Multi-Region Destinations

Batching Configuration