Merge pull request #298 from amirkaws/parameters-example

Author: hjgraca

examples/Parameters/.gitignore

@@ -0,0 +1,34 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30114.105
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{DF119D9D-FC8B-4ED3-9153-BB15250F29D0}") = "HelloWorld", "src\HelloWorld\HelloWorld.csproj", "{224EC34E-A942-4FD0-8EC2-9C4526066611}"
+EndProject
+Project("{DF119D9D-FC8B-4ED3-9153-BB15250F29D0}") = "HelloWorld.Tests", "test\HelloWorld.Test\HelloWorld.Tests.csproj", "{C22D9998-9C36-4AC3-B00E-DEC8491B1805}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HelloWorld.Cfn", "cfn\HelloWorld.Cfn\HelloWorld.Cfn.csproj", "{4923974C-33DA-4C80-B0EF-E3E18587351D}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{224EC34E-A942-4FD0-8EC2-9C4526066611}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{224EC34E-A942-4FD0-8EC2-9C4526066611}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{224EC34E-A942-4FD0-8EC2-9C4526066611}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{224EC34E-A942-4FD0-8EC2-9C4526066611}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C22D9998-9C36-4AC3-B00E-DEC8491B1805}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C22D9998-9C36-4AC3-B00E-DEC8491B1805}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C22D9998-9C36-4AC3-B00E-DEC8491B1805}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C22D9998-9C36-4AC3-B00E-DEC8491B1805}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4923974C-33DA-4C80-B0EF-E3E18587351D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4923974C-33DA-4C80-B0EF-E3E18587351D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4923974C-33DA-4C80-B0EF-E3E18587351D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4923974C-33DA-4C80-B0EF-E3E18587351D}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal

examples/Parameters/PowertoolsParametersExample.sln

