@aws-solutions-constructs/aws-lambda-elasticachememcached 2.85.1 → 2.85.3

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.85.1",
11
+ "@aws-solutions-constructs/core": "2.85.3",
12
12
  "aws-cdk-lib": "^2.193.0",
13
13
  "constructs": "^10.0.0"
14
14
  },
@@ -3993,7 +3993,7 @@
3993
3993
  },
3994
3994
  "name": "@aws-solutions-constructs/aws-lambda-elasticachememcached",
3995
3995
  "readme": {
3996
- "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_20_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_11,\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_20_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/v2/docs/aws-cdk-lib.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/v2/docs/aws-cdk-lib.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/v2/docs/aws-cdk-lib.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 Elasticache. 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/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options) method.|\n|vpcProps?|[`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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 overridden. |\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/v2/docs/aws-cdk-lib.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/v2/docs/aws-cdk-lib.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 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n"
3996
+ "markdown": "Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-elasticachememcached/README.adoc)\n"
3997
3997
  },
3998
3998
  "repository": {
3999
3999
  "directory": "source/patterns/@aws-solutions-constructs/aws-lambda-elasticachememcached",
@@ -4257,6 +4257,6 @@
4257
4257
  "symbolId": "lib/index:LambdaToElasticachememcachedProps"
4258
4258
  }
4259
4259
  },
4260
- "version": "2.85.1",
4261
- "fingerprint": "LYTM/27fqNtHJ07v7rPzOLBU9R0xsTgwzr6SnNC9d5c="
4260
+ "version": "2.85.3",
4261
+ "fingerprint": "1wLEvqpfsDxfMyRR6bEdLMgZyqTh/FaxK25pJlAG7sY="
4262
4262
  }
