@aws-solutions-constructs/aws-lambda-elasticachememcached 2.8.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "@aws-solutions-constructs/core": "2.8.0",
11
+ "@aws-solutions-constructs/core": "2.9.0",
12
12
  "aws-cdk-lib": "^2.23.0",
13
13
  "constructs": "^10.0.0"
14
14
  },
@@ -3007,7 +3007,7 @@
3007
3007
  },
3008
3008
  "description": "CDK constructs for defining an interaction between an AWS Lambda function and an Amazon Elasticache memcached cache.",
3009
3009
  "homepage": "https://github.com/awslabs/aws-solutions-constructs.git",
3010
- "jsiiVersion": "1.59.0 (build eb02c92)",
3010
+ "jsiiVersion": "1.60.1 (build 2799dc8)",
3011
3011
  "keywords": [
3012
3012
  "aws",
3013
3013
  "cdk",
@@ -3026,7 +3026,7 @@
3026
3026
  },
3027
3027
  "name": "@aws-solutions-constructs/aws-lambda-elasticachememcached",
3028
3028
  "readme": {
3029
- "markdown": "# aws-lambda-elasticachememcached module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_elasticachememcached`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-elasticachememcached`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdaelasticachememcached`|\n\nThis AWS Solutions Construct implements an AWS Lambda function connected to an Amazon Elasticache Memcached cluster.\n\nHere is a minimal deployable pattern definition :\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { LambdaToElasticachememcached } from '@aws-solutions-constructs/aws-lambda-elasticachememcached';\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\n\nnew LambdaToElasticachememcached(this, 'LambdaToElasticachememcachedPattern', {\n lambdaFunctionProps: {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(`lambda`)\n }\n});\n```\n\nPython\n```python\nfrom aws_solutions_constructs.aws_lambda_elasticachememcached import LambdaToElasticachememcached\nfrom aws_cdk import (\n aws_lambda as _lambda,\n Stack\n)\nfrom constructs import Construct\n\nLambdaToElasticachememcached(self, 'LambdaToCachePattern',\n lambda_function_props=_lambda.FunctionProps(\n code=_lambda.Code.from_asset('lambda'),\n runtime=_lambda.Runtime.PYTHON_3_9,\n handler='index.handler'\n )\n )\n```\n\nJava\n``` java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.services.lambda.*;\nimport software.amazon.awscdk.services.lambda.Runtime;\nimport software.amazon.awsconstructs.services.lambdaelasticachememcached.*;\n\nnew LambdaToElasticachememcached(this, \"LambdaToCachePattern\", new LambdaToElasticachememcachedProps.Builder()\n .lambdaFunctionProps(new FunctionProps.Builder()\n .runtime(Runtime.NODEJS_14_X)\n .code(Code.fromAsset(\"lambda\"))\n .handler(\"index.handler\")\n .build())\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|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.|\n|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.|\n|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. |\n| cacheEndpointEnvironmentVariableName?| string | Optional Name for the Lambda function environment variable set to the cache endpoint. Default: CACHE_ENDPOINT |\n| 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. |\n| 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. |\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|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.|\n| 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. |\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### AWS Lambda Function\n* Configure limited privilege access IAM role for Lambda function\n* Enable reusing connections with Keep-Alive for NodeJs Lambda function\n* Enable X-Ray Tracing\n* Attached to self referencing security group to grant access to cache\n* Set Environment Variables\n * (default) CACHE_ENDPOINT\n * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)\n\n### Amazon Elasticache Memcached Cluster\n* Creates multi node, cross-az cluster by default\n * 2 cache nodes, type: cache.t3.medium\n* Self referencing security group attached to cluster endpoint\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
3029
+ "markdown": "# aws-lambda-elasticachememcached module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_elasticachememcached`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-elasticachememcached`|\n|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdaelasticachememcached`|\n\n## Overview\nThis AWS Solutions Construct implements an AWS Lambda function connected to an Amazon Elasticache Memcached cluster.\n\nHere is a minimal deployable pattern definition :\n\nTypescript\n``` typescript\nimport { Construct } from 'constructs';\nimport { Stack, StackProps } from 'aws-cdk-lib';\nimport { LambdaToElasticachememcached } from '@aws-solutions-constructs/aws-lambda-elasticachememcached';\nimport * as lambda from 'aws-cdk-lib/aws-lambda';\n\nnew LambdaToElasticachememcached(this, 'LambdaToElasticachememcachedPattern', {\n lambdaFunctionProps: {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code: lambda.Code.fromAsset(`lambda`)\n }\n});\n```\n\nPython\n```python\nfrom aws_solutions_constructs.aws_lambda_elasticachememcached import LambdaToElasticachememcached\nfrom aws_cdk import (\n aws_lambda as _lambda,\n Stack\n)\nfrom constructs import Construct\n\nLambdaToElasticachememcached(self, 'LambdaToCachePattern',\n lambda_function_props=_lambda.FunctionProps(\n code=_lambda.Code.from_asset('lambda'),\n runtime=_lambda.Runtime.PYTHON_3_9,\n handler='index.handler'\n )\n )\n```\n\nJava\n``` java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.services.lambda.*;\nimport software.amazon.awscdk.services.lambda.Runtime;\nimport software.amazon.awsconstructs.services.lambdaelasticachememcached.*;\n\nnew LambdaToElasticachememcached(this, \"LambdaToCachePattern\", new LambdaToElasticachememcachedProps.Builder()\n .lambdaFunctionProps(new FunctionProps.Builder()\n .runtime(Runtime.NODEJS_14_X)\n .code(Code.fromAsset(\"lambda\"))\n .handler(\"index.handler\")\n .build())\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|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.|\n|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.|\n|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. |\n| cacheEndpointEnvironmentVariableName?| string | Optional Name for the Lambda function environment variable set to the cache endpoint. Default: CACHE_ENDPOINT |\n| 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. |\n| 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. |\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|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.|\n| 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. |\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### AWS Lambda Function\n* Configure limited privilege access IAM role for Lambda function\n* Enable reusing connections with Keep-Alive for NodeJs Lambda function\n* Enable X-Ray Tracing\n* Attached to self referencing security group to grant access to cache\n* Set Environment Variables\n * (default) CACHE_ENDPOINT\n * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)\n\n### Amazon Elasticache Memcached Cluster\n* Creates multi node, cross-az cluster by default\n * 2 cache nodes, type: cache.t3.medium\n* Self referencing security group attached to cluster endpoint\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
3030
3030
  },