@@ -0,0 +1,130 @@
+# Powertools for AWS Lambda (.NET) - Parameters Example
+
+This project contains source code and supporting files for a serverless application that you can deploy with the AWS Serverless Application Model Command Line Interface (AWS SAM CLI). It includes the following files and folders.
+
+* src - Code for the application's Lambda function and Project Dockerfile.
+* events - Invocation events that you can use to invoke the function.
+* test - Unit tests for the application code.
+* template.yaml - A template that defines the application's AWS resources.
+
+The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code.
+
+If you prefer to use an integrated development environment (IDE) to build and test your application, you can use the AWS Toolkit. The AWS Toolkit is an open source plug-in for popular IDEs that uses the AWS SAM CLI to build and deploy serverless applications on AWS. The AWS Toolkit also adds a simplified step-through debugging experience for Lambda function code. See the following links to get started.
+
+* [Visual Studio Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/welcome.html)
+* [Visual Studio](https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/welcome.html)
+* [Rider](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
+
+## Deploy the sample application
+
+The AWS SAM CLI is an extension of the AWS Command Line Interface (AWS CLI) that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API.
+
+To use the AWS SAM CLI, you need the following tools.
+
+* AWS SAM CLI - [Install the AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
+* Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community)
+
+You will need the following for local testing.
+* .NET 6.0 - [Install .NET 6.0](https://www.microsoft.com/net/download)
+
+To build and deploy your application for the first time, run the following in your shell. Make sure the `template.yaml` file is in your current directory:
+
+```bash
+sam build
+sam deploy --guided
+```
+
+The first command will build a docker image from a Dockerfile and then copy the source of your application inside the Docker image. The second command will package and deploy your application to AWS, with a series of prompts:
+
+* **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name.
+* **AWS Region**: The AWS region you want to deploy your app to.
+* **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes.
+* **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command.
+* **Save arguments to samconfig.toml**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application.
+
+You can find your API Gateway Endpoint URL in the output values displayed after deployment.
+
+This application creates some additional AWS resources. You can find them by navigating to their relevant AWS services in [AWS Management Console](console.aws.amazon.com) after deployment.
+
+| Resource Type    | AWS Service | Resource Name |
+| -------- | ------- | ------- |
+| Parameter | AWS Systems Manager Parameter Store | `/powertools-parameters-example/path/prefix/parameter`    |
+| Parameter | AWS Systems Manager Parameter Store | `/powertools-parameters-example/path/prefix/other-parameter`     |
+| Secret  | AWS Secrets Manager  | `PowertoolsParametersExampleSecret`   |
+| Table | Amazon DynamoDB  | `PowertoolsParametersExampleSingle`    |
+| Table | Amazon DynamoDB  | `PowertoolsParametersExampleMultiple`    |
+
+
+## Use the AWS SAM CLI to build and test locally
+
+Build your application with the `sam build` command.
+
+```bash
+Parameters$ sam build
+```
+
+The AWS SAM CLI builds a docker image from a Dockerfile and then installs dependencies defined in `src/HelloWorld.csproj` inside the docker image. The processed template file is saved in the `.aws-sam/build` folder.
+
+Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project.
+
+Run functions locally and invoke them with the `sam local invoke` command.
+
+```bash
+Parameters$ sam local invoke HelloWorldFunction --event events/event.json
+```
+
+The AWS SAM CLI can also emulate your application's API. Use the `sam local start-api` to run the API locally on port 3000.
+
+```bash
+Parameters$ sam local start-api
+Parameters$ curl http://localhost:3000/hello
+```
+
+The AWS SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The `Events` property on each function's definition includes the route and method for each path.
+
+```yaml
+      Events:
+        HelloWorld:
+          Type: Api
+          Properties:
+            Path: /hello
+            Method: get
+```
+
+## Add a resource to your application
+
+The application template uses AWS Serverless Application Model (AWS SAM) to define application resources. AWS SAM is an extension of AWS CloudFormation with a simpler syntax for configuring common serverless application resources such as functions, triggers, and APIs. For resources not included in [the AWS SAM specification](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md), you can use standard [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) resource types.
+
+## Fetch, tail, and filter Lambda function logs
+
+To simplify troubleshooting, AWS SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs generated by your deployed Lambda function from the command line. In addition to printing the logs on the terminal, this command has several nifty features to help you quickly find the bug.
+
+`NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM.
+
+```bash
+Parameters$ sam logs -n HelloWorldFunction --stack-name Parameters --tail
+```
+
+You can find more information and examples about filtering Lambda function logs in the [SAM CLI Documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html).
+
+## Unit tests
+
+Tests are defined in the `test` folder in this project.
+
+```bash
+Parameters$ dotnet test test/HelloWorld.Test
+```
+
+## Cleanup
+
+To delete the sample application that you created, use the AWS SAM CLI. Assuming you used your project name for the stack name, you can run the following:
+
+```bash
+Parameters$ sam delete
+```
+
+## Resources
+
+See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) for an introduction to SAM specification, the AWS SAM CLI, and serverless application concepts.
+
+Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/)

examples/Parameters/README.md

@@ -0,0 +1,37 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+
+namespace HelloWorld.Cfn;
+
+/// <summary>
+/// CloudFormation Custom Resource Request
+/// </summary>
+[Serializable]
+public class CfnRequest 
+{
+    public string? RequestType { get; set; }
+    
+    public string? ResponseURL { get; set; }
+    
+    public string? StackId { get; set; }
+    
+    public string? RequestId { get; set; }
+    
+    public string? ResourceType { get; set; }
+    
+    public string? LogicalResourceId { get; set; }
+}

examples/Parameters/cfn/HelloWorld.Cfn/CfnRequest.cs

@@ -0,0 +1,39 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+
+namespace HelloWorld.Cfn;
+
+/// <summary>
+/// CloudFormation Custom Resource Response
+/// </summary>
+[Serializable]
+public class CfnResponse
+{
+    public string? Status { get; set; }
+    
+    public string? Reason { get; set; }
+    
+    public string? PhysicalResourceId { get; set; }
+    
+    public string? StackId { get; set; }
+    
+    public string? RequestId { get; set; }
+    
+    public string? LogicalResourceId { get; set; }
+    
+    public bool NoEcho { get; set; }
+}

examples/Parameters/cfn/HelloWorld.Cfn/CfnResponse.cs

@@ -0,0 +1,149 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.Net;
+using System.Text;
+using System.Text.Json;
+using System.Threading.Tasks;
+using Amazon.DynamoDBv2;
+using Amazon.DynamoDBv2.Model;
+using Amazon.Lambda.Core;
+using Amazon.Lambda.Serialization.SystemTextJson;
+
+// Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class.
+[assembly: LambdaSerializer(typeof(DefaultLambdaJsonSerializer))]
+
+namespace HelloWorld.Cfn;
+
+public class Function
+{
+    public async Task FunctionHandler(object cfnRequest, ILambdaContext context)
+    {
+        var request = JsonSerializer.Deserialize<CfnRequest>(cfnRequest.ToString()!);
+        Console.Write(JsonSerializer.Serialize(request));
+
+        var response = new CfnResponse
+        {
+            StackId = request!.StackId,
+            RequestId = request.RequestId,
+            LogicalResourceId = request.LogicalResourceId,
+            PhysicalResourceId = "powertools_parameters_custom_physical_resource_id",
+            Status = "SUCCESS",
+            Reason = string.Empty,
+            NoEcho = false
+        };
+
+        try
+        {
+            switch (request.RequestType!.ToLower())
+            {
+                case "create":
+                    LambdaLogger.Log("Received Create request");
+                    await InsertSingleParameterForDynamoDBProvider().ConfigureAwait(false);
+                    await InsertMultipleParametersForDynamoDBProvider().ConfigureAwait(false);
+                    break;
+            }
+        }
+        catch (Exception ex)
+        {
+            LambdaLogger.Log($"Error:{ex.Message}");
+            response.Status = "FAILED";
+            response.Reason = ex.Message;
+        }
+
+        LambdaLogger.Log($"Sending response to {request.ResponseURL} ");
+        SendResponse(request.ResponseURL!, response);
+        LambdaLogger.Log("Finished");
+    }
+
+    private static void SendResponse(string url, CfnResponse cfnResponse)
+    {
+        var json = JsonSerializer.Serialize(cfnResponse);
+        var byteArray = Encoding.UTF8.GetBytes(json);
+
+        LambdaLogger.Log($"trying to upload json {json}");
+
+        var httpRequest = WebRequest.Create(url) as HttpWebRequest;
+        httpRequest.Method = "PUT";
+        //If ContentType is set to anything but "" your upload will fail
+        httpRequest.ContentType = "";
+        httpRequest.ContentLength = byteArray.Length;
+
+        using (var datastream = httpRequest.GetRequestStream())
+            datastream.Write(byteArray, 0, byteArray.Length);
+        var result = httpRequest.GetResponse() as HttpWebResponse;
+
+        LambdaLogger.Log($"Result of upload is {result.StatusCode}");
+    }
+
+    private async Task InsertSingleParameterForDynamoDBProvider()
+    {
+        LambdaLogger.Log($"Inserting single parameter for DynamoDBProvider...");
+
+        var client = new AmazonDynamoDBClient();
+
+        // Get DynamoDB partition key  
+        var tableName = Environment.GetEnvironmentVariable(EnvironmentVariableNames.DynamoDBSingleParameterTableName) ??
+                        "";
+
+        // Get DynamoDB partition key  
+        var hashKey = Environment.GetEnvironmentVariable(EnvironmentVariableNames.DynamoDBSingleParameterId) ?? "";
+
+        var request = new PutItemRequest
+        {
+            TableName = tableName,
+            Item = new Dictionary<string, AttributeValue>()
+            {
+                { "id", new AttributeValue { S = hashKey } },
+                { "value", new AttributeValue { S = "my-value" } }
+            }
+        };
+
+        await client.PutItemAsync(request).ConfigureAwait(false);
+    }
+
+    private async Task InsertMultipleParametersForDynamoDBProvider()
+    {
+        LambdaLogger.Log($"Inserting multiple parameters for DynamoDBProvider...");
+
+        var client = new AmazonDynamoDBClient();
+
+        // Get DynamoDB partition key  
+        var tableName =
+            Environment.GetEnvironmentVariable(EnvironmentVariableNames.DynamoDBMultipleParametersTableName) ?? "";
+
+        // Get DynamoDB partition key  
+        var hashKey =
+            Environment.GetEnvironmentVariable(EnvironmentVariableNames.DynamoDBMultipleParametersParameterId) ?? "";
+
+        for (var i = 1; i <= 3; i++)
+        {
+            var request = new PutItemRequest
+            {
+                TableName = tableName,
+                Item = new Dictionary<string, AttributeValue>()
+                {
+                    { "id", new AttributeValue { S = hashKey } },
+                    { "sk", new AttributeValue { S = $"param-{i}" } },
+                    { "value", new AttributeValue { S = $"my-value-{i}" } }
+                }
+            };
+
+            await client.PutItemAsync(request).ConfigureAwait(false);
+        }
+    }
+}