aws-solutions-constructs.aws-lambda-ssmstringparameter 2.85.1__tar.gz → 2.85.3__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_ssmstringparameter-2.85.3/PKG-INFO +28 -0
  2. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3/README.md +1 -0
  3. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/setup.py +3 -3
  4. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/__init__.py +1 -149
  5. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_jsii/__init__.py +2 -2
  6. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_jsii/aws-lambda-ssmstringparameter@2.85.3.jsii.tgz +0 -0
  7. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/PKG-INFO +28 -0
  8. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/SOURCES.txt +1 -1
  9. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/requires.txt +1 -1
  10. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1/PKG-INFO +0 -176
  11. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1/README.md +0 -149
  12. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_jsii/aws-lambda-ssmstringparameter@2.85.1.jsii.tgz +0 -0
  13. aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/PKG-INFO +0 -176
  14. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/LICENSE +0 -0
  15. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/MANIFEST.in +0 -0
  16. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/pyproject.toml +0 -0
  17. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/setup.cfg +0 -0
  18. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/py.typed +0 -0
  19. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/dependency_links.txt +0 -0
  20. {aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/top_level.txt +0 -0
aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-lambda-ssmstringparameter
3
+ Version: 2.85.3
4
+ Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Systems Manager Parameter Store String parameter
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.3
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-ssmstringparameter/README.adoc)
aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3/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-ssmstringparameter/README.adoc)
{aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/setup.py RENAMED
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "aws-solutions-constructs.aws-lambda-ssmstringparameter",
8
- "version": "2.85.1",
8
+ "version": "2.85.3",
9
9
  "description": "CDK constructs for defining an interaction between an AWS Lambda function and AWS Systems Manager Parameter Store String parameter",
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_ssmstringparameter._jsii": [
29
- "aws-lambda-ssmstringparameter@2.85.1.jsii.tgz"
29
+ "aws-lambda-ssmstringparameter@2.85.3.jsii.tgz"
30
30
  ],