package/README.adoc ADDED
@@ -0,0 +1,202 @@
1
+ //!!NODE_ROOT <section>
2
+ //== aws-lambda-elasticachememcached module
3
+
4
+ [.topic]
5
+ = aws-lambda-elasticachememcached
6
+ :info_doctype: section
7
+ :info_title: aws-lambda-elasticachememcached
8
+
9
+
10
+ image:https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge[Stability:Experimental]
11
+
12
+ [width="100%",cols="<50%,<50%",options="header",]
13
+ |===
14
+ |*Reference Documentation*:
15
+ |https://docs.aws.amazon.com/solutions/latest/constructs/
16
+ |===
17
+
18
+ [width="100%",cols="<46%,54%",options="header",]
19
+ |===
20
+ |*Language* |*Package*
21
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/python32.png[Python
22
+ Logo] Python
23
+ |`aws_solutions_constructs.aws_lambda_elasticachememcached`
24
+
25
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png[Typescript
26
+ Logo] Typescript
27
+ |`@aws-solutions-constructs/aws-lambda-elasticachememcached`
28
+
29
+ |image:https://docs.aws.amazon.com/cdk/api/latest/img/java32.png[Java
30
+ Logo] Java
31
+ |`software.amazon.awsconstructs.services.lambdaelasticachememcached`
32
+ |===
33
+
34
+ == Overview
35
+
36
+ This AWS Solutions Construct implements an AWS Lambda function connected
37
+ to an Amazon Elasticache Memcached cluster.
38
+
39
+ Here is a minimal deployable pattern definition :
40
+
41
+ ====
42
+ [role="tablist"]
43
+ Typescript::
44
+ +
45
+ [source,typescript]
46
+ ----
47
+ import { Construct } from 'constructs';
48
+ import { Stack, StackProps } from 'aws-cdk-lib';
49
+ import { LambdaToElasticachememcached } from '@aws-solutions-constructs/aws-lambda-elasticachememcached';
50
+ import * as lambda from 'aws-cdk-lib/aws-lambda';
51
+
52
+ new LambdaToElasticachememcached(this, 'LambdaToElasticachememcachedPattern', {
53
+ lambdaFunctionProps: {
54
+ runtime: lambda.Runtime.NODEJS_20_X,
55
+ handler: 'index.handler',
56
+ code: lambda.Code.fromAsset(`lambda`)
57
+ }
58
+ });
59
+ ----
60
+
61
+ Python::
62
+ +
63
+ [source,python]
64
+ ----
65
+ from aws_solutions_constructs.aws_lambda_elasticachememcached import LambdaToElasticachememcached
66
+ from aws_cdk import (
67
+ aws_lambda as _lambda,
68
+ Stack
69
+ )
70
+ from constructs import Construct
71
+
72
+ LambdaToElasticachememcached(self, 'LambdaToCachePattern',
73
+ lambda_function_props=_lambda.FunctionProps(
74
+ code=_lambda.Code.from_asset('lambda'),
75
+ runtime=_lambda.Runtime.PYTHON_3_11,
76
+ handler='index.handler'
77
+ )
78
+ )
79
+ ----
80
+
81
+ Java::
82
+ +
83
+ [source,java]
84
+ ----
85
+ import software.constructs.Construct;
86
+
87
+ import software.amazon.awscdk.Stack;
88
+ import software.amazon.awscdk.StackProps;
89
+ import software.amazon.awscdk.services.lambda.*;
90
+ import software.amazon.awscdk.services.lambda.Runtime;
91
+ import software.amazon.awsconstructs.services.lambdaelasticachememcached.*;
92
+
93
+ new LambdaToElasticachememcached(this, "LambdaToCachePattern", new LambdaToElasticachememcachedProps.Builder()
94
+ .lambdaFunctionProps(new FunctionProps.Builder()
95
+ .runtime(Runtime.NODEJS_20_X)
96
+ .code(Code.fromAsset("lambda"))
97
+ .handler("index.handler")
98
+ .build())
99
+ .build());
100
+ ----
101
+ ====
102
+
103
+ == Pattern Construct Props
104
+
105
+ [width="100%",cols="<30%,<35%,35%",options="header",]
106
+ |===
107
+ |*Name* |*Type* |*Description*
108
+ |existingLambdaObj?
109
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html[`lambda.Function`]
110
+ |Existing instance of Lambda Function object, providing both this and
111
+ `lambdaFunctionProps` will cause an error.
112
+
113
+ |lambdaFunctionProps?
114
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html[`lambda.FunctionProps`]
115
+ |Optional user provided props to override the default props for the
116
+ Lambda function.
117
+
118
+ |existingVpc?
119
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
120
+ |An optional, existing VPC into which this pattern should be deployed.
121
+ When deployed in a VPC, the Lambda function will use ENIs in the VPC to
122
+ access network resources and an Interface Endpoint will be created in
123
+ the VPC for Amazon Elasticache. If an existing VPC is provided, the
124
+ `deployVpc` property cannot be `true`. This uses `ec2.IVpc` to allow
125
+ clients to supply VPCs that exist outside the stack using the
126
+ https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options[`ec2.Vpc.fromLookup()`]
127
+ method.
128
+
129
+ |vpcProps?
130
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html[`ec2.VpcProps`]
131
+ |Optional user provided properties to override the default properties
132
+ for the new VPC. `subnetConfiguration` is set by the pattern, so any
133
+ values for those properties supplied here will be overridden.
134
+
135
+ |cacheEndpointEnvironmentVariableName? |string |Optional Name for the
136
+ Lambda function environment variable set to the cache endpoint. Default:
137
+ CACHE_ENDPOINT
138
+
139
+ |cacheProps?
140
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheClusterProps.html[`cache.CfnCacheClusterProps`]
141
+ |Optional user provided props to override the default props for the
142
+ Elasticache Cluster. Providing both this and `existingCache` will cause
143
+ an error.
144
+
145
+ |existingCache?
146
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.html#attrconfigurationendpointport[`cache.CfnCacheCluster`]
147
+ |Existing instance of Elasticache Cluster object, providing both this
148
+ and `cacheProps` will cause an error. If you provide this, you must
149
+ provide the associated VPC in existingVpc.
150
+ |===
151
+
152
+ == Pattern Properties
153
+
154
+ [width="100%",cols="<30%,<35%,35%",options="header",]
155
+ |===
156
+ |*Name* |*Type* |*Description*
157
+ |lambdaFunction
158
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html[`lambda.Function`]
159
+ |Returns an instance of the Lambda function used by the pattern.
160
+
161
+ |vpc
162
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html[`ec2.IVpc`]
163
+ |Returns an interface on the VPC used by the pattern. This may be a VPC
164
+ created by the pattern or the VPC supplied to the pattern constructor.
165
+
166
+ |cache
167
+ |https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.html#attrconfigurationendpointport[`cache.CfnCacheCluster`]
168
+ |The Elasticache Memcached cluster used by the construct.
169
+ |===
170
+
171
+ == Default settings
172
+
173
+ Out of the box implementation of the Construct without any override will
174
+ set the following defaults:
175
+
176
+ === AWS Lambda Function
177
+
178
+ * Configure limited privilege access IAM role for Lambda function
179
+ * Enable reusing connections with Keep-Alive for NodeJs Lambda function
180
+ * Enable X-Ray Tracing
181
+ * Attached to self referencing security group to grant access to cache
182
+ * Set Environment Variables
183
+ ** (default) CACHE_ENDPOINT
184
+ ** AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x
185
+ and higher functions)
186
+
187
+ === Amazon Elasticache Memcached Cluster
188
+
189
+ * Creates multi node, cross-az cluster by default
190
+ ** 2 cache nodes, type: cache.t3.medium
191
+ * Self referencing security group attached to cluster endpoint
192
+
193
+ == Architecture
194
+
195
+
196
+ image::aws-lambda-elasticachememcached.png["Diagram showing the Lambda function, Elasticache memcached cache and IAM role created by the construct",scaledwidth=100%]
197
+
198
+ // github block
199
+
200
+ '''''
201
+
202
+ © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
package/README.md CHANGED
@@ -1,121 +1 @@
1
- # aws-lambda-elasticachememcached module
2
- <!--BEGIN STABILITY BANNER-->
3
-
4
- ---
5
-
6
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
7
-
8
- ---
9
- <!--END STABILITY BANNER-->
10
-
11
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
12
- |:-------------|:-------------|
13
- <div style="height:8px"></div>
14
-
15
- | **Language** | **Package** |
16
- |:-------------|-----------------|
17
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_elasticachememcached`|
18
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-elasticachememcached`|
19
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdaelasticachememcached`|
20
-
21
- ## Overview
22
- This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon Elasticache Memcached cluster.
23
-
24
- Here is a minimal deployable pattern definition :
25
-
26
- Typescript
27
- ``` typescript
28
- import { Construct } from 'constructs';
29
- import { Stack, StackProps } from 'aws-cdk-lib';
30
- import { LambdaToElasticachememcached } from '@aws-solutions-constructs/aws-lambda-elasticachememcached';
31
- import * as lambda from 'aws-cdk-lib/aws-lambda';
32
-
33
- new LambdaToElasticachememcached(this, 'LambdaToElasticachememcachedPattern', {
34
- lambdaFunctionProps: {
35
- runtime: lambda.Runtime.NODEJS_20_X,
36
- handler: 'index.handler',
37
- code: lambda.Code.fromAsset(`lambda`)
38
- }
39
- });
40
- ```
41
-
42
- Python
43
- ```python
44
- from aws_solutions_constructs.aws_lambda_elasticachememcached import LambdaToElasticachememcached
45
- from aws_cdk import (
46
- aws_lambda as _lambda,
47
- Stack
48
- )
49
- from constructs import Construct
50
-
51
- LambdaToElasticachememcached(self, 'LambdaToCachePattern',
52
- lambda_function_props=_lambda.FunctionProps(
53
- code=_lambda.Code.from_asset('lambda'),
54
- runtime=_lambda.Runtime.PYTHON_3_11,
55
- handler='index.handler'
56
- )
57
- )
58
- ```
59
-
60
- Java
61
- ``` java
62
- import software.constructs.Construct;
63
-
64
- import software.amazon.awscdk.Stack;
65
- import software.amazon.awscdk.StackProps;
66
- import software.amazon.awscdk.services.lambda.*;
67
- import software.amazon.awscdk.services.lambda.Runtime;
68
- import software.amazon.awsconstructs.services.lambdaelasticachememcached.*;
69
-
70
- new LambdaToElasticachememcached(this, "LambdaToCachePattern", new LambdaToElasticachememcachedProps.Builder()
71
- .lambdaFunctionProps(new FunctionProps.Builder()
72
- .runtime(Runtime.NODEJS_20_X)
73
- .code(Code.fromAsset("lambda"))
74
- .handler("index.handler")
75
- .build())
76
- .build());
77
- ```
78
-
79
- ## Pattern Construct Props
80
-
81
- | **Name** | **Type** | **Description** |
82
- |:-------------|:----------------|-----------------|
83
- |existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Existing instance of Lambda Function object, providing both this and `lambdaFunctionProps` will cause an error.|
84
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|Optional user provided props to override the default props for the Lambda function.|
85
- |existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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 Elasticache. 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/v2/docs/aws-cdk-lib.aws_ec2.Vpc.html#static-fromwbrlookupscope-id-options) method.|
86
- |vpcProps?|[`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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 overridden. |
87
- | cacheEndpointEnvironmentVariableName?| string | Optional Name for the Lambda function environment variable set to the cache endpoint. Default: CACHE_ENDPOINT |
88
- | 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. |
89
- | 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. |
90
-
91
- ## Pattern Properties
92
-
93
- | **Name** | **Type** | **Description** |
94
- |:-------------|:----------------|-----------------|
95
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function used by the pattern.|
96
- |vpc |[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.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.|
97
- | 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. |
98
-
99
- ## Default settings
100
-
101
- Out of the box implementation of the Construct without any override will set the following defaults:
102
-
103
- ### AWS Lambda Function
104
- * Configure limited privilege access IAM role for Lambda function
105
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
106
- * Enable X-Ray Tracing
107
- * Attached to self referencing security group to grant access to cache
108
- * Set Environment Variables
109
- * (default) CACHE_ENDPOINT
110
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
111
-
112
- ### Amazon Elasticache Memcached Cluster
113
- * Creates multi node, cross-az cluster by default
114
- * 2 cache nodes, type: cache.t3.medium
115
- * Self referencing security group attached to cluster endpoint
116
-
117
- ## Architecture
118
- ![Architecture Diagram](architecture.png)
119
-
120
- ***
121
- &copy; Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
1
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-elasticachememcached/README.adoc)
package/lib/index.js CHANGED
@@ -60,7 +60,7 @@ class LambdaToElasticachememcached extends constructs_1.Construct {
60
60
  }
61
61
  exports.LambdaToElasticachememcached = LambdaToElasticachememcached;
62
62
  _a = JSII_RTTI_SYMBOL_1;
63
- LambdaToElasticachememcached[_a] = { fqn: "@aws-solutions-constructs/aws-lambda-elasticachememcached.LambdaToElasticachememcached", version: "2.85.1" };
63
+ LambdaToElasticachememcached[_a] = { fqn: "@aws-solutions-constructs/aws-lambda-elasticachememcached.LambdaToElasticachememcached", version: "2.85.3" };
64
64
  function AddLambdaEnvironmentVariable(targetFunction, value, defaultName, clientName) {
65
65
  const variableName = clientName || defaultName;
66
66
  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.85.1",
3
+ "version": "2.85.3",
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",
@@ -22,11 +22,12 @@
22
22
  "test": "jest --coverage",
23
23
  "clean": "tsc -b --clean",
24
24
  "watch": "tsc -b -w",
25
+ "asciidoc": "asciidoctor --failure-level WARNING -o /dev/null README.adoc",
25
26
  "integ": "integ-runner --update-on-failed",
26
27
  "integ-assert": "integ-runner",
27
28
  "jsii": "jsii",
28
29
  "jsii-pacmak": "jsii-pacmak",
29
- "build+lint+test": "npm run jsii && npm run lint && npm test && npm run integ-assert",
30
+ "build+lint+test": "npm run jsii && npm run lint && npm run asciidoc && npm test && npm run integ-assert",
30
31
  "blt": "npm run build+lint+test",
31
32
  "integ-no-clean": "integ-runner --update-on-failed --no-clean",
32
33
  "snapshot-update": "npm run jsii && npm test -- -u && npm run integ-assert"
@@ -54,7 +55,7 @@
54
55
  }
55
56
  },
56
57
  "dependencies": {
57
- "@aws-solutions-constructs/core": "2.85.1",
58
+ "@aws-solutions-constructs/core": "2.85.3",
58
59
  "constructs": "^10.0.0"
59
60
  },
60
61
  "devDependencies": {
@@ -78,7 +79,7 @@
78
79
  ]
79
80
  },
80
81
  "peerDependencies": {
81
- "@aws-solutions-constructs/core": "2.85.1",
82
+ "@aws-solutions-constructs/core": "2.85.3",
82
83
  "constructs": "^10.0.0",
83
84
  "aws-cdk-lib": "^2.193.0"
84
85
  },