-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
3,275 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,5 +6,5 @@ | |
| "./patterns/@aws-solutions-constructs/*" | ||
| ], | ||
| "rejectCycles": "true", | ||
| "version": "1.152.0" | ||
| "version": "1.154.0" | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,5 +6,5 @@ | |
| "./patterns/@aws-solutions-constructs/*" | ||
| ], | ||
| "rejectCycles": "true", | ||
| "version": "2.5.0" | ||
| "version": "2.7.0" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.eslintignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| lib/*.js | ||
| test/*.js | ||
| *.d.ts | ||
| coverage | ||
| test/lambda/index.js |
15 changes: 15 additions & 0 deletions
15
source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
21 changes: 21 additions & 0 deletions
21
source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/.npmignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
120 changes: 120 additions & 0 deletions
120
...ce/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # aws-lambda-elasticachememcached module | ||
| <!--BEGIN STABILITY BANNER--> | ||
|
|
||
| --- | ||
|
|
||
|  | ||
|
|
||
| --- | ||
| <!--END STABILITY BANNER--> | ||
|
|
||
| | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>| | ||
| |:-------------|:-------------| | ||
| <div style="height:8px"></div> | ||
|
|
||
| | **Language** | **Package** | | ||
| |:-------------|-----------------| | ||
| | Python|`aws_solutions_constructs.aws_lambda_elasticachememcached`| | ||
| | Typescript|`@aws-solutions-constructs/aws-lambda-elasticachememcached`| | ||
| | 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 | ||
|  | ||
|
|
||
| *** | ||
| © Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. |
Binary file added
BIN
+68.8 KB
...erns/@aws-solutions-constructs/aws-lambda-elasticachememcached/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.