31
31
  "aws_solutions_constructs.aws_lambda_ssmstringparameter": [
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.1",
38
+ "aws-solutions-constructs.core==2.85.3",
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_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/__init__.py RENAMED
@@ -1,153 +1,5 @@
1
1
  r'''
2
- # aws-lambda-ssmstringparameter 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_ssm_string_parameter`|
24
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-ssmstringparameter`|
25
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdassmstringparameter`|
26
-
27
- ## Overview
28
-
29
- This AWS Solutions Construct implements the AWS Lambda function and AWS Systems Manager Parameter Store String parameter 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 { LambdaToSsmstringparameterProps, LambdaToSsmstringparameter } from '@aws-solutions-constructs/aws-lambda-ssmstringparameter';
39
- import * as lambda from 'aws-cdk-lib/aws-lambda';
40
-
41
- const constructProps: LambdaToSsmstringparameterProps = {
42
- lambdaFunctionProps: {
43
- runtime: lambda.Runtime.NODEJS_20_X,
44
- code: lambda.Code.fromAsset(`lambda`),
45
- handler: 'index.handler'
46
- },
47
- stringParameterProps: { stringValue: "test-string-value" }
48
- };
49
-
50
- new LambdaToSsmstringparameter(this, 'test-lambda-ssmstringparameter-stack', constructProps);
51
- ```
52
-
53
- Python
54
-
55
- ```python
56
- from aws_solutions_constructs.aws_lambda_ssmstringparameter import LambdaToSsmstringparameter
57
- from aws_cdk import (
58
- aws_lambda as _lambda,
59
- aws_ssm as ssm,
60
- Stack
61
- )
62
- from constructs import Construct
63
-
64
- LambdaToSsmstringparameter(
65
- self, 'test-lambda-ssmstringparameter-stack',
66
- lambda_function_props=_lambda.FunctionProps(
67
- code=_lambda.Code.from_asset('lambda'),
68
- runtime=_lambda.Runtime.PYTHON_3_11,
69
- handler='index.handler'
70
- ),
71
- string_parameter_props=ssm.StringParameterProps(
72
- string_value="test-string-value")
73
- )
74
- ```
75
-
76
- Java
77
-
78
- ```java
79
- import software.constructs.Construct;
80
-
81
- import software.amazon.awscdk.Stack;
82
- import software.amazon.awscdk.StackProps;
83
- import software.amazon.awscdk.services.lambda.*;
84
- import software.amazon.awscdk.services.lambda.Runtime;
85
- import software.amazon.awscdk.services.ssm.*;
86
- import software.amazon.awsconstructs.services.lambdassmstringparameter.*;
87
-
88
- new LambdaToSsmstringparameter(this, "test-lambda-ssmstringparameter-stack",
89
- new LambdaToSsmstringparameterProps.Builder()
90
- .lambdaFunctionProps(new FunctionProps.Builder()
91
- .runtime(Runtime.NODEJS_20_X)
92
- .code(Code.fromAsset("lambda"))
93
- .handler("index.handler")
94
- .build())
95
- .stringParameterProps(new StringParameterProps.Builder()
96
- .stringValue("test-string-value")
97
- .build())
98
- .build());
99
- ```
100
-
101
- ## Pattern Construct Props
102
-
103
- | **Name** | **Type** | **Description** |
104
- |:-------------|:----------------|-----------------|
105
- |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.|
106
- |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.|
107
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
108
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
109
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the parameter. Default: SSM_STRING_PARAMETER_NAME |
110
- |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 Systems Manager Parameter. 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.|
111
- |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.|
112
- |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`.|
113
- |stringParameterPermissions|`string`|Optional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".
114
-
115
- ## Pattern Properties
116
-
117
- | **Name** | **Type** | **Description** |
118
- |:-------------|:----------------|-----------------|
119
- |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|
120
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of ssm.StringParameter created by the construct|
121
- |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.|
122
-
123
- ## Default settings
124
-
125
- Out of the box implementation of the Construct without any override will set the following defaults:
126
-
127
- ### AWS Lambda Function
128
-
129
- * Configure limited privilege access IAM role for Lambda function
130
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
131
- * Enable X-Ray Tracing
132
- * Set Environment Variables
133
-
134
- * (default) SSM_STRING_PARAMETER_NAME
135
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
136
-
137
- ### Amazon AWS Systems Manager Parameter Store String
138
-
139
- * Enable read-only access for the associated AWS Lambda Function
140
- * Creates a new SSM String parameter with the values provided
141
- * Retain the SSM String parameter when deleting the CloudFormation stack
142
-
143
- ## Architecture
144
-
145
- ![Architecture Diagram](architecture.png)
146
-
147
- ---
148
-
149
-
150
- © 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-ssmstringparameter/README.adoc)
151
3
  '''
152
4
  from pkgutil import extend_path
153
5
  __path__ = extend_path(__path__, __name__)
{aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_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-ssmstringparameter",
37
- "2.85.1",
37
+ "2.85.3",
38
38
  __name__[0:-6],
39
- "aws-lambda-ssmstringparameter@2.85.1.jsii.tgz",
39
+ "aws-lambda-ssmstringparameter@2.85.3.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/PKG-INFO ADDED
@@ -0,0 +1,28 @@
1
+ Metadata-Version: 2.1
2
+ Name: aws-solutions-constructs.aws-lambda-ssmstringparameter
3
+ Version: 2.85.3
4
+ Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Systems Manager Parameter Store String parameter
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.3
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-ssmstringparameter/README.adoc)
{aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/SOURCES.txt RENAMED
@@ -11,4 +11,4 @@ src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/top_level.tx
11
11
  src/aws_solutions_constructs/aws_lambda_ssmstringparameter/__init__.py
12
12
  src/aws_solutions_constructs/aws_lambda_ssmstringparameter/py.typed
13
13
  src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_jsii/__init__.py
14
- src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_jsii/aws-lambda-ssmstringparameter@2.85.1.jsii.tgz
14
+ src/aws_solutions_constructs/aws_lambda_ssmstringparameter/_jsii/aws-lambda-ssmstringparameter@2.85.3.jsii.tgz
{aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1 → aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.3}/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.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.1
2
+ aws-solutions-constructs.core==2.85.3
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_ssmstringparameter-2.85.1/PKG-INFO DELETED
@@ -1,176 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-lambda-ssmstringparameter
3
- Version: 2.85.1
4
- Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Systems Manager Parameter Store String parameter
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.1
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-ssmstringparameter 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_ssm_string_parameter`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-ssmstringparameter`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdassmstringparameter`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements the AWS Lambda function and AWS Systems Manager Parameter Store String parameter 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 { LambdaToSsmstringparameterProps, LambdaToSsmstringparameter } from '@aws-solutions-constructs/aws-lambda-ssmstringparameter';
65
- import * as lambda from 'aws-cdk-lib/aws-lambda';
66
-
67
- const constructProps: LambdaToSsmstringparameterProps = {
68
- lambdaFunctionProps: {
69
- runtime: lambda.Runtime.NODEJS_20_X,
70
- code: lambda.Code.fromAsset(`lambda`),
71
- handler: 'index.handler'
72
- },
73
- stringParameterProps: { stringValue: "test-string-value" }
74
- };
75
-
76
- new LambdaToSsmstringparameter(this, 'test-lambda-ssmstringparameter-stack', constructProps);
77
- ```
78
-
79
- Python
80
-
81
- ```python
82
- from aws_solutions_constructs.aws_lambda_ssmstringparameter import LambdaToSsmstringparameter
83
- from aws_cdk import (
84
- aws_lambda as _lambda,
85
- aws_ssm as ssm,
86
- Stack
87
- )
88
- from constructs import Construct
89
-
90
- LambdaToSsmstringparameter(
91
- self, 'test-lambda-ssmstringparameter-stack',
92
- lambda_function_props=_lambda.FunctionProps(
93
- code=_lambda.Code.from_asset('lambda'),
94
- runtime=_lambda.Runtime.PYTHON_3_11,
95
- handler='index.handler'
96
- ),
97
- string_parameter_props=ssm.StringParameterProps(
98
- string_value="test-string-value")
99
- )
100
- ```
101
-
102
- Java
103
-
104
- ```java
105
- import software.constructs.Construct;
106
-
107
- import software.amazon.awscdk.Stack;
108
- import software.amazon.awscdk.StackProps;
109
- import software.amazon.awscdk.services.lambda.*;
110
- import software.amazon.awscdk.services.lambda.Runtime;
111
- import software.amazon.awscdk.services.ssm.*;
112
- import software.amazon.awsconstructs.services.lambdassmstringparameter.*;
113
-
114
- new LambdaToSsmstringparameter(this, "test-lambda-ssmstringparameter-stack",
115
- new LambdaToSsmstringparameterProps.Builder()
116
- .lambdaFunctionProps(new FunctionProps.Builder()
117
- .runtime(Runtime.NODEJS_20_X)
118
- .code(Code.fromAsset("lambda"))
119
- .handler("index.handler")
120
- .build())
121
- .stringParameterProps(new StringParameterProps.Builder()
122
- .stringValue("test-string-value")
123
- .build())
124
- .build());
125
- ```
126
-
127
- ## Pattern Construct Props
128
-
129
- | **Name** | **Type** | **Description** |
130
- |:-------------|:----------------|-----------------|
131
- |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.|
132
- |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.|
133
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
134
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
135
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the parameter. Default: SSM_STRING_PARAMETER_NAME |
136
- |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 Systems Manager Parameter. 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.|
137
- |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.|
138
- |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`.|
139
- |stringParameterPermissions|`string`|Optional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".
140
-
141
- ## Pattern Properties
142
-
143
- | **Name** | **Type** | **Description** |
144
- |:-------------|:----------------|-----------------|
145
- |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|
146
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of ssm.StringParameter created by the construct|
147
- |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.|
148
-
149
- ## Default settings
150
-
151
- Out of the box implementation of the Construct without any override will set the following defaults:
152
-
153
- ### AWS Lambda Function
154
-
155
- * Configure limited privilege access IAM role for Lambda function
156
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
157
- * Enable X-Ray Tracing
158
- * Set Environment Variables
159
-
160
- * (default) SSM_STRING_PARAMETER_NAME
161
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
162
-
163
- ### Amazon AWS Systems Manager Parameter Store String
164
-
165
- * Enable read-only access for the associated AWS Lambda Function
166
- * Creates a new SSM String parameter with the values provided
167
- * Retain the SSM String parameter when deleting the CloudFormation stack
168
-
169
- ## Architecture
170
-
171
- ![Architecture Diagram](architecture.png)
172
-
173
- ---
174
-
175
-
176
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1/README.md DELETED
@@ -1,149 +0,0 @@
1
- # aws-lambda-ssmstringparameter 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_ssm_string_parameter`|
23
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-ssmstringparameter`|
24
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdassmstringparameter`|
25
-
26
- ## Overview
27
-
28
- This AWS Solutions Construct implements the AWS Lambda function and AWS Systems Manager Parameter Store String parameter 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 { LambdaToSsmstringparameterProps, LambdaToSsmstringparameter } from '@aws-solutions-constructs/aws-lambda-ssmstringparameter';
38
- import * as lambda from 'aws-cdk-lib/aws-lambda';
39
-
40
- const constructProps: LambdaToSsmstringparameterProps = {
41
- lambdaFunctionProps: {
42
- runtime: lambda.Runtime.NODEJS_20_X,
43
- code: lambda.Code.fromAsset(`lambda`),
44
- handler: 'index.handler'
45
- },
46
- stringParameterProps: { stringValue: "test-string-value" }
47
- };
48
-
49
- new LambdaToSsmstringparameter(this, 'test-lambda-ssmstringparameter-stack', constructProps);
50
- ```
51
-
52
- Python
53
-
54
- ```python
55
- from aws_solutions_constructs.aws_lambda_ssmstringparameter import LambdaToSsmstringparameter
56
- from aws_cdk import (
57
- aws_lambda as _lambda,
58
- aws_ssm as ssm,
59
- Stack
60
- )
61
- from constructs import Construct
62
-
63
- LambdaToSsmstringparameter(
64
- self, 'test-lambda-ssmstringparameter-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
- string_parameter_props=ssm.StringParameterProps(
71
- string_value="test-string-value")
72
- )
73
- ```
74
-
75
- Java
76
-
77
- ```java
78
- import software.constructs.Construct;
79
-
80
- import software.amazon.awscdk.Stack;
81
- import software.amazon.awscdk.StackProps;
82
- import software.amazon.awscdk.services.lambda.*;
83
- import software.amazon.awscdk.services.lambda.Runtime;
84
- import software.amazon.awscdk.services.ssm.*;
85
- import software.amazon.awsconstructs.services.lambdassmstringparameter.*;
86
-
87
- new LambdaToSsmstringparameter(this, "test-lambda-ssmstringparameter-stack",
88
- new LambdaToSsmstringparameterProps.Builder()
89
- .lambdaFunctionProps(new FunctionProps.Builder()
90
- .runtime(Runtime.NODEJS_20_X)
91
- .code(Code.fromAsset("lambda"))
92
- .handler("index.handler")
93
- .build())
94
- .stringParameterProps(new StringParameterProps.Builder()
95
- .stringValue("test-string-value")
96
- .build())
97
- .build());
98
- ```
99
-
100
- ## Pattern Construct Props
101
-
102
- | **Name** | **Type** | **Description** |
103
- |:-------------|:----------------|-----------------|
104
- |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.|
105
- |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.|
106
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
107
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
108
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the parameter. Default: SSM_STRING_PARAMETER_NAME |
109
- |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 Systems Manager Parameter. 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.|
110
- |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.|
111
- |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`.|
112
- |stringParameterPermissions|`string`|Optional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".
113
-
114
- ## Pattern Properties
115
-
116
- | **Name** | **Type** | **Description** |
117
- |:-------------|:----------------|-----------------|
118
- |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|
119
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of ssm.StringParameter created by the construct|
120
- |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.|
121
-
122
- ## Default settings
123
-
124
- Out of the box implementation of the Construct without any override will set the following defaults:
125
-
126
- ### AWS Lambda Function
127
-
128
- * Configure limited privilege access IAM role for Lambda function
129
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
130
- * Enable X-Ray Tracing
131
- * Set Environment Variables
132
-
133
- * (default) SSM_STRING_PARAMETER_NAME
134
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
135
-
136
- ### Amazon AWS Systems Manager Parameter Store String
137
-
138
- * Enable read-only access for the associated AWS Lambda Function
139
- * Creates a new SSM String parameter with the values provided
140
- * Retain the SSM String parameter when deleting the CloudFormation stack
141
-
142
- ## Architecture
143
-
144
- ![Architecture Diagram](architecture.png)
145
-
146
- ---
147
-
148
-
149
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
aws_solutions_constructs_aws_lambda_ssmstringparameter-2.85.1/src/aws_solutions_constructs.aws_lambda_ssmstringparameter.egg-info/PKG-INFO DELETED
@@ -1,176 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aws-solutions-constructs.aws-lambda-ssmstringparameter
3
- Version: 2.85.1
4
- Summary: CDK constructs for defining an interaction between an AWS Lambda function and AWS Systems Manager Parameter Store String parameter
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.1
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-ssmstringparameter 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_ssm_string_parameter`|
50
- |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-lambda-ssmstringparameter`|
51
- |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) Java|`software.amazon.awsconstructs.services.lambdassmstringparameter`|
52
-
53
- ## Overview
54
-
55
- This AWS Solutions Construct implements the AWS Lambda function and AWS Systems Manager Parameter Store String parameter 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 { LambdaToSsmstringparameterProps, LambdaToSsmstringparameter } from '@aws-solutions-constructs/aws-lambda-ssmstringparameter';
65
- import * as lambda from 'aws-cdk-lib/aws-lambda';
66
-
67
- const constructProps: LambdaToSsmstringparameterProps = {
68
- lambdaFunctionProps: {
69
- runtime: lambda.Runtime.NODEJS_20_X,
70
- code: lambda.Code.fromAsset(`lambda`),
71
- handler: 'index.handler'
72
- },
73
- stringParameterProps: { stringValue: "test-string-value" }
74
- };
75
-
76
- new LambdaToSsmstringparameter(this, 'test-lambda-ssmstringparameter-stack', constructProps);
77
- ```
78
-
79
- Python
80
-
81
- ```python
82
- from aws_solutions_constructs.aws_lambda_ssmstringparameter import LambdaToSsmstringparameter
83
- from aws_cdk import (
84
- aws_lambda as _lambda,
85
- aws_ssm as ssm,
86
- Stack
87
- )
88
- from constructs import Construct
89
-
90
- LambdaToSsmstringparameter(
91
- self, 'test-lambda-ssmstringparameter-stack',
92
- lambda_function_props=_lambda.FunctionProps(
93
- code=_lambda.Code.from_asset('lambda'),
94
- runtime=_lambda.Runtime.PYTHON_3_11,
95
- handler='index.handler'
96
- ),
97
- string_parameter_props=ssm.StringParameterProps(
98
- string_value="test-string-value")
99
- )
100
- ```
101
-
102
- Java
103
-
104
- ```java
105
- import software.constructs.Construct;
106
-
107
- import software.amazon.awscdk.Stack;
108
- import software.amazon.awscdk.StackProps;
109
- import software.amazon.awscdk.services.lambda.*;
110
- import software.amazon.awscdk.services.lambda.Runtime;
111
- import software.amazon.awscdk.services.ssm.*;
112
- import software.amazon.awsconstructs.services.lambdassmstringparameter.*;
113
-
114
- new LambdaToSsmstringparameter(this, "test-lambda-ssmstringparameter-stack",
115
- new LambdaToSsmstringparameterProps.Builder()
116
- .lambdaFunctionProps(new FunctionProps.Builder()
117
- .runtime(Runtime.NODEJS_20_X)
118
- .code(Code.fromAsset("lambda"))
119
- .handler("index.handler")
120
- .build())
121
- .stringParameterProps(new StringParameterProps.Builder()
122
- .stringValue("test-string-value")
123
- .build())
124
- .build());
125
- ```
126
-
127
- ## Pattern Construct Props
128
-
129
- | **Name** | **Type** | **Description** |
130
- |:-------------|:----------------|-----------------|
131
- |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.|
132
- |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.|
133
- |existingStringParameterObj?|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Existing instance of SSM String parameter object, providing both this and `stringParameterProps` will cause an error|
134
- |stringParameterProps?|[`ssm.StringParameterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html)|Optional user provided props to override the default props for SSM String parameter. If existingStringParameterObj is not set stringParameterProps is required. The only supported [`ssm.StringParameterProps.type`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameterProps.html#type) is [`STRING`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterType.html#string) if a different value is provided it will be overridden.|
135
- |stringParameterEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the parameter. Default: SSM_STRING_PARAMETER_NAME |
136
- |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 Systems Manager Parameter. 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.|
137
- |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.|
138
- |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`.|
139
- |stringParameterPermissions|`string`|Optional SSM String parameter permissions to grant to the Lambda function. One of the following may be specified: "Read", "ReadWrite".
140
-
141
- ## Pattern Properties
142
-
143
- | **Name** | **Type** | **Description** |
144
- |:-------------|:----------------|-----------------|
145
- |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|
146
- |stringParameter|[`ssm.StringParameter`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.StringParameter.html)|Returns an instance of ssm.StringParameter created by the construct|
147
- |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.|
148
-
149
- ## Default settings
150
-
151
- Out of the box implementation of the Construct without any override will set the following defaults:
152
-
153
- ### AWS Lambda Function
154
-
155
- * Configure limited privilege access IAM role for Lambda function
156
- * Enable reusing connections with Keep-Alive for NodeJs Lambda function
157
- * Enable X-Ray Tracing
158
- * Set Environment Variables
159
-
160
- * (default) SSM_STRING_PARAMETER_NAME
161
- * AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
162
-
163
- ### Amazon AWS Systems Manager Parameter Store String
164
-
165
- * Enable read-only access for the associated AWS Lambda Function
166
- * Creates a new SSM String parameter with the values provided
167
- * Retain the SSM String parameter when deleting the CloudFormation stack
168
-
169
- ## Architecture
170
-
171
- ![Architecture Diagram](architecture.png)
172
-
173
- ---
174
-
175
-
176
- © Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.