Add final pattern.json file

Author: bfreiberg

apigw-secretsmanager-apikey-cdk/apigws-secretsmanager-apikey-cdk.json

@@ -0,0 +1,97 @@
+{
+    "title": "API Gateway, Lambda Authorizer & Secrets Manager for API Key Authentication",
+    "description": "Implement a secure API key-based authorization system using Amazon API Gateway, Lambda Authorizer, and AWS Secrets Manager.",
+    "language": "TypeScript",
+    "level": "200",
+    "framework": "CDK",
+    "introBox": {
+        "headline": "How it works",
+        "text": [
+            "This pattern demonstrates how to implement a secure API key-based authorization system using Amazon API Gateway, Lambda Authorizer, and AWS Secrets Manager.",
+            "Each user/tenant has their own unique API key stored in Secrets Manager, which is validated by a Lambda authorizer when requests are made to protected API endpoints.",
+            "The Lambda authorizer checks if the API key exists in Secrets Manager. If the key is valid, the associated tenant information is retrieved and included in the authorization context.",
+            "The API Gateway then allows or denies access to the protected endpoint based on the policy returned by the authorizer."
+        ]
+    },
+    "gitHub": {
+        "template": {
+            "repoURL": "https://github.com/aws-samples/serverless-patterns/tree/main/apigw-secretsmanager-apikey-cdk",
+            "templateURL": "serverless-patterns/apigw-secretsmanager-apikey-cdk",
+            "projectFolder": "apigw-secretsmanager-apikey-cdk",
+            "templateFile": "lib/apigw-secretsmanager-apikey-stack.ts"
+        }
+    },
+    "resources": {
+        "bullets": [
+            {
+                "text": "Lambda Authorizers for Amazon API Gateway",
+                "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html"
+            },
+            {
+                "text": "AWS Secrets Manager User Guide",
+                "link": "https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html"
+            },
+            {
+                "text": "Amazon API Gateway - REST APIs",
+                "link": "https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html"
+            }
+        ]
+    },
+    "deploy": {
+        "text": [
+            "npm install",
+            "cdk deploy"
+        ]
+    },
+    "testing": {
+        "text": [
+            "Create an API key using the provided script: <code>./create_api_key.sh sample-tenant</code>",
+            "Make a request to the protected endpoint using the valid API key: <code>curl -H \"x-api-key: CREATED_API_KEY\" https://REPLACE_WITH_CREATED_API_URL.amazonaws.com/prod/protected</code>",
+            "If successful, you should receive a response: <code>{ \"message\": \"Access granted\" }</code>"
+        ]
+    },
+    "cleanup": {
+        "text": [
+            "Delete the CDK stack: <code>cdk destroy</code>",
+            "Delete created SecretManager keys using the provided script: <code>./remove_secrets.sh</code>"
+        ]
+    },
+    "authors": [
+        {
+            "name": "Marco Jahn",
+            "image": "https://sessionize.com/image/e99b-400o400o2-pqR4BacUSzHrq4fgZ4wwEQ.png",
+            "bio": "Senior Solutions Architect - ISV, Amazon Web Services",
+            "linkedin": "marcojahn"
+        }
+    ],
+    "patternArch": {
+        "icon1": {
+            "x": 20,
+            "y": 50,
+            "service": "apigw",
+            "label": "API Gateway REST API"
+        },
+        "icon2": {
+            "x": 50,
+            "y": 50,
+            "service": "lambda",
+            "label": "AWS Lambda Authorizer"
+        },
+        "icon3": {
+            "x": 80,
+            "y": 50,
+            "service": "secretsmanager",
+            "label": "AWS Secrets Manager"
+        },
+        "line1": {
+            "from": "icon1",
+            "to": "icon2",
+            "label": "Authorizer"
+        },
+        "line2": {
+            "from": "icon2",
+            "to": "icon3",
+            "label": "Request secret"
+        }
+    }
+}