aws-solutions-constructs.aws-constructs-factories 2.56.0__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.
- aws-solutions-constructs.aws-constructs-factories-2.56.0/LICENSE +73 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/MANIFEST.in +1 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/PKG-INFO +133 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/README.md +111 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/pyproject.toml +9 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/setup.cfg +4 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/setup.py +66 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs/aws_constructs_factories/__init__.py +333 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs/aws_constructs_factories/_jsii/__init__.py +32 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs/aws_constructs_factories/_jsii/aws-constructs-factories@2.56.0.jsii.tgz +0 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs/aws_constructs_factories/py.typed +1 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs.aws_constructs_factories.egg-info/PKG-INFO +133 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs.aws_constructs_factories.egg-info/SOURCES.txt +14 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs.aws_constructs_factories.egg-info/dependency_links.txt +1 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs.aws_constructs_factories.egg-info/requires.txt +7 -0
- aws-solutions-constructs.aws-constructs-factories-2.56.0/src/aws_solutions_constructs.aws_constructs_factories.egg-info/top_level.txt +1 -0
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
|
|
10
|
+
|
|
11
|
+
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
|
|
12
|
+
|
|
13
|
+
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
|
14
|
+
|
|
15
|
+
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
|
|
16
|
+
|
|
17
|
+
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
|
|
18
|
+
|
|
19
|
+
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
|
|
20
|
+
|
|
21
|
+
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
|
|
22
|
+
|
|
23
|
+
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
|
24
|
+
|
|
25
|
+
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
|
|
26
|
+
|
|
27
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
|
|
28
|
+
|
|
29
|
+
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
|
|
30
|
+
|
|
31
|
+
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
|
|
32
|
+
|
|
33
|
+
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
|
|
34
|
+
|
|
35
|
+
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
|
36
|
+
|
|
37
|
+
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
|
|
38
|
+
|
|
39
|
+
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
|
|
40
|
+
|
|
41
|
+
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
|
|
42
|
+
|
|
43
|
+
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
|
|
44
|
+
|
|
45
|
+
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
|
|
46
|
+
|
|
47
|
+
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
|
|
48
|
+
|
|
49
|
+
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
|
|
50
|
+
|
|
51
|
+
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
|
52
|
+
|
|
53
|
+
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
|
|
54
|
+
|
|
55
|
+
END OF TERMS AND CONDITIONS
|
|
56
|
+
|
|
57
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
58
|
+
|
|
59
|
+
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
|
|
60
|
+
|
|
61
|
+
Copyright [yyyy] [name of copyright owner]
|
|
62
|
+
|
|
63
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
64
|
+
you may not use this file except in compliance with the License.
|
|
65
|
+
You may obtain a copy of the License at
|
|
66
|
+
|
|
67
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
68
|
+
|
|
69
|
+
Unless required by applicable law or agreed to in writing, software
|
|
70
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
71
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
72
|
+
See the License for the specific language governing permissions and
|
|
73
|
+
limitations under the License.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
include pyproject.toml
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: aws-solutions-constructs.aws-constructs-factories
|
|
3
|
+
Version: 2.56.0
|
|
4
|
+
Summary: Factories to allow creation of individual resources
|
|
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.8
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Typing :: Typed
|
|
18
|
+
Classifier: License :: OSI Approved
|
|
19
|
+
Requires-Python: ~=3.8
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
|
|
23
|
+
# aws-constructs-factories module
|
|
24
|
+
|
|
25
|
+
<!--BEGIN STABILITY BANNER-->---
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+

