appmod-catalog-blueprints 1.1.0__tar.gz → 1.2.1__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. appmod_catalog_blueprints-1.2.1/PKG-INFO +191 -0
  2. appmod_catalog_blueprints-1.2.1/README.md +163 -0
  3. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/setup.py +2 -2
  4. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints/__init__.py +101 -168
  5. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints/_jsii/__init__.py +2 -2
  6. appmod_catalog_blueprints-1.2.1/src/appmod_catalog_blueprints/_jsii/cdk-appmod-catalog-blueprints@1.2.1.jsii.tgz +0 -0
  7. appmod_catalog_blueprints-1.2.1/src/appmod_catalog_blueprints.egg-info/PKG-INFO +191 -0
  8. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints.egg-info/SOURCES.txt +1 -1
  9. appmod_catalog_blueprints-1.1.0/PKG-INFO +0 -258
  10. appmod_catalog_blueprints-1.1.0/README.md +0 -230
  11. appmod_catalog_blueprints-1.1.0/src/appmod_catalog_blueprints/_jsii/cdk-appmod-catalog-blueprints@1.1.0.jsii.tgz +0 -0
  12. appmod_catalog_blueprints-1.1.0/src/appmod_catalog_blueprints.egg-info/PKG-INFO +0 -258
  13. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/LICENSE +0 -0
  14. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/MANIFEST.in +0 -0
  15. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/pyproject.toml +0 -0
  16. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/setup.cfg +0 -0
  17. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints/py.typed +0 -0
  18. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints.egg-info/dependency_links.txt +0 -0
  19. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints.egg-info/requires.txt +0 -0
  20. {appmod_catalog_blueprints-1.1.0 → appmod_catalog_blueprints-1.2.1}/src/appmod_catalog_blueprints.egg-info/top_level.txt +0 -0
