The SAM template deploys an Amazon API Gateway REST API endpoint that uses a Resource Policy for access control. The Resource Policy explicitly blacklists a list of IP ranges and also explicitly whitelists another list of IP ranges. If allowed by the Resource Policy, API Gateway will forward the request to a Lambda function which will output the received event object.
Note: when deploying this pattern, CAPABILITY_IAM is required.
Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/apigw-resource-policy
Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
- Create an AWS account if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
- AWS CLI installed and configured
- Git Installed
- AWS Serverless Application Model (AWS SAM) installed
-
Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:
git clone https://github.com/aws-samples/serverless-patterns -
Change directory to the pattern directory:
cd apigw-resource-policy -
From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:
sam deploy -g -
During the prompts:
- Enter a stack name
- Select the desired AWS Region
- Enter the desired CIDR blocks to blacklist separated by commas. I.e. 1.1.1.1/16,2.2.2.2 . If no CIDR blocks are provided, the default sample "10.20.30.40, 1.0.0.0/16" will be used.
- Choose the desired CIDR blocks to whitelist separated by commas. I.e. 3.3.3.3/24,4.4.4.4 . If no CIDR blocks are provided, the default sample "10.20.30.41, 1.1.0.0/16" will be used.
- Allow SAM to create roles with the required permissions if needed.
Once you have run guided mode once, you can use
sam deployin future to use these defaults. -
Note the outputs from the SAM deployment process. These contain the resource names and/or ARNs which are used for testing.
The stack will output the api endpoint. Visit that URL in your browser or make an HTTP request to the endpoint using curl to test the Resource Policy.
- Delete the stack
sam delete
- Confirm the stack has been deleted
aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'STACK_NAME')].StackStatus"
Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0