aws-solutions-constructs.aws-lambda-secretsmanager 2.85.2__tar.gz → 2.85.4__tar.gz

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.
Files changed (20) hide show
  1. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/PKG-INFO +28 -0
  2. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/README.md +1 -0
  3. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/setup.py +3 -3
  4. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs/aws_lambda_secretsmanager/__init__.py +1 -144
  5. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/__init__.py +2 -2
  6. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/aws-lambda-secretsmanager@2.85.4.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/PKG-INFO +28 -0
  8. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/SOURCES.txt +1 -1
  9. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/requires.txt +1 -1
  10. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/PKG-INFO +0 -171
  11. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/README.md +0 -144
  12. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/aws-lambda-secretsmanager@2.85.2.jsii.tgz +0 -0
  13. aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/PKG-INFO +0 -171
  14. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/LICENSE +0 -0
  15. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/MANIFEST.in +0 -0
  16. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/pyproject.toml +0 -0
  17. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/setup.cfg +0 -0
  18. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs/aws_lambda_secretsmanager/py.typed +0 -0
  19. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/dependency_links.txt +0 -0
  20. {aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/top_level.txt +0 -0
aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-lambda-secretsmanager
3
+ Version: 2.85.4
4
+ Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Secrets Manager.
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.4
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-secretsmanager/README.adoc)
aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/README.md ADDED
@@ -0,0 +1 @@
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-secretsmanager/README.adoc)
{aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/setup.py RENAMED
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "aws-solutions-constructs.aws-lambda-secretsmanager",
8
- "version": "2.85.2",
8
+ "version": "2.85.4",
9
9
  "description": "CDK constructs for defining an interaction between an AWS Lambda function and AWS Secrets Manager.",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/awslabs/aws-solutions-constructs.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "aws_solutions_constructs.aws_lambda_secretsmanager._jsii": [
29
- "aws-lambda-secretsmanager@2.85.2.jsii.tgz"
29
+ "aws-lambda-secretsmanager@2.85.4.jsii.tgz"
30
30
  ],
31
31
  "aws_solutions_constructs.aws_lambda_secretsmanager": [
32
32
  "py.typed"
@@ -35,7 +35,7 @@ kwargs = json.loads(
35
35
  "python_requires": "~=3.9",
36
36
  "install_requires": [
37
37
  "aws-cdk-lib>=2.193.0, <3.0.0",
38
- "aws-solutions-constructs.core==2.85.2",
38
+ "aws-solutions-constructs.core==2.85.4",
39
39
  "constructs>=10.0.0, <11.0.0",
40
40
  "jsii>=1.111.0, <2.0.0",
41
41
  "publication>=0.0.3",
{aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs/aws_lambda_secretsmanager/__init__.py RENAMED
@@ -1,148 +1,5 @@
1
1
  r'''
2
- # aws-lambda-secretsmanager module
3
-
4
- <!--BEGIN STABILITY BANNER-->---
5
-
6
-
7
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
8
-
9
- > All classes are under active development and subject to non-backward compatible changes or removal in any
10
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
11
- > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
12
-
13
- ---
14
- <!--END STABILITY BANNER-->
15
-
16
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
17
- |:-------------|:-------------|
18
-
19
- <div style="height:8px"></div>
20
-
21
- | **Language** | **Package** |
22
- |:-------------|-----------------|
23
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_secretsmanager`|
24
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-secretsmanager`|
25
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdasecretsmanager`|
26
-
27
- ## Overview
28
-
29
- This AWS Solutions Construct implements the AWS Lambda function and AWS Secrets Manager secret with the least privileged permissions.
30
-
31
- Here is a minimal deployable pattern definition:
32
-
33
- Typescript
34
-
35
- ```python
36
- import { Construct } from 'constructs';
37
- import { Stack, StackProps } from 'aws-cdk-lib';
38
- import { LambdaToSecretsmanagerProps, LambdaToSecretsmanager } from '@aws-solutions-constructs/aws-lambda-secretsmanager';
39
- import * as lambda from 'aws-cdk-lib/aws-lambda';
40
-
41
- const constructProps: LambdaToSecretsmanagerProps = {
42
- lambdaFunctionProps: {
43
- runtime: lambda.Runtime.NODEJS_20_X,
44
- code: lambda.Code.fromAsset(`lambda`),
45
- handler: 'index.handler'
46
- },
47
- };
48
-
49
- new LambdaToSecretsmanager(this, 'test-lambda-secretsmanager-stack', constructProps);
50
- ```
51
-
52
- Python
53
-
54
- ```python
55
- from aws_solutions_constructs.aws_lambda_secretsmanager import LambdaToSecretsmanagerProps, LambdaToSecretsmanager
56
- from aws_cdk import (
57
- aws_lambda as _lambda,
58
- Stack
59
- )
60
- from constructs import Construct
61
-
62
-
63
- LambdaToSecretsmanager(
64
- self, 'test-lambda-secretsmanager-stack',
65
- lambda_function_props=_lambda.FunctionProps(
66
- code=_lambda.Code.from_asset('lambda'),
67
- runtime=_lambda.Runtime.PYTHON_3_11,
68
- handler='index.handler'
69
- )
70
- )
71
- ```
72
-
73
- Java
74
-
75
- ```java
76
- import software.constructs.Construct;
77
-
78
- import software.amazon.awscdk.Stack;
79
- import software.amazon.awscdk.StackProps;
80
- import software.amazon.awscdk.services.lambda.*;
81
- import software.amazon.awscdk.services.lambda.Runtime;
82
- import software.amazon.awsconstructs.services.lambdasecretsmanager.*;
83
-
84
- new LambdaToSecretsmanager(this, "test-lambda-secretsmanager-stack", new LambdaToSecretsmanagerProps.Builder()
85
- .lambdaFunctionProps(new FunctionProps.Builder()
86
- .runtime(Runtime.NODEJS_20_X)
87
- .code(Code.fromAsset("lambda"))
88
- .handler("index.handler")
89
- .build())
90
- .build());
91
- ```
92
-
93
- ## Pattern Construct Props
94
-
95
- | **Name** | **Type** | **Description** |
96
- |:-------------|:----------------|-----------------|
97
- |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.|
98
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
99
- |secretProps?|[`secretsmanager.SecretProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.SecretProps.html)|Optional user provided props to override the default props for Secrets Manager|
100
- |existingSecretObj?|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored|
101
- |grantWriteAccess?|`string`|Optional Access granted to the Lambda function for the secret. 'Read' or 'ReadWrite". Default is "Read"
102
- |secretEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the ARN of the secret. Default: SECRET_ARN. |
103
- |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 AWS Secrets Manager. 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.|
104
- |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. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored.|
105
- |deployVpc?|`boolean`|Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:<ul><li> One isolated subnet in each Availability Zone used by the CDK program</li><li>`enableDnsHostnames` and `enableDnsSupport` will both be set to true</li></ul>If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.|
106
-
107
- ## Pattern Properties
108
-
109
- | **Name** | **Type** | **Description** |
110
- |:-------------|:----------------|-----------------|
111
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of lambda.Function created by the construct|
112
- |secret|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Returns an instance of secretsmanager.Secret created by the construct|
113
- |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 (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.|
114
-
115
- ## Default settings
116
-
117
- Out of the box implementation of the Construct without any override will set the following defaults:
118
-
119
- ### AWS Lambda Function
120
-
121
- * Configure limited privilege access IAM role for Lambda function
122
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
123
- * Enable X-Ray Tracing
124
- * Set Environment Variables
125
-
126
- * (default) SECRET_ARN containing the ARN of the secret as return by CDK [secretArn property](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html#secretarn).
127
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
128
-
129
- ### Amazon SecretsManager Secret
130
-
131
- * Enable read-only access for the associated AWS Lambda Function
132
- * Creates a new Secret
133
-
134
- * (default) random name
135
- * (default) random value
136
- * Retain the Secret when deleting the CloudFormation stack
137
-
138
- ## Architecture
139
-
140
- ![Architecture Diagram](architecture.png)
141
-
142
- ---
143
-
144
-
145
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-secretsmanager/README.adoc)
146
3
  '''
147
4
  from pkgutil import extend_path
148
5
  __path__ = extend_path(__path__, __name__)
{aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/__init__.py RENAMED
@@ -34,9 +34,9 @@ import constructs._jsii
34
34
 
35
35
  __jsii_assembly__ = jsii.JSIIAssembly.load(
36
36
  "@aws-solutions-constructs/aws-lambda-secretsmanager",
37
- "2.85.2",
37
+ "2.85.4",
38
38
  __name__[0:-6],
39
- "aws-lambda-secretsmanager@2.85.2.jsii.tgz",
39
+ "aws-lambda-secretsmanager@2.85.4.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-lambda-secretsmanager
3
+ Version: 2.85.4
4
+ Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Secrets Manager.
5
+ Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
+ Author: Amazon Web Services
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
+ Classifier: Intended Audience :: Developers
10
+ Classifier: Operating System :: OS Independent
11
+ Classifier: Programming Language :: JavaScript
12
+ Classifier: Programming Language :: Python :: 3 :: Only
13
+ Classifier: Programming Language :: Python :: 3.9
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Typing :: Typed
17
+ Classifier: License :: OSI Approved
18
+ Requires-Python: ~=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
+ Requires-Dist: aws-solutions-constructs.core==2.85.4
23
+ Requires-Dist: constructs<11.0.0,>=10.0.0
24
+ Requires-Dist: jsii<2.0.0,>=1.111.0
25
+ Requires-Dist: publication>=0.0.3
26
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
27
+
28
+ Documentation for this pattern can be found [here](https://github.com/awslabs/aws-solutions-constructs/blob/main/source/patterns/%40aws-solutions-constructs/aws-lambda-secretsmanager/README.adoc)
{aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/SOURCES.txt RENAMED
@@ -11,4 +11,4 @@ src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/top_level.txt
11
11
  src/aws_solutions_constructs/aws_lambda_secretsmanager/__init__.py
12
12
  src/aws_solutions_constructs/aws_lambda_secretsmanager/py.typed
13
13
  src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/__init__.py
14
- src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/aws-lambda-secretsmanager@2.85.2.jsii.tgz
14
+ src/aws_solutions_constructs/aws_lambda_secretsmanager/_jsii/aws-lambda-secretsmanager@2.85.4.jsii.tgz
{aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2 → aws_solutions_constructs_aws_lambda_secretsmanager-2.85.4}/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/requires.txt RENAMED
@@ -1,5 +1,5 @@
1
1
  aws-cdk-lib<3.0.0,>=2.193.0
2
- aws-solutions-constructs.core==2.85.2
2
+ aws-solutions-constructs.core==2.85.4
3
3
  constructs<11.0.0,>=10.0.0
4
4
  jsii<2.0.0,>=1.111.0
5
5
  publication>=0.0.3
aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/PKG-INFO DELETED
@@ -1,171 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-lambda-secretsmanager
3
- Version: 2.85.2
4
- Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Secrets Manager.
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.2
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-lambda-secretsmanager module
29
-
30
- <!--BEGIN STABILITY BANNER-->---
31
-
32
-
33
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
34
-
35
- > All classes are under active development and subject to non-backward compatible changes or removal in any
36
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
37
- > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
38
-
39
- ---
40
- <!--END STABILITY BANNER-->
41
-
42
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
43
- |:-------------|:-------------|
44
-
45
- <div style="height:8px"></div>
46
-
47
- | **Language** | **Package** |
48
- |:-------------|-----------------|
49
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_secretsmanager`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-secretsmanager`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdasecretsmanager`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements the AWS Lambda function and AWS Secrets Manager secret with the least privileged permissions.
56
-
57
- Here is a minimal deployable pattern definition:
58
-
59
- Typescript
60
-
61
- ```python
62
- import { Construct } from 'constructs';
63
- import { Stack, StackProps } from 'aws-cdk-lib';
64
- import { LambdaToSecretsmanagerProps, LambdaToSecretsmanager } from '@aws-solutions-constructs/aws-lambda-secretsmanager';
65
- import * as lambda from 'aws-cdk-lib/aws-lambda';
66
-
67
- const constructProps: LambdaToSecretsmanagerProps = {
68
- lambdaFunctionProps: {
69
- runtime: lambda.Runtime.NODEJS_20_X,
70
- code: lambda.Code.fromAsset(`lambda`),
71
- handler: 'index.handler'
72
- },
73
- };
74
-
75
- new LambdaToSecretsmanager(this, 'test-lambda-secretsmanager-stack', constructProps);
76
- ```
77
-
78
- Python
79
-
80
- ```python
81
- from aws_solutions_constructs.aws_lambda_secretsmanager import LambdaToSecretsmanagerProps, LambdaToSecretsmanager
82
- from aws_cdk import (
83
- aws_lambda as _lambda,
84
- Stack
85
- )
86
- from constructs import Construct
87
-
88
-
89
- LambdaToSecretsmanager(
90
- self, 'test-lambda-secretsmanager-stack',
91
- lambda_function_props=_lambda.FunctionProps(
92
- code=_lambda.Code.from_asset('lambda'),
93
- runtime=_lambda.Runtime.PYTHON_3_11,
94
- handler='index.handler'
95
- )
96
- )
97
- ```
98
-
99
- Java
100
-
101
- ```java
102
- import software.constructs.Construct;
103
-
104
- import software.amazon.awscdk.Stack;
105
- import software.amazon.awscdk.StackProps;
106
- import software.amazon.awscdk.services.lambda.*;
107
- import software.amazon.awscdk.services.lambda.Runtime;
108
- import software.amazon.awsconstructs.services.lambdasecretsmanager.*;
109
-
110
- new LambdaToSecretsmanager(this, "test-lambda-secretsmanager-stack", new LambdaToSecretsmanagerProps.Builder()
111
- .lambdaFunctionProps(new FunctionProps.Builder()
112
- .runtime(Runtime.NODEJS_20_X)
113
- .code(Code.fromAsset("lambda"))
114
- .handler("index.handler")
115
- .build())
116
- .build());
117
- ```
118
-
119
- ## Pattern Construct Props
120
-
121
- | **Name** | **Type** | **Description** |
122
- |:-------------|:----------------|-----------------|
123
- |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.|
124
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
125
- |secretProps?|[`secretsmanager.SecretProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.SecretProps.html)|Optional user provided props to override the default props for Secrets Manager|
126
- |existingSecretObj?|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored|
127
- |grantWriteAccess?|`string`|Optional Access granted to the Lambda function for the secret. 'Read' or 'ReadWrite". Default is "Read"
128
- |secretEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the ARN of the secret. Default: SECRET_ARN. |
129
- |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 AWS Secrets Manager. 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.|
130
- |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. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored.|
131
- |deployVpc?|`boolean`|Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:<ul><li> One isolated subnet in each Availability Zone used by the CDK program</li><li>`enableDnsHostnames` and `enableDnsSupport` will both be set to true</li></ul>If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.|
132
-
133
- ## Pattern Properties
134
-
135
- | **Name** | **Type** | **Description** |
136
- |:-------------|:----------------|-----------------|
137
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of lambda.Function created by the construct|
138
- |secret|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Returns an instance of secretsmanager.Secret created by the construct|
139
- |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 (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.|
140
-
141
- ## Default settings
142
-
143
- Out of the box implementation of the Construct without any override will set the following defaults:
144
-
145
- ### AWS Lambda Function
146
-
147
- * Configure limited privilege access IAM role for Lambda function
148
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
149
- * Enable X-Ray Tracing
150
- * Set Environment Variables
151
-
152
- * (default) SECRET_ARN containing the ARN of the secret as return by CDK [secretArn property](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html#secretarn).
153
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
154
-
155
- ### Amazon SecretsManager Secret
156
-
157
- * Enable read-only access for the associated AWS Lambda Function
158
- * Creates a new Secret
159
-
160
- * (default) random name
161
- * (default) random value
162
- * Retain the Secret when deleting the CloudFormation stack
163
-
164
- ## Architecture
165
-
166
- ![Architecture Diagram](architecture.png)
167
-
168
- ---
169
-
170
-
171
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/README.md DELETED
@@ -1,144 +0,0 @@
1
- # aws-lambda-secretsmanager module
2
-
3
- <!--BEGIN STABILITY BANNER-->---
4
-
5
-
6
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
7
-
8
- > All classes are under active development and subject to non-backward compatible changes or removal in any
9
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
10
- > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
11
-
12
- ---
13
- <!--END STABILITY BANNER-->
14
-
15
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
16
- |:-------------|:-------------|
17
-
18
- <div style="height:8px"></div>
19
-
20
- | **Language** | **Package** |
21
- |:-------------|-----------------|
22
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_secretsmanager`|
23
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-secretsmanager`|
24
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdasecretsmanager`|
25
-
26
- ## Overview
27
-
28
- This AWS Solutions Construct implements the AWS Lambda function and AWS Secrets Manager secret with the least privileged permissions.
29
-
30
- Here is a minimal deployable pattern definition:
31
-
32
- Typescript
33
-
34
- ```python
35
- import { Construct } from 'constructs';
36
- import { Stack, StackProps } from 'aws-cdk-lib';
37
- import { LambdaToSecretsmanagerProps, LambdaToSecretsmanager } from '@aws-solutions-constructs/aws-lambda-secretsmanager';
38
- import * as lambda from 'aws-cdk-lib/aws-lambda';
39
-
40
- const constructProps: LambdaToSecretsmanagerProps = {
41
- lambdaFunctionProps: {
42
- runtime: lambda.Runtime.NODEJS_20_X,
43
- code: lambda.Code.fromAsset(`lambda`),
44
- handler: 'index.handler'
45
- },
46
- };
47
-
48
- new LambdaToSecretsmanager(this, 'test-lambda-secretsmanager-stack', constructProps);
49
- ```
50
-
51
- Python
52
-
53
- ```python
54
- from aws_solutions_constructs.aws_lambda_secretsmanager import LambdaToSecretsmanagerProps, LambdaToSecretsmanager
55
- from aws_cdk import (
56
- aws_lambda as _lambda,
57
- Stack
58
- )
59
- from constructs import Construct
60
-
61
-
62
- LambdaToSecretsmanager(
63
- self, 'test-lambda-secretsmanager-stack',
64
- lambda_function_props=_lambda.FunctionProps(
65
- code=_lambda.Code.from_asset('lambda'),
66
- runtime=_lambda.Runtime.PYTHON_3_11,
67
- handler='index.handler'
68
- )
69
- )
70
- ```
71
-
72
- Java
73
-
74
- ```java
75
- import software.constructs.Construct;
76
-
77
- import software.amazon.awscdk.Stack;
78
- import software.amazon.awscdk.StackProps;
79
- import software.amazon.awscdk.services.lambda.*;
80
- import software.amazon.awscdk.services.lambda.Runtime;
81
- import software.amazon.awsconstructs.services.lambdasecretsmanager.*;
82
-
83
- new LambdaToSecretsmanager(this, "test-lambda-secretsmanager-stack", new LambdaToSecretsmanagerProps.Builder()
84
- .lambdaFunctionProps(new FunctionProps.Builder()
85
- .runtime(Runtime.NODEJS_20_X)
86
- .code(Code.fromAsset("lambda"))
87
- .handler("index.handler")
88
- .build())
89
- .build());
90
- ```
91
-
92
- ## Pattern Construct Props
93
-
94
- | **Name** | **Type** | **Description** |
95
- |:-------------|:----------------|-----------------|
96
- |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.|
97
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
98
- |secretProps?|[`secretsmanager.SecretProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.SecretProps.html)|Optional user provided props to override the default props for Secrets Manager|
99
- |existingSecretObj?|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored|
100
- |grantWriteAccess?|`string`|Optional Access granted to the Lambda function for the secret. 'Read' or 'ReadWrite". Default is "Read"
101
- |secretEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the ARN of the secret. Default: SECRET_ARN. |
102
- |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 AWS Secrets Manager. 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.|
103
- |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. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored.|
104
- |deployVpc?|`boolean`|Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:<ul><li> One isolated subnet in each Availability Zone used by the CDK program</li><li>`enableDnsHostnames` and `enableDnsSupport` will both be set to true</li></ul>If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.|
105
-
106
- ## Pattern Properties
107
-
108
- | **Name** | **Type** | **Description** |
109
- |:-------------|:----------------|-----------------|
110
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of lambda.Function created by the construct|
111
- |secret|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Returns an instance of secretsmanager.Secret created by the construct|
112
- |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 (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.|
113
-
114
- ## Default settings
115
-
116
- Out of the box implementation of the Construct without any override will set the following defaults:
117
-
118
- ### AWS Lambda Function
119
-
120
- * Configure limited privilege access IAM role for Lambda function
121
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
122
- * Enable X-Ray Tracing
123
- * Set Environment Variables
124
-
125
- * (default) SECRET_ARN containing the ARN of the secret as return by CDK [secretArn property](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html#secretarn).
126
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
127
-
128
- ### Amazon SecretsManager Secret
129
-
130
- * Enable read-only access for the associated AWS Lambda Function
131
- * Creates a new Secret
132
-
133
- * (default) random name
134
- * (default) random value
135
- * Retain the Secret when deleting the CloudFormation stack
136
-
137
- ## Architecture
138
-
139
- ![Architecture Diagram](architecture.png)
140
-
141
- ---
142
-
143
-
144
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_lambda_secretsmanager-2.85.2/src/aws_solutions_constructs.aws_lambda_secretsmanager.egg-info/PKG-INFO DELETED
@@ -1,171 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-lambda-secretsmanager
3
- Version: 2.85.2
4
- Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Secrets Manager.
5
- Home-page: https://github.com/awslabs/aws-solutions-constructs.git
6
- Author: Amazon Web Services
7
- License: Apache-2.0
8
- Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
9
- Classifier: Intended Audience :: Developers
10
- Classifier: Operating System :: OS Independent
11
- Classifier: Programming Language :: JavaScript
12
- Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.9
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Typing :: Typed
17
- Classifier: License :: OSI Approved
18
- Requires-Python: ~=3.9
19
- Description-Content-Type: text/markdown
20
- License-File: LICENSE
21
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.193.0
22
- Requires-Dist: aws-solutions-constructs.core==2.85.2
23
- Requires-Dist: constructs<11.0.0,>=10.0.0
24
- Requires-Dist: jsii<2.0.0,>=1.111.0
25
- Requires-Dist: publication>=0.0.3
26
- Requires-Dist: typeguard<4.3.0,>=2.13.3
27
-
28
- # aws-lambda-secretsmanager module
29
-
30
- <!--BEGIN STABILITY BANNER-->---
31
-
32
-
33
- ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
34
-
35
- > All classes are under active development and subject to non-backward compatible changes or removal in any
36
- > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
37
- > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
38
-
39
- ---
40
- <!--END STABILITY BANNER-->
41
-
42
- | **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
43
- |:-------------|:-------------|
44
-
45
- <div style="height:8px"></div>
46
-
47
- | **Language** | **Package** |
48
- |:-------------|-----------------|
49
- |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_lambda_secretsmanager`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-secretsmanager`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdasecretsmanager`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements the AWS Lambda function and AWS Secrets Manager secret with the least privileged permissions.
56
-
57
- Here is a minimal deployable pattern definition:
58
-
59
- Typescript
60
-
61
- ```python
62
- import { Construct } from 'constructs';
63
- import { Stack, StackProps } from 'aws-cdk-lib';
64
- import { LambdaToSecretsmanagerProps, LambdaToSecretsmanager } from '@aws-solutions-constructs/aws-lambda-secretsmanager';
65
- import * as lambda from 'aws-cdk-lib/aws-lambda';
66
-
67
- const constructProps: LambdaToSecretsmanagerProps = {
68
- lambdaFunctionProps: {
69
- runtime: lambda.Runtime.NODEJS_20_X,
70
- code: lambda.Code.fromAsset(`lambda`),
71
- handler: 'index.handler'
72
- },
73
- };
74
-
75
- new LambdaToSecretsmanager(this, 'test-lambda-secretsmanager-stack', constructProps);
76
- ```
77
-
78
- Python
79
-
80
- ```python
81
- from aws_solutions_constructs.aws_lambda_secretsmanager import LambdaToSecretsmanagerProps, LambdaToSecretsmanager
82
- from aws_cdk import (
83
- aws_lambda as _lambda,
84
- Stack
85
- )
86
- from constructs import Construct
87
-
88
-
89
- LambdaToSecretsmanager(
90
- self, 'test-lambda-secretsmanager-stack',
91
- lambda_function_props=_lambda.FunctionProps(
92
- code=_lambda.Code.from_asset('lambda'),
93
- runtime=_lambda.Runtime.PYTHON_3_11,
94
- handler='index.handler'
95
- )
96
- )
97
- ```
98
-
99
- Java
100
-
101
- ```java
102
- import software.constructs.Construct;
103
-
104
- import software.amazon.awscdk.Stack;
105
- import software.amazon.awscdk.StackProps;
106
- import software.amazon.awscdk.services.lambda.*;
107
- import software.amazon.awscdk.services.lambda.Runtime;
108
- import software.amazon.awsconstructs.services.lambdasecretsmanager.*;
109
-
110
- new LambdaToSecretsmanager(this, "test-lambda-secretsmanager-stack", new LambdaToSecretsmanagerProps.Builder()
111
- .lambdaFunctionProps(new FunctionProps.Builder()
112
- .runtime(Runtime.NODEJS_20_X)
113
- .code(Code.fromAsset("lambda"))
114
- .handler("index.handler")
115
- .build())
116
- .build());
117
- ```
118
-
119
- ## Pattern Construct Props
120
-
121
- | **Name** | **Type** | **Description** |
122
- |:-------------|:----------------|-----------------|
123
- |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.|
124
- |lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|User provided props to override the default props for the Lambda function.|
125
- |secretProps?|[`secretsmanager.SecretProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.SecretProps.html)|Optional user provided props to override the default props for Secrets Manager|
126
- |existingSecretObj?|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Existing instance of Secrets Manager Secret object, If this is set then the secretProps is ignored|
127
- |grantWriteAccess?|`string`|Optional Access granted to the Lambda function for the secret. 'Read' or 'ReadWrite". Default is "Read"
128
- |secretEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the ARN of the secret. Default: SECRET_ARN. |
129
- |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 AWS Secrets Manager. 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.|
130
- |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. `enableDnsHostnames`, `enableDnsSupport`, `natGateways` and `subnetConfiguration` are set by the pattern, so any values for those properties supplied here will be overridden. If `deployVpc` is not `true` then this property will be ignored.|
131
- |deployVpc?|`boolean`|Whether to create a new VPC based on `vpcProps` into which to deploy this pattern. Setting this to true will deploy the minimal, most private VPC to run the pattern:<ul><li> One isolated subnet in each Availability Zone used by the CDK program</li><li>`enableDnsHostnames` and `enableDnsSupport` will both be set to true</li></ul>If this property is `true` then `existingVpc` cannot be specified. Defaults to `false`.|
132
-
133
- ## Pattern Properties
134
-
135
- | **Name** | **Type** | **Description** |
136
- |:-------------|:----------------|-----------------|
137
- |lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of lambda.Function created by the construct|
138
- |secret|[`secretsmanager.Secret`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html)|Returns an instance of secretsmanager.Secret created by the construct|
139
- |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 (if any). This may be a VPC created by the pattern or the VPC supplied to the pattern constructor.|
140
-
141
- ## Default settings
142
-
143
- Out of the box implementation of the Construct without any override will set the following defaults:
144
-
145
- ### AWS Lambda Function
146
-
147
- * Configure limited privilege access IAM role for Lambda function
148
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
149
- * Enable X-Ray Tracing
150
- * Set Environment Variables
151
-
152
- * (default) SECRET_ARN containing the ARN of the secret as return by CDK [secretArn property](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.Secret.html#secretarn).
153
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
154
-
155
- ### Amazon SecretsManager Secret
156
-
157
- * Enable read-only access for the associated AWS Lambda Function
158
- * Creates a new Secret
159
-
160
- * (default) random name
161
- * (default) random value
162
- * Retain the Secret when deleting the CloudFormation stack
163
-
164
- ## Architecture
165
-
166
- ![Architecture Diagram](architecture.png)
167
-
168
- ---
169
-
170
-
171
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.