@@ -0,0 +1,191 @@
1
+ Metadata-Version: 2.1
2
+ Name: appmod-catalog-blueprints
3
+ Version: 1.2.1
4
+ Summary: Serverless infrastructure components organized by business use cases
5
+ Home-page: https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
6
+ Author: Amazon Web Services<aws-cdk-dev@amazon.com>
7
+ License: Apache-2.0
8
+ Project-URL: Source, https://github.com/cdklabs/cdk-appmod-catalog-blueprints.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: Development Status :: 4 - Beta
18
+ Classifier: License :: OSI Approved
19
+ Requires-Python: ~=3.9
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.218.0
23
+ Requires-Dist: aws-cdk.aws-lambda-python-alpha<3.0.0,>=2.218.0.a0
24
+ Requires-Dist: constructs<11.0.0,>=10.0.5
25
+ Requires-Dist: jsii<2.0.0,>=1.115.0
26
+ Requires-Dist: publication>=0.0.3
27
+ Requires-Dist: typeguard<4.3.0,>=2.13.3
28
+
29
+ ---
30
+
31
+
32
+ ## title: Introduction
33
+
34
+ # AppMod Catalog Blueprints
35
+
36
+ Application Modernization (AppMod) Catalog Blueprints is a comprehensive library of production-ready, use case-driven infrastructure blueprints in the form of composable multi-layered building blocks built using [AWS Cloud Development Kit](https://aws.amazon.com/cdk/) (CDK) [L3 constructs](https://docs.aws.amazon.com/cdk/v2/guide/constructs.html). These blueprints offer use case-driven solutions with multiple implementation pathways and industry-specific implementations that are designed to accelerate serverless development and modernization on AWS.
37
+
38
+ Built with [JSII](https://aws.github.io/jsii/), these constructs are available in TypeScript, Python, Java, and .NET, enabling teams to use their preferred programming language while leveraging the same proven infrastructure patterns.
39
+
40
+ Get started by exploring the [use case constructs](use-cases) and deployable [examples](examples). Learn more from [documentation](https://cdklabs.github.io/cdk-appmod-catalog-blueprints/) and [Construct Hub](https://constructs.dev/packages/@cdklabs/cdk-appmod-catalog-blueprints).
41
+
42
+ ## Core Use Cases
43
+
44
+ | Use Case | Description | Quick Deploy Examples |
45
+ |----------|-------------|----------------------|
46
+ | **[Document Processing](./use-cases/document-processing/)** | AI-powered document processing workflows with classification, extraction, and agentic capabilities | • [Bedrock Document Processing](./examples/document-processing/bedrock-document-processing/)<br/>• [Agentic Document Processing](./examples/document-processing/agentic-document-processing/)<br/>• [Full-Stack Insurance Claims Processing Web Application](./examples/document-processing/doc-processing-fullstack-webapp/) |
47
+ | **[Web Application](./use-cases/webapp/)** | Static web application hosting with global CDN, security headers, and SPA support | • [Full-Stack Insurance Claims Processing Web Application](./examples/document-processing/doc-processing-fullstack-webapp/) |
48
+
49
+ ## Foundation and Utilities
50
+
51
+ | Component | Description |
52
+ |-----------|-------------|
53
+ | **[Observability & Monitoring](./use-cases/utilities/observability/)** | Comprehensive monitoring, logging, and alerting with automatic property injection and Lambda Powertools integration |
54
+ | **[Data Masking](./use-cases/utilities/lambda_layers/data-masking/)** | Lambda layer for data masking and PII protection in serverless applications |
55
+ | **[Infrastructure Foundation](./use-cases/framework/)** | Core infrastructure components and utilities for building scalable applications |
56
+
57
+ ## Key Design Principles
58
+
59
+ AppMod Catalog Blueprints is built on Object-Oriented Programming (OOP) principles, providing a structured approach to infrastructure development through core design concepts:
60
+
61
+ ### Composable Architecture
62
+
63
+ Build complex enterprise systems by combining independent, reusable components with standardized interfaces.
64
+
65
+ * **Independent components** with clear interfaces and loose coupling for maximum flexibility
66
+ * **Mix and match building blocks** to create custom solutions across different contexts and use cases
67
+ * **Scalable composition** that maintains consistency while enabling incremental adoption and gradual modernization
68
+
69
+ ### Multi-Layered Building Blocks Architecture
70
+
71
+ Our blueprints use a multi-layered architecture that bridges the gap between business requirements and technical implementation:
72
+
73
+ | Layer | Implementation Type | Purpose | Key Features |
74
+ |-------|-------------------|---------|--------------|
75
+ | **Infrastructure Foundation** | Abstract base classes | Shared infrastructure components and common services | • Standardized interfaces and contracts<br/>• Extensible foundation for custom implementations |
76
+ | **General Use Case Implementation** | Concrete implementation classes | Production-ready implementations for common patterns across industries | • Configurable parameters for different environments<br/>• Abstract method implementations with general-purpose solutions |
77
+ | **Industry-Aligned Implementation** | Configured implementation examples | Pre-configured solutions for specific business domains | • Industry-specific validation rules and workflows<br/>• Built-in compliance requirements and domain expertise |
78
+
79
+ ### Production-Ready with Smart Defaults
80
+
81
+ AppMod Catalog Blueprints serves both **rapid deployment** needs (for teams wanting immediate solutions) and **custom development** requirements (for teams needing tailored implementations), providing flexibility without compromising on production readiness.
82
+
83
+ | Approach | Best For | Capabilities |
84
+ |----------|----------|--------------|
85
+ | **Out-of-the-Box Deployment** | Rapid deployment and evaluation | • Deploy complete solutions in minutes using examples for immediate value<br/>• Pre-configured security, monitoring, and best practices for production readiness<br/>• Sensible defaults with production-ready configurations that work immediately<br/>• No infrastructure boilerplate required with minimal learning curve |
86
+ | **Intelligent Customization** | Custom development and integration | • Override defaults to modify behavior without changing core implementation<br/>• Enable/disable optional features to meet specific requirements<br/>• Inject custom logic at predefined extension points while maintaining production readiness<br/>• Configure parameters for different environments and use cases |
87
+
88
+ ### Security & Compliance
89
+
90
+ All components include enterprise-grade security by default:
91
+
92
+ * **CDK Nag Integration**: Automated security compliance checking
93
+ * **AWS Well-Architected**: Security, reliability, and performance best practices
94
+ * **Encryption & IAM**: At-rest/in-transit encryption with least-privilege access
95
+ * **Compliance Reports**: Generate reports with `npm test -- --testPathPattern="nag.test.ts"`
96
+
97
+ ## Essential Commands
98
+
99
+ ### Environment Setup
100
+
101
+ ```bash
102
+ # Clone the repository
103
+ git clone https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
104
+
105
+ # Configure AWS credentials and region
106
+ aws configure
107
+ # OR set AWS profile: export AWS_PROFILE=your-profile-name
108
+
109
+ # Bootstrap your AWS environment (one-time setup)
110
+ npx cdk bootstrap
111
+ ```
112
+
113
+ ### Quick Start
114
+
115
+ Deploy a working example in **5 minutes**:
116
+
117
+ ```bash
118
+ # Navigate to any example and deploy
119
+ cd examples/document-processing/agentic-document-processing
120
+ npm install
121
+ npm run deploy
122
+ ```
123
+
124
+ ### Build & Deploy Project
125
+
126
+ ```bash
127
+ # Build entire project
128
+ npx projen build
129
+
130
+ # Deploy with specific profile/region
131
+ npx cdk deploy --require-approval never
132
+
133
+ # Update CDK CLI if needed
134
+ npm install aws-cdk@latest
135
+ ```
136
+
137
+ ### Development
138
+
139
+ ```bash
140
+ # Run all tests
141
+ npm test
142
+
143
+ # Run specific test pattern
144
+ npm test -- --testPathPattern="document-processing"
145
+
146
+ # Generate CDK Nag compliance reports
147
+ npm test -- --testPathPattern="nag.test.ts"
148
+ ```
149
+
150
+ ## How to Use This Library
151
+
152
+ ### Quick Start (Deploy Examples)
153
+
154
+ 1. **Browse Examples**: Start with the [examples](./examples/) folder to see working implementations
155
+ 2. **Deploy & Test**: Use `npm run deploy` in any example to get a working system in minutes
156
+ 3. **Customize**: Modify example parameters to fit your specific requirements
157
+
158
+ ### Using Individual Constructs
159
+
160
+ 1. **Import Constructs**: Add `@cdklabs/appmod-catalog-blueprints` to your CDK project
161
+ 2. **Choose Your Layer**: Pick the right abstraction level for your needs
162
+ 3. **Configure**: Use the configuration options documented in each construct
163
+
164
+ ### Understanding the Layers
165
+
166
+ **Foundation Layer** (`use-cases/framework/`, `use-cases/utilities/`)
167
+
168
+ * **When to use**: Building custom solutions or need specific infrastructure components
169
+ * **Components**: VPC networking, observability utilities, data management tools, etc.
170
+
171
+ **Use Case Layer** (`use-cases/document-processing/`, `use-cases/webapp/`)
172
+
173
+ * **When to use**: Need proven patterns for common business problems
174
+ * **Components**: Document processing workflows, web application hosting, data transformation patterns, etc.
175
+
176
+ **Example Layer** (`examples/`)
177
+
178
+ * **When to use**: Want complete, deployable solutions
179
+ * **Components**: Industry-specific configurations, end-to-end applications, reference implementations, etc.
180
+
181
+ ## Contributing
182
+
183
+ See [CONTRIBUTING.md](https://github.com/cdklabs/cdk-appmod-catalog-blueprints/blob/main/CONTRIBUTING.md) for detailed guidelines on how to contribute to this project.
184
+
185
+ ## Disclaimer
186
+
187
+ These application solutions are not supported products in their own right, but examples to help our customers use our products from their applications. As our customer, any applications you integrate these examples in should be thoroughly tested, secured, and optimized according to your business's security standards before deploying to production or handling production workloads.
188
+
189
+ ## License
190
+
191
+ Apache License 2.0 - see [LICENSE](https://github.com/cdklabs/cdk-appmod-catalog-blueprints/blob/main/LICENSE) file for details.
@@ -0,0 +1,163 @@
1
+ ---
2
+
3
+
4
+ ## title: Introduction
5
+
6
+ # AppMod Catalog Blueprints
7
+
8
+ Application Modernization (AppMod) Catalog Blueprints is a comprehensive library of production-ready, use case-driven infrastructure blueprints in the form of composable multi-layered building blocks built using [AWS Cloud Development Kit](https://aws.amazon.com/cdk/) (CDK) [L3 constructs](https://docs.aws.amazon.com/cdk/v2/guide/constructs.html). These blueprints offer use case-driven solutions with multiple implementation pathways and industry-specific implementations that are designed to accelerate serverless development and modernization on AWS.
9
+
10
+ Built with [JSII](https://aws.github.io/jsii/), these constructs are available in TypeScript, Python, Java, and .NET, enabling teams to use their preferred programming language while leveraging the same proven infrastructure patterns.
11
+
12
+ Get started by exploring the [use case constructs](use-cases) and deployable [examples](examples). Learn more from [documentation](https://cdklabs.github.io/cdk-appmod-catalog-blueprints/) and [Construct Hub](https://constructs.dev/packages/@cdklabs/cdk-appmod-catalog-blueprints).
13
+
14
+ ## Core Use Cases
15
+
16
+ | Use Case | Description | Quick Deploy Examples |
17
+ |----------|-------------|----------------------|
18
+ | **[Document Processing](./use-cases/document-processing/)** | AI-powered document processing workflows with classification, extraction, and agentic capabilities | • [Bedrock Document Processing](./examples/document-processing/bedrock-document-processing/)<br/>• [Agentic Document Processing](./examples/document-processing/agentic-document-processing/)<br/>• [Full-Stack Insurance Claims Processing Web Application](./examples/document-processing/doc-processing-fullstack-webapp/) |
19
+ | **[Web Application](./use-cases/webapp/)** | Static web application hosting with global CDN, security headers, and SPA support | • [Full-Stack Insurance Claims Processing Web Application](./examples/document-processing/doc-processing-fullstack-webapp/) |
20
+
21
+ ## Foundation and Utilities
22
+
23
+ | Component | Description |
24
+ |-----------|-------------|
25
+ | **[Observability & Monitoring](./use-cases/utilities/observability/)** | Comprehensive monitoring, logging, and alerting with automatic property injection and Lambda Powertools integration |
26
+ | **[Data Masking](./use-cases/utilities/lambda_layers/data-masking/)** | Lambda layer for data masking and PII protection in serverless applications |
27
+ | **[Infrastructure Foundation](./use-cases/framework/)** | Core infrastructure components and utilities for building scalable applications |
28
+
29
+ ## Key Design Principles
30
+
31
+ AppMod Catalog Blueprints is built on Object-Oriented Programming (OOP) principles, providing a structured approach to infrastructure development through core design concepts:
32
+
33
+ ### Composable Architecture
34
+
35
+ Build complex enterprise systems by combining independent, reusable components with standardized interfaces.
36
+
37
+ * **Independent components** with clear interfaces and loose coupling for maximum flexibility
38
+ * **Mix and match building blocks** to create custom solutions across different contexts and use cases
39
+ * **Scalable composition** that maintains consistency while enabling incremental adoption and gradual modernization
40
+
41
+ ### Multi-Layered Building Blocks Architecture
42
+
43
+ Our blueprints use a multi-layered architecture that bridges the gap between business requirements and technical implementation:
44
+
45
+ | Layer | Implementation Type | Purpose | Key Features |
46
+ |-------|-------------------|---------|--------------|
47
+ | **Infrastructure Foundation** | Abstract base classes | Shared infrastructure components and common services | • Standardized interfaces and contracts<br/>• Extensible foundation for custom implementations |
48
+ | **General Use Case Implementation** | Concrete implementation classes | Production-ready implementations for common patterns across industries | • Configurable parameters for different environments<br/>• Abstract method implementations with general-purpose solutions |
49
+ | **Industry-Aligned Implementation** | Configured implementation examples | Pre-configured solutions for specific business domains | • Industry-specific validation rules and workflows<br/>• Built-in compliance requirements and domain expertise |
50
+
51
+ ### Production-Ready with Smart Defaults
52
+
53
+ AppMod Catalog Blueprints serves both **rapid deployment** needs (for teams wanting immediate solutions) and **custom development** requirements (for teams needing tailored implementations), providing flexibility without compromising on production readiness.
54
+
55
+ | Approach | Best For | Capabilities |
56
+ |----------|----------|--------------|
57
+ | **Out-of-the-Box Deployment** | Rapid deployment and evaluation | • Deploy complete solutions in minutes using examples for immediate value<br/>• Pre-configured security, monitoring, and best practices for production readiness<br/>• Sensible defaults with production-ready configurations that work immediately<br/>• No infrastructure boilerplate required with minimal learning curve |
58
+ | **Intelligent Customization** | Custom development and integration | • Override defaults to modify behavior without changing core implementation<br/>• Enable/disable optional features to meet specific requirements<br/>• Inject custom logic at predefined extension points while maintaining production readiness<br/>• Configure parameters for different environments and use cases |
59
+
60
+ ### Security & Compliance
61
+
62
+ All components include enterprise-grade security by default:
63
+
64
+ * **CDK Nag Integration**: Automated security compliance checking
65
+ * **AWS Well-Architected**: Security, reliability, and performance best practices
66
+ * **Encryption & IAM**: At-rest/in-transit encryption with least-privilege access
67
+ * **Compliance Reports**: Generate reports with `npm test -- --testPathPattern="nag.test.ts"`
68
+
69
+ ## Essential Commands
70
+
71
+ ### Environment Setup
72
+
73
+ ```bash
74
+ # Clone the repository
75
+ git clone https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
76
+
77
+ # Configure AWS credentials and region
78
+ aws configure
79
+ # OR set AWS profile: export AWS_PROFILE=your-profile-name
80
+
81
+ # Bootstrap your AWS environment (one-time setup)
82
+ npx cdk bootstrap
83
+ ```
84
+
85
+ ### Quick Start
86
+
87
+ Deploy a working example in **5 minutes**:
88
+
89
+ ```bash
90
+ # Navigate to any example and deploy
91
+ cd examples/document-processing/agentic-document-processing
92
+ npm install
93
+ npm run deploy
94
+ ```
95
+
96
+ ### Build & Deploy Project
97
+
98
+ ```bash
99
+ # Build entire project
100
+ npx projen build
101
+
102
+ # Deploy with specific profile/region
103
+ npx cdk deploy --require-approval never
104
+
105
+ # Update CDK CLI if needed
106
+ npm install aws-cdk@latest
107
+ ```
108
+
109
+ ### Development
110
+
111
+ ```bash
112
+ # Run all tests
113
+ npm test
114
+
115
+ # Run specific test pattern
116
+ npm test -- --testPathPattern="document-processing"
117
+
118
+ # Generate CDK Nag compliance reports
119
+ npm test -- --testPathPattern="nag.test.ts"
120
+ ```
121
+
122
+ ## How to Use This Library
123
+
124
+ ### Quick Start (Deploy Examples)
125
+
126
+ 1. **Browse Examples**: Start with the [examples](./examples/) folder to see working implementations
127
+ 2. **Deploy & Test**: Use `npm run deploy` in any example to get a working system in minutes
128
+ 3. **Customize**: Modify example parameters to fit your specific requirements
129
+
130
+ ### Using Individual Constructs
131
+
132
+ 1. **Import Constructs**: Add `@cdklabs/appmod-catalog-blueprints` to your CDK project
133
+ 2. **Choose Your Layer**: Pick the right abstraction level for your needs
134
+ 3. **Configure**: Use the configuration options documented in each construct
135
+
136
+ ### Understanding the Layers
137
+
138
+ **Foundation Layer** (`use-cases/framework/`, `use-cases/utilities/`)
139
+
140
+ * **When to use**: Building custom solutions or need specific infrastructure components
141
+ * **Components**: VPC networking, observability utilities, data management tools, etc.
142
+
143
+ **Use Case Layer** (`use-cases/document-processing/`, `use-cases/webapp/`)
144
+
145
+ * **When to use**: Need proven patterns for common business problems
146
+ * **Components**: Document processing workflows, web application hosting, data transformation patterns, etc.
147
+
148
+ **Example Layer** (`examples/`)
149
+
150
+ * **When to use**: Want complete, deployable solutions
151
+ * **Components**: Industry-specific configurations, end-to-end applications, reference implementations, etc.
152
+
153
+ ## Contributing
154
+
155
+ See [CONTRIBUTING.md](https://github.com/cdklabs/cdk-appmod-catalog-blueprints/blob/main/CONTRIBUTING.md) for detailed guidelines on how to contribute to this project.
156
+
157
+ ## Disclaimer
158
+
159
+ These application solutions are not supported products in their own right, but examples to help our customers use our products from their applications. As our customer, any applications you integrate these examples in should be thoroughly tested, secured, and optimized according to your business's security standards before deploying to production or handling production workloads.
160
+
161
+ ## License
162
+
163
+ Apache License 2.0 - see [LICENSE](https://github.com/cdklabs/cdk-appmod-catalog-blueprints/blob/main/LICENSE) file for details.
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "appmod-catalog-blueprints",
8
- "version": "1.1.0",
8
+ "version": "1.2.1",
9
9
  "description": "Serverless infrastructure components organized by business use cases",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "appmod_catalog_blueprints._jsii": [
29
- "cdk-appmod-catalog-blueprints@1.1.0.jsii.tgz"
29
+ "cdk-appmod-catalog-blueprints@1.2.1.jsii.tgz"
30
30
  ],
31
31
  "appmod_catalog_blueprints": [
32
32
  "py.typed"