3031
3031
  "repository": {
3032
3032
  "directory": "source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached",
@@ -3290,6 +3290,6 @@
3290
3290
  "symbolId": "lib/index:LambdaToElasticachememcachedProps"
3291
3291
  }
3292
3292
  },
3293
- "version": "2.8.0",
3294
- "fingerprint": "fyQd6SAg4qMIkxXHdJpc4LZvOEtbGG+DuvJfOpb8cWI="
3293
+ "version": "2.9.0",
3294
+ "fingerprint": "7aG1kBtcU5QdLDVU7h7BSrk4LAISfUnZ6aqkxiHMSSU="
3295
3295
  }
package/README.md CHANGED
@@ -18,6 +18,7 @@
18
18
  |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-elasticachememcached`|
19
19
  |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdaelasticachememcached`|
20
20
 
21
+ ## Overview
21
22
  This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon Elasticache Memcached cluster.
22
23
 
23
24
  Here is a minimal deployable pattern definition :
package/lib/index.d.ts CHANGED
@@ -79,4 +79,3 @@ export declare class LambdaToElasticachememcached extends Construct {
79
79
  */
80
80
  constructor(scope: Construct, id: string, props: LambdaToElasticachememcachedProps);
81
81
  }
82
- //# sourceMappingURL=index.d.ts.map
package/lib/index.js CHANGED
@@ -59,7 +59,7 @@ class LambdaToElasticachememcached extends constructs_1.Construct {
59
59
  }