|
|
29
|
+
|
|
30
|
+
> All classes are under active development and subject to non-backward compatible changes or removal in any
|
|
31
|
+
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
|
|
32
|
+
> 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.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
<!--END STABILITY BANNER-->
|
|
36
|
+
|
|
37
|
+
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
|
38
|
+
|:-------------|:-------------|
|
|
39
|
+
|
|
40
|
+
<div style="height:8px"></div>
|
|
41
|
+
|
|
42
|
+
| **Language** | **Package** |
|
|
43
|
+
|:-------------|-----------------|
|
|
44
|
+
| Python|`aws_solutions_constructs.aws_constructs_factories`|
|
|
45
|
+
| Typescript|`@aws-solutions-constructs/aws-constructs-factories`|
|
|
46
|
+
| Java|`software.amazon.awsconstructs.services.constructsfactories`|
|
|
47
|
+
|
|
48
|
+
## Overview
|
|
49
|
+
|
|
50
|
+
This AWS Solutions Construct exposes the same code used to create our underlying resources as factories, so clients can create individual resources that are well-architected.
|
|
51
|
+
|
|
52
|
+
### S3 Buckets
|
|
53
|
+
|
|
54
|
+
Create fully well-architected S3 buckets with as little as one function call. Here is a minimal deployable pattern definition:
|
|
55
|
+
|
|
56
|
+
Typescript
|
|
57
|
+
|
|
58
|
+
```python
|
|
59
|
+
import { Construct } from 'constructs';
|
|
60
|
+
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
61
|
+
import { ConstructsFactories } from '@aws-solutions-constructs/aws-constructs-factories';
|
|
62
|
+
|
|
63
|
+
const factories = new ConstructsFactories(this, 'integ-test');
|
|
64
|
+
|
|
65
|
+
factories.s3BucketFactory('test', {});
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Python
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
# TBD
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Java
|
|
75
|
+
|
|
76
|
+
```java
|
|
77
|
+
// TBD
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## S3BucketFactory Function Signature
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
s3BucketFactory(id: string, props: S3BucketFactoryProps): S3BucketFactoryResponse
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## S3BucketFactoryProps
|
|
87
|
+
|
|
88
|
+
| **Name** | **Type** | **Description** |
|
|
89
|
+
|:-------------|:----------------|-----------------|
|
|
90
|
+
|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.|
|
|
91
|
+
|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|
|
|
92
|
+
|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.|
|
|
93
|
+
|
|
94
|
+
## S3BucketFactoryResponse
|
|
95
|
+
|
|
96
|
+
| **Name** | **Type** | **Description** |
|
|
97
|
+
|:-------------|:----------------|-----------------|
|
|
98
|
+
|s3Bucket|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the factory. |
|
|
99
|
+
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the construct as the logging bucket for the primary bucket. If the logS3AccessLogs property is false, this value will be undefined.|
|
|
100
|
+
|
|
101
|
+
## Default settings
|
|
102
|
+
|
|
103
|
+
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
104
|
+
|
|
105
|
+
* An S3 Content Bucket
|
|
106
|
+
|
|
107
|
+
* AWS managed Server Side Encryption (AES256)
|
|
108
|
+
* Lifecycle rule to transition objects to Glacier storage class in 90 days
|
|
109
|
+
* Access Logging enabled
|
|
110
|
+
* All Public access blocked
|
|
111
|
+
* Versioning enabled
|
|
112
|
+
* UpdateReplacePolicy is delete
|
|
113
|
+
* Deletion policy is delete
|
|
114
|
+
* Bucket policy requiring SecureTransport
|
|
115
|
+
* An S3 Bucket for Access Logs
|
|
116
|
+
|
|
117
|
+
* AWS managed Server Side Encryption (AES256)
|
|
118
|
+
* All public access blocked
|
|
119
|
+
* Versioning enabled
|
|
120
|
+
* UpdateReplacePolicy is delete
|
|
121
|
+
* Deletion policy is delete
|
|
122
|
+
* Bucket policy requiring SecureTransport
|
|
123
|
+
* Bucket policy granting PutObject privileges to the S3 logging service, from the content bucket in the content bucket account.
|
|
124
|
+
* cfn_nag suppression of access logging finding (not logging access to the access log bucket)
|
|
125
|
+
|
|
126
|
+
## Architecture
|
|
127
|
+
|
|
128
|
+

|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# aws-constructs-factories module
|
|
2
|
+
|
|
3
|
+
<!--BEGIN STABILITY BANNER-->---
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+

|
|
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|`aws_solutions_constructs.aws_constructs_factories`|
|
|
23
|
+
| Typescript|`@aws-solutions-constructs/aws-constructs-factories`|
|
|
24
|
+
| Java|`software.amazon.awsconstructs.services.constructsfactories`|
|
|
25
|
+
|
|
26
|
+
## Overview
|
|
27
|
+
|
|
28
|
+
This AWS Solutions Construct exposes the same code used to create our underlying resources as factories, so clients can create individual resources that are well-architected.
|
|
29
|
+
|
|
30
|
+
### S3 Buckets
|
|
31
|
+
|
|
32
|
+
Create fully well-architected S3 buckets with as little as one function call. Here is a minimal deployable pattern definition:
|
|
33
|
+
|
|
34
|
+
Typescript
|
|
35
|
+
|
|
36
|
+
```python
|
|
37
|
+
import { Construct } from 'constructs';
|
|
38
|
+
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
39
|
+
import { ConstructsFactories } from '@aws-solutions-constructs/aws-constructs-factories';
|
|
40
|
+
|
|
41
|
+
const factories = new ConstructsFactories(this, 'integ-test');
|
|
42
|
+
|
|
43
|
+
factories.s3BucketFactory('test', {});
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Python
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
# TBD
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Java
|
|
53
|
+
|
|
54
|
+
```java
|
|
55
|
+
// TBD
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## S3BucketFactory Function Signature
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
s3BucketFactory(id: string, props: S3BucketFactoryProps): S3BucketFactoryResponse
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## S3BucketFactoryProps
|
|
65
|
+
|
|
66
|
+
| **Name** | **Type** | **Description** |
|
|
67
|
+
|:-------------|:----------------|-----------------|
|
|
68
|
+
|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.|
|
|
69
|
+
|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|
|
|
70
|
+
|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.|
|
|
71
|
+
|
|
72
|
+
## S3BucketFactoryResponse
|
|
73
|
+
|
|
74
|
+
| **Name** | **Type** | **Description** |
|
|
75
|
+
|:-------------|:----------------|-----------------|
|
|
76
|
+
|s3Bucket|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the factory. |
|
|
77
|
+
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the construct as the logging bucket for the primary bucket. If the logS3AccessLogs property is false, this value will be undefined.|
|
|
78
|
+
|
|
79
|
+
## Default settings
|
|
80
|
+
|
|
81
|
+
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
82
|
+
|
|
83
|
+
* An S3 Content Bucket
|
|
84
|
+
|
|
85
|
+
* AWS managed Server Side Encryption (AES256)
|
|
86
|
+
* Lifecycle rule to transition objects to Glacier storage class in 90 days
|
|
87
|
+
* Access Logging enabled
|
|
88
|
+
* All Public access blocked
|
|
89
|
+
* Versioning enabled
|
|
90
|
+
* UpdateReplacePolicy is delete
|
|
91
|
+
* Deletion policy is delete
|
|
92
|
+
* Bucket policy requiring SecureTransport
|
|
93
|
+
* An S3 Bucket for Access Logs
|
|
94
|
+
|
|
95
|
+
* AWS managed Server Side Encryption (AES256)
|
|
96
|
+
* All public access blocked
|
|
97
|
+
* Versioning enabled
|
|
98
|
+
* UpdateReplacePolicy is delete
|
|
99
|
+
* Deletion policy is delete
|
|
100
|
+
* Bucket policy requiring SecureTransport
|
|
101
|
+
* Bucket policy granting PutObject privileges to the S3 logging service, from the content bucket in the content bucket account.
|
|
102
|
+
* cfn_nag suppression of access logging finding (not logging access to the access log bucket)
|
|
103
|
+
|
|
104
|
+
## Architecture
|
|
105
|
+
|
|
106
|
+

