Update/add more docs, add netty openssl dependencies

Author: zoewangg

archetypes/archetype-lambda/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -20,6 +20,7 @@
       <includes>
         <include>.gitignore</include>
         <include>template.yaml</include>
+        <include>README.md</include>
       </includes>
     </fileSet>
   </fileSets>
@@ -40,5 +41,9 @@
     <requiredProperty key="region">
      <validationRegex>^\w+-(\w+-)+\d+$</validationRegex>
     </requiredProperty>
+    <!-- Required to pass the netty-open-ssl-version property from parent pom to velocity-->
+    <requiredProperty key="nettyOpenSslVersion">
+      <defaultValue>${netty-open-ssl-version}</defaultValue>
+    </requiredProperty>
   </requiredProperties>
 </archetype-descriptor>

archetypes/archetype-lambda/src/main/resources/archetype-resources/README.md

@@ -0,0 +1,45 @@
+#[[#]]# ${handlerClassName}
+
+This project contains an AWS Lambda maven application with [AWS Java SDK 2.x](https://github.com/aws/aws-sdk-java-v2) dependencies.
+
+#[[##]]# Prerequisites
+- Java 1.8+
+- Apache Maven
+- [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
+- Docker
+
+#[[##]]# Development
+
+The generated function handler class just returns the input. The configured AWS Java SDK client is created in `DependencyFactory` class and you can 
+add the code to interact with the SDK client based on your use case.
+
+#[[####]]# Building the project
+```
+mvn clean install
+```
+
+#[[####]]# Testing it locally
+```
+sam local invoke
+```
+
+#[[####]]# Adding more SDK clients
+To add more service clients, you need to add the specific services modules in `pom.xml` and create the clients in `DependencyFactory` following the same 
+pattern as ${serviceClientVariable}Client.
+
+#[[##]]# Deployment
+
+The generated project contains a default [SAM template](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) file `template.yaml` where you can 
+configure different properties of your lambda function such as memory size and timeout. You might also need to add specific policies to the lambda function
+so that it can access other AWS resources.
+
+To deploy the application, you can run the following command:
+
+```
+sam deploy --guided
+```
+
+See [Deploying Serverless Applications](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-deploying.html) for more info.
+
+
+

archetypes/archetype-lambda/src/main/resources/archetype-resources/pom.xml

@@ -31,6 +31,9 @@
         <aws.java.sdk.version>${javaSdkVersion}</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
         <junit5.version>5.4.2</junit5.version>
+#if( $httpClient == 'netty-nio-client')
+        <netty.openssl.version>${nettyOpenSslVersion}</netty.openssl.version>
+#end
     </properties>
 
     <dependencyManagement>
@@ -66,6 +69,15 @@
             <artifactId>${httpClient}</artifactId>
         </dependency>
 
+#if( $httpClient == 'netty-nio-client')
+        <!-- Adding netty-tcnative dependency so that netty async client uses openSSL as sslProvider if supported
+        See https://github.com/aws/aws-sdk-java-v2/blob/master/docs/BestPractices.md#use-openssl-for-netty-async-client -->
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-tcnative-boringssl-static</artifactId>
+            <version>${netty.openssl.version}</version>
+        </dependency>
+#end
         <dependency>
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-lambda-java-core</artifactId>

archetypes/archetype-lambda/src/main/resources/archetype-resources/src/main/java/DependencyFactory.java

@@ -17,7 +17,7 @@ private DependencyFactory() {}
     /**
      * @return an instance of ${serviceClientClassName}
      */
-    public static ${serviceClientClassName} ${service}Client() {
+    public static ${serviceClientClassName} ${serviceClientVariable}Client() {
         return ${serviceClientClassName}.builder()
                        .credentialsProvider(EnvironmentVariableCredentialsProvider.create())
                        .region(Region.${regionEnum})

archetypes/archetype-lambda/src/main/resources/archetype-resources/src/main/java/__handlerClassName__.java

@@ -12,18 +12,18 @@
  * @see <a href=https://docs.aws.amazon.com/lambda/latest/dg/java-handler.html>Lambda Java Handler</a> for more information
  */
 public class ${handlerClassName} implements RequestHandler<Object, Object> {
-    private final ${serviceClientClassName} ${service}Client;
+    private final ${serviceClientClassName} ${serviceClientVariable}Client;
 
     public ${handlerClassName}() {
         // Initialize the SDK client outside of the handler method so that it can be reused for subsequent invocations.
         // It is initialized when the class is loaded.
-        ${service}Client = DependencyFactory.${service}Client();
+        ${serviceClientVariable}Client = DependencyFactory.${serviceClientVariable}Client();
         // Consider invoking a simple api here to pre-warm up the application, eg: dynamodb#listTables
     }
 
     @Override
     public Object handleRequest(final Object input, final Context context) {
-        // TODO: invoking the api call using ${service}Client.
+        // TODO: invoking the api call using ${serviceClientVariable}Client.
         return input;
     }
 }

archetypes/archetype-lambda/src/main/resources/archetype-resources/template.yaml

@@ -10,4 +10,10 @@ Resources:
       Handler: ${package}.${handlerClassName}::handleRequest
       Timeout: 60
       MemorySize: 512
-      CodeUri: ./target/${artifactId}.jar
+      CodeUri: ./target/${artifactId}.jar
+      # Attach policies here to give the function permission to access other AWS resources if needed
+      # See: https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
+      # eg:
+      #Policies:
+      # - S3ReadPolicy:
+      #     BucketName: test-bucket

archetypes/archetype-lambda/src/main/resources/global.vm

@@ -1,14 +1,12 @@
 ## global variables used by the project
+#parse ("serviceMapping.vm")
 #set( $symbol_pound = '#' )
 #set( $symbol_dollar = '$' )
 #set( $symbol_escape = '\' )
-## TODO: there is no easy way to map service module artifactId to the client name derived the service name
-## As a workaround: mapping the common service here
-#if( $service == 'dynamodb')
-    #set ( $service = 'dynamoDb')
-#end
-#set ( $servicePackage = $service.toLowerCase())
-#set( $serviceClientPrefix = $service.substring(0,1).toUpperCase() + $service.substring(1))
+## map the serviceId to service package and service client class name
+#set ( $servicePackage = $service)
+#set( $serviceClientPrefix = $serviceMapping[$service])
+#set ( $serviceClientVariable = $serviceClientPrefix.substring(0,1).toLowerCase() + $serviceClientPrefix.substring(1))
 #set( $regionEnum = $region.replace("-", "_").toUpperCase() )
 ## map the client module name to the client class name and pacakge name
 #if( $httpClient == 'url-connection-client')
@@ -24,6 +22,3 @@
     #set ($httpClientPackageName = 'nio.netty.' + $httpClientClassName)
     #set ($serviceClientClassName = $serviceClientPrefix + 'AsyncClient')
 #end
-## map the serviceId to service package and service client class name
-#set( $servicePackage = $service.toLowerCase())
-#set( $serviceClientPrefix = $service.substring(0,1).toUpperCase() + $service.substring(1))

archetypes/archetype-lambda/src/main/resources/serviceMapping.vm

@@ -0,0 +1 @@
+#set ( $serviceMapping ={"detective": "Detective", "efs": "Efs", "shield": "Shield", "connectparticipant": "ConnectParticipant", "datapipeline": "DataPipeline", "kafka": "Kafka", "appstream": "AppStream", "dlm": "Dlm", "pinpointemail": "PinpointEmail", "glue": "Glue", "route53": "Route53", "sesv2": "SesV2", "storagegateway": "StorageGateway", "ses": "Ses", "resourcegroupstaggingapi": "ResourceGroupsTaggingApi", "personalizeruntime": "PersonalizeRuntime", "alexaforbusiness": "AlexaForBusiness", "qldb": "Qldb", "cloud9": "Cloud9", "appmesh": "AppMesh", "dynamodb": "DynamoDb", "cloudhsmv2": "CloudHsmV2", "elasticbeanstalk": "ElasticBeanstalk", "cognitosync": "CognitoSync", "marketplaceentitlement": "MarketplaceEntitlement", "health": "Health", "kinesisvideo": "KinesisVideo", "cognitoidentity": "CognitoIdentity", "cloudwatchlogs": "CloudWatchLogs", "securityhub": "SecurityHub", "kinesis": "Kinesis", "polly": "Polly", "datasync": "DataSync", "autoscaling": "AutoScaling", "pinpointsmsvoice": "PinpointSmsVoice", "ssm": "Ssm", "sso": "Sso", "transcribestreaming": "TranscribeStreaming", "kinesisanalyticsv2": "KinesisAnalyticsV2", "dax": "Dax", "ssooidc": "SsoOidc", "apigateway": "ApiGateway", "medialive": "MediaLive", "groundstation": "GroundStation", "lexruntime": "LexRuntime", "snowball": "Snowball", "appconfig": "AppConfig", "mediaconvert": "MediaConvert", "macie": "Macie", "marketplacecatalog": "MarketplaceCatalog", "secretsmanager": "SecretsManager", "emr": "Emr", "iot1clickdevices": "Iot1ClickDevices", "dataexchange": "DataExchange", "forecastquery": "Forecastquery", "opsworks": "OpsWorks", "iotthingsgraph": "IoTThingsGraph", "imagebuilder": "Imagebuilder", "mediapackage": "MediaPackage", "lightsail": "Lightsail", "xray": "XRay", "migrationhub": "MigrationHub", "connect": "Connect", "ebs": "Ebs", "qldbsession": "QldbSession", "iotevents": "IotEvents", "computeoptimizer": "ComputeOptimizer", "appsync": "AppSync", "iot1clickprojects": "Iot1ClickProjects", "pinpoint": "Pinpoint", "workdocs": "WorkDocs", "cloudwatchevents": "CloudWatchEvents", "sms": "Sms", "cloudwatch": "CloudWatch", "forecast": "Forecast", "route53domains": "Route53Domains", "kms": "Kms", "budgets": "Budgets", "applicationdiscovery": "ApplicationDiscovery", "sts": "Sts", "applicationautoscaling": "ApplicationAutoScaling", "personalize": "Personalize", "robomaker": "RoboMaker", "databasemigration": "DatabaseMigration", "frauddetector": "FraudDetector", "guardduty": "GuardDuty", "comprehendmedical": "ComprehendMedical", "ecs": "Ecs", "ecr": "Ecr", "codebuild": "CodeBuild", "directconnect": "DirectConnect", "mediastore": "MediaStore", "opsworkscm": "OpsWorksCm", "codestar": "CodeStar", "rds": "Rds", "gamelift": "GameLift", "quicksight": "QuickSight", "mediapackagevod": "MediaPackageVod", "firehose": "Firehose", "elasticsearch": "Elasticsearch", "outposts": "Outposts", "waf": "Waf", "licensemanager": "LicenseManager", "networkmanager": "NetworkManager", "elasticache": "ElastiCache", "eks": "Eks", "support": "Support", "kinesisvideoarchivedmedia": "KinesisVideoArchivedMedia", "lambda": "Lambda", "devicefarm": "DeviceFarm", "backup": "Backup", "redshift": "Redshift", "codegurureviewer": "CodeGuruReviewer", "cloudformation": "CloudFormation", "autoscalingplans": "AutoScalingPlans", "mediaconnect": "MediaConnect", "transcribe": "Transcribe", "textract": "Textract", "chime": "Chime", "iotdataplane": "IotDataPlane", "comprehend": "Comprehend", "iotanalytics": "IoTAnalytics", "iam": "Iam", "costexplorer": "CostExplorer", "eventbridge": "EventBridge", "importexport": "ImportExport", "machinelearning": "MachineLearning", "s3control": "S3Control", "transfer": "Transfer", "resourcegroups": "ResourceGroups", "serverlessapplicationrepository": "ServerlessApplicationRepository", "fms": "Fms", "ioteventsdata": "IotEventsData", "swf": "Swf", "kinesisvideosignaling": "KinesisVideoSignaling", "cloudsearchdomain": "CloudSearchDomain", "workmailmessageflow": "WorkMailMessageFlow", "acmpca": "AcmPca", "servicediscovery": "ServiceDiscovery", "rdsdata": "RdsData", "translate": "Translate", "athena": "Athena", "applicationinsights": "ApplicationInsights", "lexmodelbuilding": "LexModelBuilding", "ec2instanceconnect": "Ec2InstanceConnect", "codeguruprofiler": "CodeGuruProfiler", "mturk": "MTurk", "cloudfront": "CloudFront", "ec2": "Ec2", "sagemakera2iruntime": "SageMakerA2IRuntime", "route53resolver": "Route53Resolver", "managedblockchain": "ManagedBlockchain", "kinesisanalytics": "KinesisAnalytics", "kendra": "Kendra", "codepipeline": "CodePipeline", "elastictranscoder": "ElasticTranscoder", "organizations": "Organizations", "pi": "Pi", "servicecatalog": "ServiceCatalog", "apigatewayv2": "ApiGatewayV2", "servicequotas": "ServiceQuotas", "marketplacemetering": "MarketplaceMetering", "batch": "Batch", "codecommit": "CodeCommit", "mq": "Mq", "iotsecuretunneling": "IoTSecureTunneling", "costandusagereport": "CostAndUsageReport", "signer": "Signer", "migrationhubconfig": "MigrationHubConfig", "codestarnotifications": "CodestarNotifications", "elasticloadbalancing": "ElasticLoadBalancing", "pricing": "Pricing", "kinesisvideomedia": "KinesisVideoMedia", "rekognition": "Rekognition", "cloudtrail": "CloudTrail", "elasticloadbalancingv2": "ElasticLoadBalancingV2", "personalizeevents": "PersonalizeEvents", "ram": "Ram", "mediatailor": "MediaTailor", "cloudhsm": "CloudHsm", "apigatewaymanagementapi": "ApiGatewayManagementApi", "cloudsearch": "CloudSearch", "acm": "Acm", "inspector": "Inspector", "lakeformation": "LakeFormation", "elasticinference": "ElasticInference", "schemas": "Schemas", "amplify": "Amplify", "globalaccelerator": "GlobalAccelerator", "s3": "S3", "clouddirectory": "CloudDirectory", "accessanalyzer": "AccessAnalyzer", "greengrass": "Greengrass", "worklink": "WorkLink", "sagemaker": "SageMaker", "config": "Config", "workspaces": "WorkSpaces", "savingsplans": "Savingsplans", "sqs": "Sqs", "iot": "Iot", "codestarconnections": "CodeStarConnections", "sfn": "Sfn", "directory": "Directory", "marketplacecommerceanalytics": "MarketplaceCommerceAnalytics", "sns": "Sns", "mediastoredata": "MediaStoreData", "workmail": "WorkMail", "cognitoidentityprovider": "CognitoIdentityProvider", "codedeploy": "CodeDeploy", "iotjobsdataplane": "IotJobsDataPlane", "mobile": "Mobile", "docdb": "DocDb", "neptune": "Neptune", "wafv2": "Wafv2", "glacier": "Glacier", "fsx": "FSx", "sagemakerruntime": "SageMakerRuntime"})

archetypes/archetype-lambda/src/test/resources/projects/apachehttpclient/archetype.properties

@@ -6,4 +6,5 @@ service=dynamodb
 httpClient=apache-client
 handlerClassName=MyApacheFunction
 region=ap-southeast-1
-javaSdkVersion=2.11.0
+javaSdkVersion=2.11.0
+nettyOpenSslVersion=2.0.29.Final

archetypes/archetype-lambda/src/test/resources/projects/apachehttpclient/reference/README.md

@@ -0,0 +1,45 @@
+# MyApacheFunction
+
+This project contains an AWS Lambda maven application with [AWS Java SDK 2.x](https://github.com/aws/aws-sdk-java-v2) dependencies.
+
+## Prerequisites
+- Java 1.8+
+- Apache Maven
+- [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
+- Docker
+
+## Development
+
+The generated function handler class just returns the input. The configured AWS Java SDK client is created in `DependencyFactory` class and you can 
+add the code to interact with the SDK client based on your use case.
+
+#### Building the project
+```
+mvn clean install
+```
+
+#### Testing it locally
+```
+sam local invoke
+```
+
+#### Adding more SDK clients
+To add more service clients, you need to add the specific services modules in `pom.xml` and create the clients in `DependencyFactory` following the same 
+pattern as dynamoDbClient.
+
+## Deployment
+
+The generated project contains a default [SAM template](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) file `template.yaml` where you can 
+configure different properties of your lambda function such as memory size and timeout. You might also need to add specific policies to the lambda function
+so that it can access other AWS resources.
+
+To deploy the application, you can run the following command:
+
+```
+sam deploy --guided
+```
+
+See [Deploying Serverless Applications](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-deploying.html) for more info.
+
+
+

archetypes/archetype-lambda/src/test/resources/projects/apachehttpclient/reference/template.yaml

@@ -10,4 +10,10 @@ Resources:
       Handler: software.amazonaws.test.MyApacheFunction::handleRequest
       Timeout: 60
       MemorySize: 512
-      CodeUri: ./target/test-apache-artifact.jar
+      CodeUri: ./target/test-apache-artifact.jar
+      # Attach policies here to give the function permission to access other AWS resources if needed
+      # See: https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
+      # eg:
+      #Policies:
+      # - S3ReadPolicy:
+      #     BucketName: test-bucket

archetypes/archetype-lambda/src/test/resources/projects/nettyclient/archetype.properties

@@ -7,4 +7,5 @@ httpClient=netty-nio-client
 handlerClassName=MyNettyFunction
 region=us-east-1
 javaSdkVersion=2.11.0
+nettyOpenSslVersion=2.0.29.Final
 

archetypes/archetype-lambda/src/test/resources/projects/nettyclient/reference/README.md

@@ -0,0 +1,45 @@
+# MyNettyFunction
+
+This project contains an AWS Lambda maven application with [AWS Java SDK 2.x](https://github.com/aws/aws-sdk-java-v2) dependencies.
+
+## Prerequisites
+- Java 1.8+
+- Apache Maven
+- [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
+- Docker
+
+## Development
+
+The generated function handler class just returns the input. The configured AWS Java SDK client is created in `DependencyFactory` class and you can 
+add the code to interact with the SDK client based on your use case.
+
+#### Building the project
+```
+mvn clean install
+```
+
+#### Testing it locally
+```
+sam local invoke
+```
+
+#### Adding more SDK clients
+To add more service clients, you need to add the specific services modules in `pom.xml` and create the clients in `DependencyFactory` following the same 
+pattern as kinesisClient.
+
+## Deployment
+
+The generated project contains a default [SAM template](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-function.html) file `template.yaml` where you can 
+configure different properties of your lambda function such as memory size and timeout. You might also need to add specific policies to the lambda function
+so that it can access other AWS resources.
+
+To deploy the application, you can run the following command:
+
+```
+sam deploy --guided
+```
+
+See [Deploying Serverless Applications](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-deploying.html) for more info.
+
+
+

archetypes/archetype-lambda/src/test/resources/projects/nettyclient/reference/pom.xml

@@ -31,6 +31,7 @@
         <aws.java.sdk.version>2.11.0</aws.java.sdk.version>
         <aws.lambda.java.version>1.2.0</aws.lambda.java.version>
         <junit5.version>5.4.2</junit5.version>
+        <netty.openssl.version>2.0.29.Final</netty.openssl.version>
     </properties>
 
     <dependencyManagement>
@@ -66,6 +67,13 @@
             <artifactId>netty-nio-client</artifactId>
         </dependency>
 
+        <!-- Adding netty-tcnative dependency so that netty async client uses openSSL as sslProvider if supported
+        See https://github.com/aws/aws-sdk-java-v2/blob/master/docs/BestPractices.md#use-openssl-for-netty-async-client -->
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty-tcnative-boringssl-static</artifactId>
+            <version>${netty.openssl.version}</version>
+        </dependency>
         <dependency>
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-lambda-java-core</artifactId>

archetypes/archetype-lambda/src/test/resources/projects/nettyclient/reference/template.yaml

@@ -10,4 +10,10 @@ Resources:
       Handler: software.amazonaws.test.MyNettyFunction::handleRequest
       Timeout: 60
       MemorySize: 512
-      CodeUri: ./target/test-netty-artifact.jar
+      CodeUri: ./target/test-netty-artifact.jar
+      # Attach policies here to give the function permission to access other AWS resources if needed
+      # See: https://github.com/awslabs/serverless-application-model/blob/master/docs/policy_templates.rst
+      # eg:
+      #Policies:
+      # - S3ReadPolicy:
+      #     BucketName: test-bucket

archetypes/archetype-lambda/src/test/resources/projects/urlhttpclient/archetype.properties

@@ -6,4 +6,5 @@ service=s3
 httpClient=url-connection-client
 handlerClassName=App
 region=us-west-2
-javaSdkVersion=2.11.0
+javaSdkVersion=2.11.0
+nettyOpenSslVersion=2.0.29.Final