60
60
  exports.LambdaToElasticachememcached = LambdaToElasticachememcached;
61
61
  _a = JSII_RTTI_SYMBOL_1;
62
- LambdaToElasticachememcached[_a] = { fqn: "@aws-solutions-constructs/aws-lambda-elasticachememcached.LambdaToElasticachememcached", version: "2.8.0" };
62
+ LambdaToElasticachememcached[_a] = { fqn: "@aws-solutions-constructs/aws-lambda-elasticachememcached.LambdaToElasticachememcached", version: "2.9.0" };
63
63
  function AddLambdaEnvironmentVariable(targetFunction, value, defaultName, clientName) {
64
64
  const variableName = clientName || defaultName;
65
65
  targetFunction.addEnvironment(variableName, value);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-solutions-constructs/aws-lambda-elasticachememcached",
3
- "version": "2.8.0",
3
+ "version": "2.9.0",
4
4
  "description": "CDK constructs for defining an interaction between an AWS Lambda function and an Amazon Elasticache memcached cache.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",
@@ -53,7 +53,7 @@
53
53
  }
54
54
  },
55
55
  "dependencies": {
56
- "@aws-solutions-constructs/core": "2.8.0"
56
+ "@aws-solutions-constructs/core": "2.9.0"
57
57
  },
58
58
  "devDependencies": {
59
59
  "@aws-cdk/assert": "2.23.0",
@@ -77,7 +77,7 @@
77
77
  ]
78
78
  },
79
79
  "peerDependencies": {
80
- "@aws-solutions-constructs/core": "2.8.0",
80
+ "@aws-solutions-constructs/core": "2.9.0",
81
81
  "aws-cdk-lib": "^2.23.0",
82
82
  "constructs": "^10.0.0"
83
83
  },
@@ -11,4 +11,3 @@
11
11
  * and limitations under the License.
12
12
  */
13
13
  export {};
14
- //# sourceMappingURL=integ.existingResources.d.ts.map
@@ -11,4 +11,3 @@
11
11
  * and limitations under the License.
12
12
  */
13
13
  export {};
14
- //# sourceMappingURL=integ.newResources.d.ts.map
@@ -11,4 +11,3 @@
11
11
  * and limitations under the License.
12
12
  */
13
13
  export {};
14
- //# sourceMappingURL=integ.withClientProps.d.ts.map
@@ -11,4 +11,3 @@
11
11
  * and limitations under the License.
12
12
  */
13
13
  import "@aws-cdk/assert/jest";
14
- //# sourceMappingURL=lambda-elasticachememcached.test.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,KAAK,MAAM,MAAM,wBAAwB,CAAC;AACjD,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAErD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAKvC;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,aAAa,CAAC;IACpD;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC;IAChC;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC;IACjC;;;;OAIG;IACH,QAAQ,CAAC,oCAAoC,CAAC,EAAE,MAAM,CAAC;IACvD;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,KAAK,CAAC,oBAAoB,GAAG,GAAG,CAAC;IACvD;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC;CAChD;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,SAAS;IACzD,SAAgB,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC;IAChD,SAAgB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC;IAC9B,SAAgB,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC;IAE7C;;;;;;OAMG;gBAED,KAAK,EAAE,SAAS,EAChB,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,iCAAiC;CA4D3C"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"integ.existingResources.d.ts","sourceRoot":"","sources":["integ.existingResources.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"integ.newResources.d.ts","sourceRoot":"","sources":["integ.newResources.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"integ.withClientProps.d.ts","sourceRoot":"","sources":["integ.withClientProps.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"lambda-elasticachememcached.test.d.ts","sourceRoot":"","sources":["lambda-elasticachememcached.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAOH,OAAO,sBAAsB,CAAC"}