Merge pull request #795 from serverless/compose-example

feat(compose): add SAM/CFN + Compose example

Author: eahefnawy

compose/cloudformation-compose-service/template.yml

@@ -0,0 +1,20 @@
+AWSTemplateFormatVersion: "2010-09-09"
+
+Resources:
+  SharedTable:
+    Type: "AWS::DynamoDB::Table"
+    Properties:
+      TableName: ${param:tableNamePrefix}-${param:stageLabel}
+      AttributeDefinitions:
+        - AttributeName: "Id"
+          AttributeType: "S"
+      KeySchema:
+        - AttributeName: "Id"
+          KeyType: "HASH"
+      ProvisionedThroughput:
+        ReadCapacityUnits: 5
+        WriteCapacityUnits: 5
+
+Outputs:
+  TableName:
+    Value: !Ref SharedTable

compose/sam-compose-service/handler.js

@@ -0,0 +1,9 @@
+exports.handler = async (event) => {
+  return {
+    tableName: process.env.TABLE_NAME,
+    stageLabel: process.env.STAGE_LABEL,
+    service: "sam-compose-service",
+    message:
+      "This is the staged table name that was constructed using the compose outputs and params",
+  };
+};

compose/sam-compose-service/samconfig.toml

@@ -0,0 +1,5 @@
+version = 0.1
+
+[default]
+[default.global.parameters]
+stack_name = "sam-compose-service-example"

compose/sam-compose-service/template.yml

@@ -0,0 +1,34 @@
+AWSTemplateFormatVersion: "2010-09-09"
+Transform: AWS::Serverless-2016-10-31
+Description: >
+  sam-app
+
+  Sample SAM Template for sam-app
+
+Globals:
+  Function:
+    Timeout: 3
+    MemorySize: 128
+
+Resources:
+  HelloWorldFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      Handler: handler.handler
+      Runtime: nodejs20.x
+      Environment:
+        Variables:
+          TABLE_NAME: ${param:tableName}
+          STAGE_LABEL: ${param:stageLabel}
+      Architectures:
+        - x86_64
+      Events:
+        Api:
+          Type: HttpApi
+          Properties:
+            Path: /
+            Method: GET
+
+Outputs:
+  Endpoint:
+    Value: !Sub "https://${ServerlessHttpApi}.execute-api.${AWS::Region}.amazonaws.com"

compose/serverless-compose.yml

@@ -0,0 +1,31 @@
+# This example shows how to use Serverless Compose
+# to compose 3 services together:
+#   - A CloudFormation service
+#   - A traditional Serverless Framework service
+#   - A SAM service
+# It specifically shows how to pass parameters between services
+# and how to reference outputs from one service in another service.
+
+stages:
+  default:
+    params:
+      stageLabel: "testing"
+  prod:
+    params:
+      stageLabel: "production"
+
+services:
+  cloudformation-compose-service:
+    path: cloudformation-compose-service
+    params:
+      tableNamePrefix: compose-shared-table
+
+  traditional-compose-service:
+    path: traditional-compose-service
+    params:
+      tableName: ${cloudformation-compose-service.TableName}
+
+  sam-compose-service:
+    path: sam-compose-service
+    params:
+      tableName: ${cloudformation-compose-service.TableName}

compose/traditional-compose-service/handler.js

@@ -0,0 +1,9 @@
+exports.handler = async (event) => {
+  return {
+    tableName: process.env.TABLE_NAME,
+    stageLabel: process.env.STAGE_LABEL,
+    service: "traditional-compose-service",
+    message:
+      "This is the staged table name that was constructed using the compose outputs and params",
+  };
+};

compose/traditional-compose-service/serverless.yml

@@ -0,0 +1,16 @@
+service: traditional-compose-service
+
+provider:
+  name: aws
+  runtime: nodejs20.x
+
+functions:
+  hello:
+    handler: handler.handler
+    events:
+      - httpApi:
+          path: /
+          method: get
+    environment:
+      TABLE_NAME: ${param:tableName}
+      STAGE_LABEL: ${param:stageLabel}