|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import json
|
|
2
|
+
import setuptools
|
|
3
|
+
|
|
4
|
+
kwargs = json.loads(
|
|
5
|
+
"""
|
|
6
|
+
{
|
|
7
|
+
"name": "aws-solutions-constructs.aws-constructs-factories",
|
|
8
|
+
"version": "2.56.0",
|
|
9
|
+
"description": "Factories to allow creation of individual resources",
|
|
10
|
+
"license": "Apache-2.0",
|
|
11
|
+
"url": "https://github.com/awslabs/aws-solutions-constructs.git",
|
|
12
|
+
"long_description_content_type": "text/markdown",
|
|
13
|
+
"author": "Amazon Web Services",
|
|
14
|
+
"bdist_wheel": {
|
|
15
|
+
"universal": true
|
|
16
|
+
},
|
|
17
|
+
"project_urls": {
|
|
18
|
+
"Source": "https://github.com/awslabs/aws-solutions-constructs.git"
|
|
19
|
+
},
|
|
20
|
+
"package_dir": {
|
|
21
|
+
"": "src"
|
|
22
|
+
},
|
|
23
|
+
"packages": [
|
|
24
|
+
"aws_solutions_constructs.aws_constructs_factories",
|
|
25
|
+
"aws_solutions_constructs.aws_constructs_factories._jsii"
|
|
26
|
+
],
|
|
27
|
+
"package_data": {
|
|
28
|
+
"aws_solutions_constructs.aws_constructs_factories._jsii": [
|
|
29
|
+
"aws-constructs-factories@2.56.0.jsii.tgz"
|
|
30
|
+
],
|
|
31
|
+
"aws_solutions_constructs.aws_constructs_factories": [
|
|
32
|
+
"py.typed"
|
|
33
|
+
]
|
|
34
|
+
},
|
|
35
|
+
"python_requires": "~=3.8",
|
|
36
|
+
"install_requires": [
|
|
37
|
+
"aws-cdk-lib==2.138.0",
|
|
38
|
+
"aws-cdk.integ-tests-alpha==2.138.0.a0",
|
|
39
|
+
"aws-solutions-constructs.core==2.56.0",
|
|
40
|
+
"constructs>=10.0.0, <11.0.0",
|
|
41
|
+
"jsii>=1.97.0, <2.0.0",
|
|
42
|
+
"publication>=0.0.3",
|
|
43
|
+
"typeguard~=2.13.3"
|
|
44
|
+
],
|
|
45
|
+
"classifiers": [
|
|
46
|
+
"Intended Audience :: Developers",
|
|
47
|
+
"Operating System :: OS Independent",
|
|
48
|
+
"Programming Language :: JavaScript",
|
|
49
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
50
|
+
"Programming Language :: Python :: 3.8",
|
|
51
|
+
"Programming Language :: Python :: 3.9",
|
|
52
|
+
"Programming Language :: Python :: 3.10",
|
|
53
|
+
"Programming Language :: Python :: 3.11",
|
|
54
|
+
"Typing :: Typed",
|
|
55
|
+
"License :: OSI Approved"
|
|
56
|
+
],
|
|
57
|
+
"scripts": []
|
|
58
|
+
}
|
|
59
|
+
"""
|
|
60
|
+
)
|
|
61
|
+
|
|
62
|
+
with open("README.md", encoding="utf8") as fp:
|
|
63
|
+
kwargs["long_description"] = fp.read()
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
setuptools.setup(**kwargs)
|
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
'''
|
|
2
|
+
# aws-constructs-factories module
|
|
3
|
+
|
|
4
|
+
<!--BEGIN STABILITY BANNER-->---
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+

|
|
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|`aws_solutions_constructs.aws_constructs_factories`|
|
|
24
|
+
| Typescript|`@aws-solutions-constructs/aws-constructs-factories`|
|
|
25
|
+
| Java|`software.amazon.awsconstructs.services.constructsfactories`|
|
|
26
|
+
|
|
27
|
+
## Overview
|
|
28
|
+
|
|
29
|
+
This AWS Solutions Construct exposes the same code used to create our underlying resources as factories, so clients can create individual resources that are well-architected.
|
|
30
|
+
|
|
31
|
+
### S3 Buckets
|
|
32
|
+
|
|
33
|
+
Create fully well-architected S3 buckets with as little as one function call. Here is a minimal deployable pattern definition:
|
|
34
|
+
|
|
35
|
+
Typescript
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
import { Construct } from 'constructs';
|
|
39
|
+
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
40
|
+
import { ConstructsFactories } from '@aws-solutions-constructs/aws-constructs-factories';
|
|
41
|
+
|
|
42
|
+
const factories = new ConstructsFactories(this, 'integ-test');
|
|
43
|
+
|
|
44
|
+
factories.s3BucketFactory('test', {});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Python
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
# TBD
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Java
|
|
54
|
+
|
|
55
|
+
```java
|
|
56
|
+
// TBD
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## S3BucketFactory Function Signature
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
s3BucketFactory(id: string, props: S3BucketFactoryProps): S3BucketFactoryResponse
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## S3BucketFactoryProps
|
|
66
|
+
|
|
67
|
+
| **Name** | **Type** | **Description** |
|
|
68
|
+
|:-------------|:----------------|-----------------|
|
|
69
|
+
|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.|
|
|
70
|
+
|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|
|
|
71
|
+
|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.|
|
|
72
|
+
|
|
73
|
+
## S3BucketFactoryResponse
|
|
74
|
+
|
|
75
|
+
| **Name** | **Type** | **Description** |
|
|
76
|
+
|:-------------|:----------------|-----------------|
|
|
77
|
+
|s3Bucket|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the factory. |
|
|
78
|
+
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the construct as the logging bucket for the primary bucket. If the logS3AccessLogs property is false, this value will be undefined.|
|
|
79
|
+
|
|
80
|
+
## Default settings
|
|
81
|
+
|
|
82
|
+
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
83
|
+
|
|
84
|
+
* An S3 Content Bucket
|
|
85
|
+
|
|
86
|
+
* AWS managed Server Side Encryption (AES256)
|
|
87
|
+
* Lifecycle rule to transition objects to Glacier storage class in 90 days
|
|
88
|
+
* Access Logging enabled
|
|
89
|
+
* All Public access blocked
|
|
90
|
+
* Versioning enabled
|
|
91
|
+
* UpdateReplacePolicy is delete
|
|
92
|
+
* Deletion policy is delete
|
|
93
|
+
* Bucket policy requiring SecureTransport
|
|
94
|
+
* An S3 Bucket for Access Logs
|
|
95
|
+
|
|
96
|
+
* AWS managed Server Side Encryption (AES256)
|
|
97
|
+
* All public access blocked
|
|
98
|
+
* Versioning enabled
|
|
99
|
+
* UpdateReplacePolicy is delete
|
|
100
|
+
* Deletion policy is delete
|
|
101
|
+
* Bucket policy requiring SecureTransport
|
|
102
|
+
* Bucket policy granting PutObject privileges to the S3 logging service, from the content bucket in the content bucket account.
|
|
103
|
+
* cfn_nag suppression of access logging finding (not logging access to the access log bucket)
|
|
104
|
+
|
|
105
|
+
## Architecture
|
|
106
|
+
|
|
107
|
+

|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
113
|
+
'''
|
|
114
|
+
from pkgutil import extend_path
|
|
115
|
+
__path__ = extend_path(__path__, __name__)
|
|
116
|
+
|
|
117
|
+
import abc
|
|
118
|
+
import builtins
|
|
119
|
+
import datetime
|
|
120
|
+
import enum
|
|
121
|
+
import typing
|
|
122
|
+
|
|
123
|
+
import jsii
|
|
124
|
+
import publication
|
|
125
|
+
import typing_extensions
|
|
126
|
+
|
|
127
|
+
from typeguard import check_type
|
|
128
|
+
|
|
129
|
+
from ._jsii import *
|
|
130
|
+
|
|
131
|
+
import aws_cdk.aws_s3 as _aws_cdk_aws_s3_ceddda9d
|
|
132
|
+
import constructs as _constructs_77d1e7e8
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
class ConstructsFactories(
|
|
136
|
+
_constructs_77d1e7e8.Construct,
|
|
137
|
+
metaclass=jsii.JSIIMeta,
|
|
138
|
+
jsii_type="@aws-solutions-constructs/aws-constructs-factories.ConstructsFactories",
|
|
139
|
+
):
|
|
140
|
+
def __init__(self, scope: _constructs_77d1e7e8.Construct, id: builtins.str) -> None:
|
|
141
|
+
'''
|
|
142
|
+
:param scope: -
|
|
143
|
+
:param id: -
|
|
144
|
+
'''
|
|
145
|
+
if __debug__:
|
|
146
|
+
type_hints = typing.get_type_hints(_typecheckingstub__605983066d245d838df0751ca3d83223b93e3dac7281a9b7677ff8c39ccd96d4)
|
|
147
|
+
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
148
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
149
|
+
jsii.create(self.__class__, self, [scope, id])
|
|
150
|
+
|
|
151
|
+
@jsii.member(jsii_name="s3BucketFactory")
|
|
152
|
+
def s3_bucket_factory(
|
|
153
|
+
self,
|
|
154
|
+
id: builtins.str,
|
|
155
|
+
*,
|
|
156
|
+
bucket_props: typing.Any = None,
|
|
157
|
+
logging_bucket_props: typing.Optional[typing.Union[_aws_cdk_aws_s3_ceddda9d.BucketProps, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
158
|
+
log_s3_access_logs: typing.Optional[builtins.bool] = None,
|
|
159
|
+
) -> "S3BucketFactoryResponse":
|
|
160
|
+
'''
|
|
161
|
+
:param id: -
|
|
162
|
+
:param bucket_props: -
|
|
163
|
+
:param logging_bucket_props: -
|
|
164
|
+
:param log_s3_access_logs: -
|
|
165
|
+
'''
|
|
166
|
+
if __debug__:
|
|
167
|
+
type_hints = typing.get_type_hints(_typecheckingstub__25b90bfb94c5304484be85483634a7064b119ae1b0c5ed7cfc594e3e7bbf37f0)
|
|
168
|
+
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
169
|
+
props = S3BucketFactoryProps(
|
|
170
|
+
bucket_props=bucket_props,
|
|
171
|
+
logging_bucket_props=logging_bucket_props,
|
|
172
|
+
log_s3_access_logs=log_s3_access_logs,
|
|
173
|
+
)
|
|
174
|
+
|
|
175
|
+
return typing.cast("S3BucketFactoryResponse", jsii.invoke(self, "s3BucketFactory", [id, props]))
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
@jsii.data_type(
|
|
179
|
+
jsii_type="@aws-solutions-constructs/aws-constructs-factories.S3BucketFactoryProps",
|
|
180
|
+
jsii_struct_bases=[],
|
|
181
|
+
name_mapping={
|
|
182
|
+
"bucket_props": "bucketProps",
|
|
183
|
+
"logging_bucket_props": "loggingBucketProps",
|
|
184
|
+
"log_s3_access_logs": "logS3AccessLogs",
|
|
185
|
+
},
|
|
186
|
+
)
|
|
187
|
+
class S3BucketFactoryProps:
|
|
188
|
+
def __init__(
|
|
189
|
+
self,
|
|
190
|
+
*,
|
|
191
|
+
bucket_props: typing.Any = None,
|
|
192
|
+
logging_bucket_props: typing.Optional[typing.Union[_aws_cdk_aws_s3_ceddda9d.BucketProps, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
193
|
+
log_s3_access_logs: typing.Optional[builtins.bool] = None,
|
|
194
|
+
) -> None:
|
|
195
|
+
'''
|
|
196
|
+
:param bucket_props: -
|
|
197
|
+
:param logging_bucket_props: -
|
|
198
|
+
:param log_s3_access_logs: -
|
|
199
|
+
'''
|
|
200
|
+
if isinstance(logging_bucket_props, dict):
|
|
201
|
+
logging_bucket_props = _aws_cdk_aws_s3_ceddda9d.BucketProps(**logging_bucket_props)
|
|
202
|
+
if __debug__:
|
|
203
|
+
type_hints = typing.get_type_hints(_typecheckingstub__45a251aca0d0848bcaeaed9669ce040e9bd9f304c875a3796313bd27abcdacc3)
|
|
204
|
+
check_type(argname="argument bucket_props", value=bucket_props, expected_type=type_hints["bucket_props"])
|
|
205
|
+
check_type(argname="argument logging_bucket_props", value=logging_bucket_props, expected_type=type_hints["logging_bucket_props"])
|
|
206
|
+
check_type(argname="argument log_s3_access_logs", value=log_s3_access_logs, expected_type=type_hints["log_s3_access_logs"])
|
|
207
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
208
|
+
if bucket_props is not None:
|
|
209
|
+
self._values["bucket_props"] = bucket_props
|
|
210
|
+
if logging_bucket_props is not None:
|
|
211
|
+
self._values["logging_bucket_props"] = logging_bucket_props
|
|
212
|
+
if log_s3_access_logs is not None:
|
|
213
|
+
self._values["log_s3_access_logs"] = log_s3_access_logs
|
|
214
|
+
|
|
215
|
+
@builtins.property
|
|
216
|
+
def bucket_props(self) -> typing.Any:
|
|
217
|
+
result = self._values.get("bucket_props")
|
|
218
|
+
return typing.cast(typing.Any, result)
|
|
219
|
+
|
|
220
|
+
@builtins.property
|
|
221
|
+
def logging_bucket_props(
|
|
222
|
+
self,
|
|
223
|
+
) -> typing.Optional[_aws_cdk_aws_s3_ceddda9d.BucketProps]:
|
|
224
|
+
result = self._values.get("logging_bucket_props")
|
|
225
|
+
return typing.cast(typing.Optional[_aws_cdk_aws_s3_ceddda9d.BucketProps], result)
|
|
226
|
+
|
|
227
|
+
@builtins.property
|
|
228
|
+
def log_s3_access_logs(self) -> typing.Optional[builtins.bool]:
|
|
229
|
+
result = self._values.get("log_s3_access_logs")
|
|
230
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
231
|
+
|
|
232
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
233
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
234
|
+
|
|
235
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
236
|
+
return not (rhs == self)
|
|
237
|
+
|
|
238
|
+
def __repr__(self) -> str:
|
|
239
|
+
return "S3BucketFactoryProps(%s)" % ", ".join(
|
|
240
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
241
|
+
)
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
@jsii.data_type(
|
|
245
|
+
jsii_type="@aws-solutions-constructs/aws-constructs-factories.S3BucketFactoryResponse",
|
|
246
|
+
jsii_struct_bases=[],
|
|
247
|
+
name_mapping={"s3_bucket": "s3Bucket", "s3_logging_bucket": "s3LoggingBucket"},
|
|
248
|
+
)
|
|
249
|
+
class S3BucketFactoryResponse:
|
|
250
|
+
def __init__(
|
|
251
|
+
self,
|
|
252
|
+
*,
|
|
253
|
+
s3_bucket: _aws_cdk_aws_s3_ceddda9d.Bucket,
|
|
254
|
+
s3_logging_bucket: typing.Optional[_aws_cdk_aws_s3_ceddda9d.Bucket] = None,
|
|
255
|
+
) -> None:
|
|
256
|
+
'''
|
|
257
|
+
:param s3_bucket: -
|
|
258
|
+
:param s3_logging_bucket: -
|
|
259
|
+
'''
|
|
260
|
+
if __debug__:
|
|
261
|
+
type_hints = typing.get_type_hints(_typecheckingstub__73e83545e4e90253a16e42d104a9338e2ce2020b20c95b614ea013e7c4918073)
|
|
262
|
+
check_type(argname="argument s3_bucket", value=s3_bucket, expected_type=type_hints["s3_bucket"])
|
|
263
|
+
check_type(argname="argument s3_logging_bucket", value=s3_logging_bucket, expected_type=type_hints["s3_logging_bucket"])
|
|
264
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
265
|
+
"s3_bucket": s3_bucket,
|
|
266
|
+
}
|
|
267
|
+
if s3_logging_bucket is not None:
|
|
268
|
+
self._values["s3_logging_bucket"] = s3_logging_bucket
|
|
269
|
+
|
|
270
|
+
@builtins.property
|
|
271
|
+
def s3_bucket(self) -> _aws_cdk_aws_s3_ceddda9d.Bucket:
|
|
272
|
+
result = self._values.get("s3_bucket")
|
|
273
|
+
assert result is not None, "Required property 's3_bucket' is missing"
|
|
274
|
+
return typing.cast(_aws_cdk_aws_s3_ceddda9d.Bucket, result)
|
|
275
|
+
|
|
276
|
+
@builtins.property
|
|
277
|
+
def s3_logging_bucket(self) -> typing.Optional[_aws_cdk_aws_s3_ceddda9d.Bucket]:
|
|
278
|
+
result = self._values.get("s3_logging_bucket")
|
|
279
|
+
return typing.cast(typing.Optional[_aws_cdk_aws_s3_ceddda9d.Bucket], result)
|
|
280
|
+
|
|
281
|
+
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
282
|
+
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
283
|
+
|
|
284
|
+
def __ne__(self, rhs: typing.Any) -> builtins.bool:
|
|
285
|
+
return not (rhs == self)
|
|
286
|
+
|
|
287
|
+
def __repr__(self) -> str:
|
|
288
|
+
return "S3BucketFactoryResponse(%s)" % ", ".join(
|
|
289
|
+
k + "=" + repr(v) for k, v in self._values.items()
|
|
290
|
+
)
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
__all__ = [
|
|
294
|
+
"ConstructsFactories",
|
|
295
|
+
"S3BucketFactoryProps",
|
|
296
|
+
"S3BucketFactoryResponse",
|
|
297
|
+
]
|
|
298
|
+
|
|
299
|
+
publication.publish()
|
|
300
|
+
|
|
301
|
+
def _typecheckingstub__605983066d245d838df0751ca3d83223b93e3dac7281a9b7677ff8c39ccd96d4(
|
|
302
|
+
scope: _constructs_77d1e7e8.Construct,
|
|
303
|
+
id: builtins.str,
|
|
304
|
+
) -> None:
|
|
305
|
+
"""Type checking stubs"""
|
|
306
|
+
pass
|
|
307
|
+
|
|
308
|
+
def _typecheckingstub__25b90bfb94c5304484be85483634a7064b119ae1b0c5ed7cfc594e3e7bbf37f0(
|
|
309
|
+
id: builtins.str,
|
|
310
|
+
*,
|
|
311
|
+
bucket_props: typing.Any = None,
|
|
312
|
+
logging_bucket_props: typing.Optional[typing.Union[_aws_cdk_aws_s3_ceddda9d.BucketProps, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
313
|
+
log_s3_access_logs: typing.Optional[builtins.bool] = None,
|
|
314
|
+
) -> None:
|
|
315
|
+
"""Type checking stubs"""
|
|
316
|
+
pass
|
|
317
|
+
|
|
318
|
+
def _typecheckingstub__45a251aca0d0848bcaeaed9669ce040e9bd9f304c875a3796313bd27abcdacc3(
|
|
319
|
+
*,
|
|
320
|
+
bucket_props: typing.Any = None,
|
|
321
|
+
logging_bucket_props: typing.Optional[typing.Union[_aws_cdk_aws_s3_ceddda9d.BucketProps, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
322
|
+
log_s3_access_logs: typing.Optional[builtins.bool] = None,
|
|
323
|
+
) -> None:
|
|
324
|
+
"""Type checking stubs"""
|
|
325
|
+
pass
|
|
326
|
+
|
|
327
|
+
def _typecheckingstub__73e83545e4e90253a16e42d104a9338e2ce2020b20c95b614ea013e7c4918073(
|
|
328
|
+
*,
|
|
329
|
+
s3_bucket: _aws_cdk_aws_s3_ceddda9d.Bucket,
|
|
330
|
+
s3_logging_bucket: typing.Optional[_aws_cdk_aws_s3_ceddda9d.Bucket] = None,
|
|
331
|
+
) -> None:
|
|
332
|
+
"""Type checking stubs"""
|
|
333
|
+
pass
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
from pkgutil import extend_path
|
|
2
|
+
__path__ = extend_path(__path__, __name__)
|
|
3
|
+
|
|
4
|
+
import abc
|
|
5
|
+
import builtins
|
|
6
|
+
import datetime
|
|
7
|
+
import enum
|
|
8
|
+
import typing
|
|
9
|
+
|
|
10
|
+
import jsii
|
|
11
|
+
import publication
|
|
12
|
+
import typing_extensions
|
|
13
|
+
|
|
14
|
+
from typeguard import check_type
|
|
15
|
+
|
|
16
|
+
import aws_cdk._jsii
|
|
17
|
+
import aws_cdk.integ_tests_alpha._jsii
|
|
18
|
+
import aws_solutions_constructs.core._jsii
|
|
19
|
+
import constructs._jsii
|
|
20
|
+
|
|
21
|
+
__jsii_assembly__ = jsii.JSIIAssembly.load(
|
|
22
|
+
"@aws-solutions-constructs/aws-constructs-factories",
|
|
23
|
+
"2.56.0",
|
|
24
|
+
__name__[0:-6],
|
|
25
|
+
"aws-constructs-factories@2.56.0.jsii.tgz",
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
__all__ = [
|
|
29
|
+
"__jsii_assembly__",
|
|
30
|
+
]
|
|
31
|
+
|
|
32
|
+
publication.publish()
|
|
Binary file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: aws-solutions-constructs.aws-constructs-factories
|
|
3
|
+
Version: 2.56.0
|
|
4
|
+
Summary: Factories to allow creation of individual resources
|
|
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.8
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Typing :: Typed
|
|
18
|
+
Classifier: License :: OSI Approved
|
|
19
|
+
Requires-Python: ~=3.8
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
License-File: LICENSE
|
|
22
|
+
|
|
23
|
+
# aws-constructs-factories module
|
|
24
|
+
|
|
25
|
+
<!--BEGIN STABILITY BANNER-->---
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+

|
|
29
|
+
|
|
30
|
+
> All classes are under active development and subject to non-backward compatible changes or removal in any
|
|
31
|
+
> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
|
|
32
|
+
> 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.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
<!--END STABILITY BANNER-->
|
|
36
|
+
|
|
37
|
+
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|
|
38
|
+
|:-------------|:-------------|
|
|
39
|
+
|
|
40
|
+
<div style="height:8px"></div>
|
|
41
|
+
|
|
42
|
+
| **Language** | **Package** |
|
|
43
|
+
|:-------------|-----------------|
|
|
44
|
+
| Python|`aws_solutions_constructs.aws_constructs_factories`|
|
|
45
|
+
| Typescript|`@aws-solutions-constructs/aws-constructs-factories`|
|
|
46
|
+
| Java|`software.amazon.awsconstructs.services.constructsfactories`|
|
|
47
|
+
|
|
48
|
+
## Overview
|
|
49
|
+
|
|
50
|
+
This AWS Solutions Construct exposes the same code used to create our underlying resources as factories, so clients can create individual resources that are well-architected.
|
|
51
|
+
|
|
52
|
+
### S3 Buckets
|
|
53
|
+
|
|
54
|
+
Create fully well-architected S3 buckets with as little as one function call. Here is a minimal deployable pattern definition:
|
|
55
|
+
|
|
56
|
+
Typescript
|
|
57
|
+
|
|
58
|
+
```python
|
|
59
|
+
import { Construct } from 'constructs';
|
|
60
|
+
import { Stack, StackProps } from 'aws-cdk-lib';
|
|
61
|
+
import { ConstructsFactories } from '@aws-solutions-constructs/aws-constructs-factories';
|
|
62
|
+
|
|
63
|
+
const factories = new ConstructsFactories(this, 'integ-test');
|
|
64
|
+
|
|
65
|
+
factories.s3BucketFactory('test', {});
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Python
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
# TBD
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Java
|
|
75
|
+
|
|
76
|
+
```java
|
|
77
|
+
// TBD
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## S3BucketFactory Function Signature
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
s3BucketFactory(id: string, props: S3BucketFactoryProps): S3BucketFactoryResponse
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## S3BucketFactoryProps
|
|
87
|
+
|
|
88
|
+
| **Name** | **Type** | **Description** |
|
|
89
|
+
|:-------------|:----------------|-----------------|
|
|
90
|
+
|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.|
|
|
91
|
+
|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|
|
|
92
|
+
|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.|
|
|
93
|
+
|
|
94
|
+
## S3BucketFactoryResponse
|
|
95
|
+
|
|
96
|
+
| **Name** | **Type** | **Description** |
|
|
97
|
+
|:-------------|:----------------|-----------------|
|
|
98
|
+
|s3Bucket|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the factory. |
|
|
99
|
+
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3.Bucket.html)|The s3.Bucket created by the construct as the logging bucket for the primary bucket. If the logS3AccessLogs property is false, this value will be undefined.|
|
|
100
|
+
|
|
101
|
+
## Default settings
|
|
102
|
+
|
|
103
|
+
Out of the box implementation of the Construct without any override will set the following defaults:
|
|
104
|
+
|
|
105
|
+
* An S3 Content Bucket
|
|
106
|
+
|
|
107
|
+
* AWS managed Server Side Encryption (AES256)
|
|
108
|
+
* Lifecycle rule to transition objects to Glacier storage class in 90 days
|
|
109
|
+
* Access Logging enabled
|
|
110
|
+
* All Public access blocked
|
|
111
|
+
* Versioning enabled
|
|
112
|
+
* UpdateReplacePolicy is delete
|
|
113
|
+
* Deletion policy is delete
|
|
114
|
+
* Bucket policy requiring SecureTransport
|
|
115
|
+
* An S3 Bucket for Access Logs
|
|
116
|
+
|
|
117
|
+
* AWS managed Server Side Encryption (AES256)
|
|
118
|
+
* All public access blocked
|
|
119
|
+
* Versioning enabled
|
|
120
|
+
* UpdateReplacePolicy is delete
|
|
121
|
+
* Deletion policy is delete
|
|
122
|
+
* Bucket policy requiring SecureTransport
|
|
123
|
+
* Bucket policy granting PutObject privileges to the S3 logging service, from the content bucket in the content bucket account.
|
|
124
|
+
* cfn_nag suppression of access logging finding (not logging access to the access log bucket)
|
|
125
|
+
|
|
126
|
+
## Architecture
|
|
127
|
+
|
|
128
|
+

|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
MANIFEST.in
|
|
3
|
+
README.md
|
|
4
|
+
pyproject.toml
|
|
5
|
+
setup.py
|
|
6
|
+
src/aws_solutions_constructs.aws_constructs_factories.egg-info/PKG-INFO
|
|
7
|
+
src/aws_solutions_constructs.aws_constructs_factories.egg-info/SOURCES.txt
|
|
8
|
+
src/aws_solutions_constructs.aws_constructs_factories.egg-info/dependency_links.txt
|
|
9
|
+
src/aws_solutions_constructs.aws_constructs_factories.egg-info/requires.txt
|
|
10
|
+
src/aws_solutions_constructs.aws_constructs_factories.egg-info/top_level.txt
|
|
11
|
+
src/aws_solutions_constructs/aws_constructs_factories/__init__.py
|
|
12
|
+
src/aws_solutions_constructs/aws_constructs_factories/py.typed
|
|
13
|
+
src/aws_solutions_constructs/aws_constructs_factories/_jsii/__init__.py
|
|
14
|
+
src/aws_solutions_constructs/aws_constructs_factories/_jsii/aws-constructs-factories@2.56.0.jsii.tgz
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
aws_solutions_constructs
|