From 14c50ae86e84b05d1395293a001c4baa5d5f9fce Mon Sep 17 00:00:00 2001 From: biffgaut <78155736+biffgaut@users.noreply.github.com> Date: Fri, 6 May 2022 17:27:49 -0400 Subject: [PATCH] feat(aws-lambda-elasticachmemcached): New Construct (#675) * Interface Design * Initial implementation push * lint issue * cfn_nag on test resources * cfn_nag suppression * Add Python and Java min deployment * Results of self-review * Reponse to Code Review --- .../.eslintignore | 5 + .../.gitignore | 15 + .../.npmignore | 21 + .../aws-lambda-elasticachememcached/README.md | 120 ++++ .../architecture.png | Bin 0 -> 70415 bytes .../lib/index.ts | 157 +++++ .../package.json | 97 +++ .../integ.existingResources.expected.json | 622 +++++++++++++++++ .../test/integ.existingResources.ts | 58 ++ .../test/integ.newResources.expected.json | 638 ++++++++++++++++++ .../test/integ.newResources.ts | 37 + .../test/integ.withClientProps.expected.json | 638 ++++++++++++++++++ .../test/integ.withClientProps.ts | 43 ++ .../test/lambda-elasticachememcached.test.ts | 366 ++++++++++ .../test/lambda/index.js | 8 + .../@aws-solutions-constructs/core/index.ts | 2 + .../core/lib/elasticache-defaults.ts | 28 + .../core/lib/elasticache-helper.ts | 100 +++ .../core/lib/lambda-helper.ts | 10 +- .../core/lib/security-group-helper.ts | 33 + .../core/lib/utils.ts | 6 +- .../core/package.json | 1 + .../core/test/elasticache-defaults.test.ts | 35 + .../core/test/elasticache-helper.test.ts | 110 +++ .../core/test/security-group-helper.test.ts | 35 + .../core/test/test-helper.ts | 39 +- 26 files changed, 3219 insertions(+), 5 deletions(-) create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.eslintignore create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.gitignore create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.npmignore create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/README.md create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/architecture.png create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/lib/index.ts create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/package.json create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/integ.existingResources.expected.json create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/integ.existingResources.ts create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/integ.newResources.expected.json create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/integ.newResources.ts create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/integ.withClientProps.expected.json create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/integ.withClientProps.ts create mode 100755 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/lambda-elasticachememcached.test.ts create mode 100644 source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/test/lambda/index.js create mode 100644 source/patterns/@aws-solutions-constructs/core/lib/elasticache-defaults.ts create mode 100644 source/patterns/@aws-solutions-constructs/core/lib/elasticache-helper.ts create mode 100644 source/patterns/@aws-solutions-constructs/core/test/elasticache-defaults.test.ts create mode 100644 source/patterns/@aws-solutions-constructs/core/test/elasticache-helper.test.ts diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.eslintignore b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.eslintignore new file mode 100644 index 000000000..0819e2e65 --- /dev/null +++ b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.eslintignore @@ -0,0 +1,5 @@ +lib/*.js +test/*.js +*.d.ts +coverage +test/lambda/index.js \ No newline at end of file diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.gitignore b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.gitignore new file mode 100644 index 000000000..6773cabd2 --- /dev/null +++ b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.gitignore @@ -0,0 +1,15 @@ +lib/*.js +test/*.js +*.js.map +*.d.ts +node_modules +*.generated.ts +dist +.jsii + +.LAST_BUILD +.nyc_output +coverage +.nycrc +.LAST_PACKAGE +*.snk \ No newline at end of file diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.npmignore b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.npmignore new file mode 100644 index 000000000..f66791629 --- /dev/null +++ b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.npmignore @@ -0,0 +1,21 @@ +# Exclude typescript source and config +*.ts +tsconfig.json +coverage +.nyc_output +*.tgz +*.snk +*.tsbuildinfo + +# Include javascript files and typescript declarations +!*.js +!*.d.ts + +# Exclude jsii outdir +dist + +# Include .jsii +!.jsii + +# Include .jsii +!.jsii \ No newline at end of file diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/README.md b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/README.md new file mode 100644 index 000000000..889dd024d --- /dev/null +++ b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/README.md @@ -0,0 +1,120 @@ +# aws-lambda-elasticachememcached module + + +--- + +![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge) + +--- + + +| **Reference Documentation**:| https://docs.aws.amazon.com/solutions/latest/constructs/| +|:-------------|:-------------| +
+ +| **Language** | **Package** | +|:-------------|-----------------| +|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_elasticachememcached`| +|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-elasticachememcached`| +|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdaelasticachememcached`| + +This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon Elasticache Memcached cluster. + +Here is a minimal deployable pattern definition : + +Typescript +``` typescript +import { Construct } from 'constructs'; +import { Stack, StackProps } from 'aws-cdk-lib'; +import { LambdaToElasticachememcached } from '@aws-solutions-constructs/aws-lambda-elasticachememcached'; +import * as lambda from 'aws-cdk-lib/aws-lambda'; + +new LambdaToElasticachememcached(this, 'LambdaToElasticachememcachedPattern', { + lambdaFunctionProps: { + runtime: lambda.Runtime.NODEJS_14_X, + handler: 'index.handler', + code: lambda.Code.fromAsset(`lambda`) + } +}); +``` + +Python +```python +from aws_solutions_constructs.aws_lambda_elasticachememcached import LambdaToElasticachememcached +from aws_cdk import ( + aws_lambda as _lambda, + Stack +) +from constructs import Construct + +LambdaToElasticachememcached(self, 'LambdaToCachePattern', + lambda_function_props=_lambda.FunctionProps( + code=_lambda.Code.from_asset('lambda'), + runtime=_lambda.Runtime.PYTHON_3_9, + handler='index.handler' + ) + ) +``` + +Java +``` java +import software.constructs.Construct; + +import software.amazon.awscdk.Stack; +import software.amazon.awscdk.StackProps; +import software.amazon.awscdk.services.lambda.*; +import software.amazon.awscdk.services.lambda.Runtime; +import software.amazon.awsconstructs.services.lambdaelasticachememcached.*; + +new LambdaToElasticachememcached(this, "LambdaToCachePattern", new LambdaToElasticachememcachedProps.Builder() + .lambdaFunctionProps(new FunctionProps.Builder() + .runtime(Runtime.NODEJS_14_X) + .code(Code.fromAsset("lambda")) + .handler("index.handler") + .build()) + .build()); +``` + +## Pattern Construct Props + +| **Name** | **Type** | **Description** | +|:-------------|:----------------|-----------------| +|existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.| +|lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.FunctionProps.html)|Optional user provided props to override the default props for the Lambda function.| +|existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html)|An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon SQS. If an existing VPC is provided, the `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow clients to supply VPCs that exist outside the stack using the [`ec2.Vpc.fromLookup()`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.Vpc.html#static-fromwbrlookupscope-id-options) method.| +|vpcProps?|[`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.VpcProps.html)|Optional user provided properties to override the default properties for the new VPC. `subnetConfiguration` is set by the pattern, so any values for those properties supplied here will be overrriden. | +| cacheEndpointEnvironmentVariableName?| string | Lambda function environment variable name for the cache Endpoint. Defaults to CACHE_ENDPOINT | +| cacheProps? | [`cache.CfnCacheClusterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheClusterProps.html) | Optional user provided props to override the default props for the Elasticache Cluster. Providing both this and `existingCache` will cause an error. | +| existingCache? | [`cache.CfnCacheCluster`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.html#attrconfigurationendpointport) | Existing instance of Elasticache Cluster object, providing both this and `cacheProps` will cause an error. If you provide this, you must provide the associated VPC in existingVpc. | + +## Pattern Properties + +| **Name** | **Type** | **Description** | +|:-------------|:----------------|-----------------| +|lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|Returns an instance of the Lambda function used by the pattern.| +|vpc |[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-ec2.IVpc.html)|Returns an interface on the VPC used by the pattern. This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.| +| cache | [`cache.CfnCacheCluster`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.html#attrconfigurationendpointport) | The Elasticache Memcached cluster used by the construct. | + +## Default settings + +Out of the box implementation of the Construct without any override will set the following defaults: + +### AWS Lambda Function +* Configure limited privilege access IAM role for Lambda function +* Enable reusing connections with Keep-Alive for NodeJs Lambda function +* Enable X-Ray Tracing +* Attached to self referencing security group to grant access to cache +* Set Environment Variables + * (default) CACHE_ENDPOINT + * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions) + +### Amazon Elasticache Memcached Cluster +* Creates multi node, cross-az cluster by default + * 2 cache nodes, type: cache.t3.medium +* Self referencing security group attached to cluster endpoint + +## Architecture +![Architecture Diagram](architecture.png) + +*** +© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. \ No newline at end of file diff --git a/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/architecture.png b/source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..bf4e806999c9e6db98c33bfd503b12bed7d9096c GIT binary patch literal 70415 zcmeGE}J4zDTNxUC|H;$xO2}`Tz$%q0qHD8MMmjN62z @foh_04)JxQZlV{G!?B3gV@rll4&T
z`?it2F(i^Np?He+U{|FWeglDb|4CPZgpr_fT66?k#|H{_W0XuB?
zTRiBNbOVl^x>kFejM|QzxJWWqseyHIob`ne$=%8P`|Eumkm5%w;B3=k!!dI5(*}VI
z9{+(0j
5wWMexW6jU}rRgNSEm$(0`=C!c^l8ldj`2)aPHv^YfOZ#-Ja<
z?X)N*9l;m6PvNt%49XDaqP)kYVH&V95oc(Mx3D8vl38z(HZ;Um;Q`d;@!RZ)w3XOi
zrHnIZl4rS&wCZt^^EG?nZKI^ly^uWjj;a*cpj`Ky^%r3RQW~Gx`@ImW64!lN2&;ea
zk&%+JK)r=N1I^D(h15A*U--$u4D@nO0ih*a0lMJ44Q4kU9_xn-ayK7)#H}YCLL2l8
z3|4B+`23$DX`_8(hq`qy2Lv9HtMU-PmW!vUGW*y&Q=}P-O20g8NwAv}uq{ww#K1rp>K*!|+npu<*iFY(Kkc6=$