aws-ipranges-api.md

Amazon API Gateway (aws-ipranges-api)

Deployment via CloudFormation console

Download aws-ipranges-api.yaml file and login to AWS CloudFormation console. Choose Create Stack, Upload a template file, Choose File, select aws-ipranges-api.yaml and choose Next.

CloudFormation Parameters

Specify a Stack name and adjust parameters values as desired. Parameters options include

HTTP API

• allowNetworks: Source IP prefixes that are authorized to use API separated by commas. Default is 0.0.0.0/0
• awsServices: Names of AWS service to return by root URL separated by commas. Default is CLOUDFRONT_ORIGIN_FACING

Lambda

• pythonRuntime: Python runtime version. Default is python3.12
• cpuArchitecture: instruction set architecture, either x86_64 or arm64. Default is arm64

Custom domain name (optional)

This section is optional

• customDomainName: custom domain name
• certificateArn: ARN of ACM certificate
• disableDefaultEndPoint: option to disable default endpoint. This ensures that clients can only access API by using specifiedcustomDomainName

Continue Next with Configure stack options, Review settings, and click Create Stack to launch your stack.

After stack has been successfully created, its status changes to CREATE_COMPLETE.

CloudFormation Outputs

The following are available in Outputs section

• apiGatewayInvokeURL (if disableDefaultEndPoint is No ): URL of format https://<api-id>.execute-api.<region>.amazonaws.com

• apiFQDN (if customDomainName is specified): Create a DNS CNAME or Route 53 alias record of your customDomainName to this value

• apiGatewayLog: CloudWatch log URL for API Gateway

• lambdaFunctionLog: CLoudWatch log URL for Lambda function

• lambdaAuthorizerFunctionLog: CloudWatch log URL for Lambda authorizer function

API Gateway Customisation

Refer to Amazon API Gateway documentation for HTTP API customisation options. Some examples include

• Routing traffic to an Amazon API Gateway API by using your domain name
• Configuring mutual TLS authentication
• Throttling requests to your HTTP API

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.