aws-solutions-constructs.aws-lambda-s3 2.85.2__py3-none-any.whl → 2.85.4__py3-none-any.whl
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.
- aws_solutions_constructs/aws_lambda_s3/__init__.py +1 -141
- aws_solutions_constructs/aws_lambda_s3/_jsii/__init__.py +2 -2
- aws_solutions_constructs/aws_lambda_s3/_jsii/aws-lambda-s3@2.85.4.jsii.tgz +0 -0
- aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/METADATA +28 -0
- aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/RECORD +9 -0
- aws_solutions_constructs/aws_lambda_s3/_jsii/aws-lambda-s3@2.85.2.jsii.tgz +0 -0
- aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/METADATA +0 -168
- aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/RECORD +0 -9
- {aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info → aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info}/LICENSE +0 -0
- {aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info → aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info}/WHEEL +0 -0
- {aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info → aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info}/top_level.txt +0 -0
|
@@ -1,145 +1,5 @@
|
|
|
1
1
|
r'''
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
<!--BEGIN STABILITY BANNER-->---
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
<!--END STABILITY BANNER-->
|
|
11
|
-
|
|
12
|
-
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
|
13
|
-
|:-------------|:-------------|
|
|
14
|
-
|
|
15
|
-
<div style="height:8px"></div>
|
|
16
|
-
|
|
17
|
-
| **Language** | **Package** |
|
|
18
|
-
|:-------------|-----------------|
|
|
19
|
-
| Python|`aws_solutions_constructs.aws_lambda_s3`|
|
|
20
|
-
| Typescript|`@aws-solutions-constructs/aws-lambda-s3`|
|
|
21
|
-
| Java|`software.amazon.awsconstructs.services.lambdas3`|
|
|
22
|
-
|
|
23
|
-
## Overview
|
|
24
|
-
|
|
25
|
-
This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon S3 bucket.
|
|
26
|
-
|
|
27
|
-
Here is a minimal deployable pattern definition :
|
|
28
|
-
|
|
29
|
-
Typescript
|
|
30
|
-
|
|
31
|
-
```python
|
|
32
|
-
import { Construct } from 'constructs';
|
|
33
|
-
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
34
|
-
import { LambdaToS3 } from '@aws-solutions-constructs/aws-lambda-s3';
|
|
35
|
-
import * as lambda from 'aws-cdk-lib/aws-lambda';
|
|
36
|
-
|
|
37
|
-
new LambdaToS3(this, 'LambdaToS3Pattern', {
|
|
38
|
-
lambdaFunctionProps: {
|
|
39
|
-
runtime: lambda.Runtime.NODEJS_20_X,
|
|
40
|
-
handler: 'index.handler',
|
|
41
|
-
code: lambda.Code.fromAsset(`lambda`)
|
|
42
|
-
}
|
|
43
|
-
});
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
Python
|
|
47
|
-
|
|
48
|
-
```python
|
|
49
|
-
from aws_solutions_constructs.aws_lambda_s3 import LambdaToS3
|
|
50
|
-
from aws_cdk import (
|
|
51
|
-
aws_lambda as _lambda,
|
|
52
|
-
Stack
|
|
53
|
-
)
|
|
54
|
-
from constructs import Construct
|
|
55
|
-
|
|
56
|
-
LambdaToS3(self, 'LambdaToS3Pattern',
|
|
57
|
-
lambda_function_props=_lambda.FunctionProps(
|
|
58
|
-
code=_lambda.Code.from_asset('lambda'),
|
|
59
|
-
runtime=_lambda.Runtime.PYTHON_3_11,
|
|
60
|
-
handler='index.handler'
|
|
61
|
-
)
|
|
62
|
-
)
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
Java
|
|
66
|
-
|
|
67
|
-
```java
|
|
68
|
-
import software.constructs.Construct;
|
|
69
|
-
|
|
70
|
-
import software.amazon.awscdk.Stack;
|
|
71
|
-
import software.amazon.awscdk.StackProps;
|
|
72
|
-
import software.amazon.awscdk.services.lambda.*;
|
|
73
|
-
import software.amazon.awscdk.services.lambda.Runtime;
|
|
74
|
-
import software.amazon.awsconstructs.services.lambdas3.*;
|
|
75
|
-
|
|
76
|
-
new LambdaToS3(this, "LambdaToS3Pattern", new LambdaToS3Props.Builder()
|
|
77
|
-
.lambdaFunctionProps(new FunctionProps.Builder()
|
|
78
|
-
.runtime(Runtime.NODEJS_20_X)
|
|
79
|
-
.code(Code.fromAsset("lambda"))
|
|
80
|
-
.handler("index.handler")
|
|
81
|
-
.build())
|
|
82
|
-
.build());
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
## Pattern Construct Props
|
|
86
|
-
|
|
87
|
-
| **Name** | **Type** | **Description** |
|
|
88
|
-
|:-------------|:----------------|-----------------|
|
|
89
|
-
|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.|
|
|
90
|
-
|lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|Optional user provided props to override the default props for the Lambda function.|
|
|
91
|
-
|existingBucketObj?|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html)|Existing instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error. |
|
|
92
|
-
|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Bucket.|
|
|
93
|
-
|bucketPermissions?|`string[]`|Optional bucket permissions to grant to the Lambda function. One or more of the following may be specified: `Delete`, `Put`, `Read`, `ReadWrite`, `Write`.|
|
|
94
|
-
|existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html)|An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon S3. 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.|
|
|
95
|
-
|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.|
|
|
96
|
-
|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`.|
|
|
97
|
-
|bucketEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the bucket. Default: S3_BUCKET_NAME |
|
|
98
|
-
|loggingBucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Logging Bucket.|
|
|
99
|
-
|logS3AccessLogs?| boolean|Whether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true|
|
|
100
|
-
|
|
101
|
-
## Pattern Properties
|
|
102
|
-
|
|
103
|
-
| **Name** | **Type** | **Description** |
|
|
104
|
-
|:-------------|:----------------|-----------------|
|
|
105
|
-
|lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|
|
|
106
|
-
|s3Bucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|Returns an instance of the S3 bucket created by the pattern.|
|
|
107
|
-
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.|
|
|
108
|
-
|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.|
|
|
109
|
-
|s3BucketInterface|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html)|Returns an instance of s3.IBucket created by the construct.|
|
|
110
|
-
|
|
111
|
-
## Default settings
|
|
112
|
-
|
|
113
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
114
|
-
|
|
115
|
-
### AWS Lambda Function
|
|
116
|
-
|
|
117
|
-
* Configure limited privilege access IAM role for Lambda function
|
|
118
|
-
* Enable reusing connections with Keep-Alive for NodeJs Lambda function
|
|
119
|
-
* Enable X-Ray Tracing
|
|
120
|
-
* Set Environment Variables
|
|
121
|
-
|
|
122
|
-
* (default) S3_BUCKET_NAME
|
|
123
|
-
* AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
|
|
124
|
-
|
|
125
|
-
### Amazon S3 Bucket
|
|
126
|
-
|
|
127
|
-
* Configure Access logging for S3 Bucket
|
|
128
|
-
* Enable server-side encryption for S3 Bucket using AWS managed KMS Key
|
|
129
|
-
* Enforce encryption of data in transit
|
|
130
|
-
* Turn on the versioning for S3 Bucket
|
|
131
|
-
* Don't allow public access for S3 Bucket
|
|
132
|
-
* Retain the S3 Bucket when deleting the CloudFormation stack
|
|
133
|
-
* Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days
|
|
134
|
-
|
|
135
|
-
## Architecture
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
© 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-s3/README.adoc)
|
|
143
3
|
'''
|
|
144
4
|
from pkgutil import extend_path
|
|
145
5
|
__path__ = extend_path(__path__, __name__)
|
|
@@ -34,9 +34,9 @@ import constructs._jsii
|
|
|
34
34
|
|
|
35
35
|
__jsii_assembly__ = jsii.JSIIAssembly.load(
|
|
36
36
|
"@aws-solutions-constructs/aws-lambda-s3",
|
|
37
|
-
"2.85.
|
|
37
|
+
"2.85.4",
|
|
38
38
|
__name__[0:-6],
|
|
39
|
-
"aws-lambda-s3@2.85.
|
|
39
|
+
"aws-lambda-s3@2.85.4.jsii.tgz",
|
|
40
40
|
)
|
|
41
41
|
|
|
42
42
|
__all__ = [
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: aws-solutions-constructs.aws-lambda-s3
|
|
3
|
+
Version: 2.85.4
|
|
4
|
+
Summary: CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.
|
|
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-s3/README.adoc)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
aws_solutions_constructs/aws_lambda_s3/__init__.py,sha256=3cs6jIRtLevY5zo0NSTqk8bYas60eVwC8lGKT1kuZf4,21631
|
|
2
|
+
aws_solutions_constructs/aws_lambda_s3/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
|
3
|
+
aws_solutions_constructs/aws_lambda_s3/_jsii/__init__.py,sha256=HNvoYy1_v0AXzfMqPwJ5ybQxA89v-Do-gqoETXv1SBo,1521
|
|
4
|
+
aws_solutions_constructs/aws_lambda_s3/_jsii/aws-lambda-s3@2.85.4.jsii.tgz,sha256=EyTv1qOI1bP2-3UqCVW2KCJcIoo7Va0w4G7TrJYe-bY,120229
|
|
5
|
+
aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
|
|
6
|
+
aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/METADATA,sha256=EZw6WJSWwOcqG_44zS4x1BF7n-JBNsfhAZ5TdiQuplg,1311
|
|
7
|
+
aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
|
|
8
|
+
aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
|
|
9
|
+
aws_solutions_constructs_aws_lambda_s3-2.85.4.dist-info/RECORD,,
|
|
Binary file
|
|
@@ -1,168 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: aws-solutions-constructs.aws-lambda-s3
|
|
3
|
-
Version: 2.85.2
|
|
4
|
-
Summary: CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.
|
|
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-s3 module
|
|
29
|
-
|
|
30
|
-
<!--BEGIN STABILITY BANNER-->---
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
<!--END STABILITY BANNER-->
|
|
37
|
-
|
|
38
|
-
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
|
39
|
-
|:-------------|:-------------|
|
|
40
|
-
|
|
41
|
-
<div style="height:8px"></div>
|
|
42
|
-
|
|
43
|
-
| **Language** | **Package** |
|
|
44
|
-
|:-------------|-----------------|
|
|
45
|
-
| Python|`aws_solutions_constructs.aws_lambda_s3`|
|
|
46
|
-
| Typescript|`@aws-solutions-constructs/aws-lambda-s3`|
|
|
47
|
-
| Java|`software.amazon.awsconstructs.services.lambdas3`|
|
|
48
|
-
|
|
49
|
-
## Overview
|
|
50
|
-
|
|
51
|
-
This AWS Solutions Construct implements an AWS Lambda function connected to an Amazon S3 bucket.
|
|
52
|
-
|
|
53
|
-
Here is a minimal deployable pattern definition :
|
|
54
|
-
|
|
55
|
-
Typescript
|
|
56
|
-
|
|
57
|
-
```python
|
|
58
|
-
import { Construct } from 'constructs';
|
|
59
|
-
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
60
|
-
import { LambdaToS3 } from '@aws-solutions-constructs/aws-lambda-s3';
|
|
61
|
-
import * as lambda from 'aws-cdk-lib/aws-lambda';
|
|
62
|
-
|
|
63
|
-
new LambdaToS3(this, 'LambdaToS3Pattern', {
|
|
64
|
-
lambdaFunctionProps: {
|
|
65
|
-
runtime: lambda.Runtime.NODEJS_20_X,
|
|
66
|
-
handler: 'index.handler',
|
|
67
|
-
code: lambda.Code.fromAsset(`lambda`)
|
|
68
|
-
}
|
|
69
|
-
});
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
Python
|
|
73
|
-
|
|
74
|
-
```python
|
|
75
|
-
from aws_solutions_constructs.aws_lambda_s3 import LambdaToS3
|
|
76
|
-
from aws_cdk import (
|
|
77
|
-
aws_lambda as _lambda,
|
|
78
|
-
Stack
|
|
79
|
-
)
|
|
80
|
-
from constructs import Construct
|
|
81
|
-
|
|
82
|
-
LambdaToS3(self, 'LambdaToS3Pattern',
|
|
83
|
-
lambda_function_props=_lambda.FunctionProps(
|
|
84
|
-
code=_lambda.Code.from_asset('lambda'),
|
|
85
|
-
runtime=_lambda.Runtime.PYTHON_3_11,
|
|
86
|
-
handler='index.handler'
|
|
87
|
-
)
|
|
88
|
-
)
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Java
|
|
92
|
-
|
|
93
|
-
```java
|
|
94
|
-
import software.constructs.Construct;
|
|
95
|
-
|
|
96
|
-
import software.amazon.awscdk.Stack;
|
|
97
|
-
import software.amazon.awscdk.StackProps;
|
|
98
|
-
import software.amazon.awscdk.services.lambda.*;
|
|
99
|
-
import software.amazon.awscdk.services.lambda.Runtime;
|
|
100
|
-
import software.amazon.awsconstructs.services.lambdas3.*;
|
|
101
|
-
|
|
102
|
-
new LambdaToS3(this, "LambdaToS3Pattern", new LambdaToS3Props.Builder()
|
|
103
|
-
.lambdaFunctionProps(new FunctionProps.Builder()
|
|
104
|
-
.runtime(Runtime.NODEJS_20_X)
|
|
105
|
-
.code(Code.fromAsset("lambda"))
|
|
106
|
-
.handler("index.handler")
|
|
107
|
-
.build())
|
|
108
|
-
.build());
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
## Pattern Construct Props
|
|
112
|
-
|
|
113
|
-
| **Name** | **Type** | **Description** |
|
|
114
|
-
|:-------------|:----------------|-----------------|
|
|
115
|
-
|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.|
|
|
116
|
-
|lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.FunctionProps.html)|Optional user provided props to override the default props for the Lambda function.|
|
|
117
|
-
|existingBucketObj?|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html)|Existing instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error. |
|
|
118
|
-
|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Bucket.|
|
|
119
|
-
|bucketPermissions?|`string[]`|Optional bucket permissions to grant to the Lambda function. One or more of the following may be specified: `Delete`, `Put`, `Read`, `ReadWrite`, `Write`.|
|
|
120
|
-
|existingVpc?|[`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html)|An optional, existing VPC into which this pattern should be deployed. When deployed in a VPC, the Lambda function will use ENIs in the VPC to access network resources and an Interface Endpoint will be created in the VPC for Amazon S3. 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.|
|
|
121
|
-
|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.|
|
|
122
|
-
|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`.|
|
|
123
|
-
|bucketEnvironmentVariableName?|`string`|Optional Name for the Lambda function environment variable set to the name of the bucket. Default: S3_BUCKET_NAME |
|
|
124
|
-
|loggingBucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Logging Bucket.|
|
|
125
|
-
|logS3AccessLogs?| boolean|Whether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true|
|
|
126
|
-
|
|
127
|
-
## Pattern Properties
|
|
128
|
-
|
|
129
|
-
| **Name** | **Type** | **Description** |
|
|
130
|
-
|:-------------|:----------------|-----------------|
|
|
131
|
-
|lambdaFunction|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|
|
|
132
|
-
|s3Bucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|Returns an instance of the S3 bucket created by the pattern.|
|
|
133
|
-
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.|
|
|
134
|
-
|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.|
|
|
135
|
-
|s3BucketInterface|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html)|Returns an instance of s3.IBucket created by the construct.|
|
|
136
|
-
|
|
137
|
-
## Default settings
|
|
138
|
-
|
|
139
|
-
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
140
|
-
|
|
141
|
-
### AWS Lambda Function
|
|
142
|
-
|
|
143
|
-
* Configure limited privilege access IAM role for Lambda function
|
|
144
|
-
* Enable reusing connections with Keep-Alive for NodeJs Lambda function
|
|
145
|
-
* Enable X-Ray Tracing
|
|
146
|
-
* Set Environment Variables
|
|
147
|
-
|
|
148
|
-
* (default) S3_BUCKET_NAME
|
|
149
|
-
* AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
|
|
150
|
-
|
|
151
|
-
### Amazon S3 Bucket
|
|
152
|
-
|
|
153
|
-
* Configure Access logging for S3 Bucket
|
|
154
|
-
* Enable server-side encryption for S3 Bucket using AWS managed KMS Key
|
|
155
|
-
* Enforce encryption of data in transit
|
|
156
|
-
* Turn on the versioning for S3 Bucket
|
|
157
|
-
* Don't allow public access for S3 Bucket
|
|
158
|
-
* Retain the S3 Bucket when deleting the CloudFormation stack
|
|
159
|
-
* Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days
|
|
160
|
-
|
|
161
|
-
## Architecture
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
aws_solutions_constructs/aws_lambda_s3/__init__.py,sha256=D12iyadl-8b2RFqzM36F_BGj7LpXwJ0at-RmmIB-4Jg,29341
|
|
2
|
-
aws_solutions_constructs/aws_lambda_s3/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
|
3
|
-
aws_solutions_constructs/aws_lambda_s3/_jsii/__init__.py,sha256=7YBPQ58FiaRYf8n0G6Y409LSBuLNoyax2CLQ2ih8foQ,1521
|
|
4
|
-
aws_solutions_constructs/aws_lambda_s3/_jsii/aws-lambda-s3@2.85.2.jsii.tgz,sha256=bdaQ9cNrb-e5UzYpmY7wNX1owRrLOLvFxPrqF8qIfr4,122738
|
|
5
|
-
aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
|
|
6
|
-
aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/METADATA,sha256=8wOj94c1SqelgMAS_j3G_V-KBo4uTp8m6_xRAGn_fjM,9021
|
|
7
|
-
aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
|
|
8
|
-
aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
|
|
9
|
-
aws_solutions_constructs_aws_lambda_s3-2.85.2.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|