example-pattern.json

{
  "title": "Amazon API Gateway to Amazon S3 direct proxy with async AWS Lambda processing",
  "description": "Amazon API Gateway to S3 direct proxy - File upload triggers .NET 8.0 Lambda function",
  "language": ".NET",
  "level": "300",
  "framework": "AWS SAM",
  "introBox": {
    "headline": "How it works",
    "text": [
        "This pattern shows how to create an Amazon API Gateway REST API with a direct proxy to an Amazon S3 bucket. The API allows files to be uploaded to the S3 bucket. An AWS Lambda authorizer authorizes the incoming HTTP requests. The S3 upload asynchronously triggers a Lambda function to process the uploaded file.",
        "An Amazon API Gateway REST API is deployed, one AWS Lambda Authorizer, one Amazon S3 bucket, and one AWS Lambda that will be triggered after a file is uploaded.",
        "The Amazon API Gateway is defined in the AWS Serverless Application Model (SAM) template.yaml file using the OpenAPI specification."
    ]
  },
  "gitHub": {
    "template": {
      "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/apigw-direct-s3-lambda-dotnet",
      "templateURL": "apigw-direct-s3-lambda-dotnet",
      "projectFolder": "apigw-direct-s3-lambda-dotnet",
      "templateFile": "template.yaml"
    }
  },
  "resources": {
    "bullets": [
      {
        "text": "Tutorial: Create a REST API as an Amazon S3 proxy in API Gateway",
        "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-s3.html"
      },
      {
        "text": "Create RESTful APIs on AWS with OpenAPI Specification (With No Coding)",
        "link": "https://aws.amazon.com/blogs/opensource/create-restful-apis-on-aws-with-openapi-specification-with-no-coding/"
      },
      {
        "text": "Use API Gateway Lambda authorizers",
        "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html"
      },
      {
        "text": "Tutorial: Using an Amazon S3 trigger to invoke a Lambda function",
        "link": "https://docs.aws.amazon.com/lambda/latest/dg/with-s3-example.html"
      }
    ]
  },
  "deploy": {
    "text": [
      "sam build",
      "sam deploy --guided"
    ]
  },
  "testing": {
    "text": [
      "See the GitHub repo for detailed testing instructions."
    ]
  },
  "cleanup": {
    "text": [
      "Delete the stack: sam delete"
    ]
  },
  "authors": [
    {
      "name": "Chris Nelson",
      "image": "https://avatars.githubusercontent.com/u/4291796?v=4",
      "bio": "Sr. Solutions Architect at Amazon Web Services (AWS)",
      "linkedin": "chrisnelsonstcloud",
      "twitter": ""
    }
  ]
}