appmod-catalog-blueprints 1.3.0__py3-none-any.whl → 1.4.0__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.
@@ -1,80 +1,52 @@
1
1
  r'''
2
- ---
2
+ # AppMod Catalog Blueprints
3
3
 
4
+ [![Code](https://img.shields.io/badge/code-GitHub-green)](https://github.com/cdklabs/cdk-appmod-catalog-blueprints)
5
+ [![Website](https://img.shields.io/badge/website-cdklabs.github.io-blue)](https://cdklabs.github.io/cdk-appmod-catalog-blueprints/)
6
+ [![Package](https://img.shields.io/badge/package-construct--hub-orange)](https://constructs.dev/packages/@cdklabs/cdk-appmod-catalog-blueprints/)
4
7
 
5
- ## title: Introduction
8
+ Application Modernization (AppMod) Catalog Blueprints is a comprehensive library of use case-driven infrastructure solution blueprints built using AWS well-architected best practices. Designed as composable multi-layered building blocks 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 to accelerate serverless development and modernization on AWS.
6
9
 
7
- # AppMod Catalog Blueprints
10
+ **Key Benefits:**
8
11
 
9
- 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.
12
+ * **Use case-driven solutions**: Purpose-built blueprints for common business scenarios like document processing, web applications, and AI workflows, with industry-specific implementations like insurance claims processing
13
+ * **Multi-layered approach**: Infrastructure Foundation → General Use Cases → Industry Examples, allowing you to start with proven patterns and customize as needed.
14
+ * **Composable architecture**: Mix and match independent components with standardized interfaces
15
+ * **Enterprise-ready**: Built-in security, compliance, and AWS Well-Architected best practices
16
+ * **Multi-language support**: Available in TypeScript, Python, Java, and .NET via [JSII](https://aws.github.io/jsii/)
10
17
 
11
- 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.
18
+ ## How to Use This Library
12
19
 
13
20
  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).
14
21
 
15
- ## Core Use Cases
22
+ | Approach | Best For | Get Started |
23
+ |----------|----------|-------------|
24
+ | **🚀 Rapid Deployment** | Quick evaluation, immediate solutions, proof-of-concepts | Use [examples](./examples/) - deploy complete solutions in minutes with sensible defaults and AWS Well-Architected best practices |
25
+ | **🔧 Custom Development** | Specific requirements, enterprise integration, tailored solutions | Use [individual constructs](./use-cases/) - override defaults, inject custom logic, configure for your environment |
26
+
27
+ ## Use Case Building Blocks
28
+
29
+ ### Core Use Cases
16
30
 
17
31
  | Use Case | Description | Quick Deploy Examples |
18
32
  |----------|-------------|----------------------|
19
- | **[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/) |
33
+ | **[Document Processing](./use-cases/document-processing/)** | Intelligent 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/) |
20
34
  | **[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/) |
21
35
 
22
- ## Foundation and Utilities
36
+ ### Foundation and Utilities
23
37
 
24
38
  | Component | Description |
25
39
  |-----------|-------------|
26
- | **[Observability & Monitoring](./use-cases/utilities/observability/)** | Comprehensive monitoring, logging, and alerting with automatic property injection and Lambda Powertools integration |
27
- | **[Data Masking](./use-cases/utilities/lambda_layers/data-masking/)** | Lambda layer for data masking and PII protection in serverless applications |
28
- | **[Infrastructure Foundation](./use-cases/framework/)** | Core infrastructure components and utilities for building scalable applications |
29
-
30
- ## Key Design Principles
31
-
32
- AppMod Catalog Blueprints is built on Object-Oriented Programming (OOP) principles, providing a structured approach to infrastructure development through core design concepts:
33
-
34
- ### Composable Architecture
35
-
36
- Build complex enterprise systems by combining independent, reusable components with standardized interfaces.
37
-
38
- * **Independent components** with clear interfaces and loose coupling for maximum flexibility
39
- * **Mix and match building blocks** to create custom solutions across different contexts and use cases
40
- * **Scalable composition** that maintains consistency while enabling incremental adoption and gradual modernization
41
-
42
- ### Multi-Layered Building Blocks Architecture
40
+ | **[Agentic AI Framework](./use-cases/framework/agents/)** | Composable enterprise framework for building intelligent AI agents that can be mixed and matched across diverse use cases - from document processing to conversational AI |
41
+ | **[Infrastructure Foundation](./use-cases/framework/foundation/)** | Core infrastructure components including VPC networking, access logging, and EventBridge integration |
42
+ | **[Observability & Monitoring](./use-cases/utilities/#observability)** | Comprehensive monitoring, logging, and alerting with automatic property injection and Lambda Powertools integration |
43
+ | **[Data Masking](./use-cases/utilities/#data-masking)** | Lambda layer for data masking and PII protection in serverless applications |
43
44
 
44
- Our blueprints use a multi-layered architecture that bridges the gap between business requirements and technical implementation:
45
-
46
- | Layer | Implementation Type | Purpose | Key Features |
47
- |-------|-------------------|---------|--------------|
48
- | **Infrastructure Foundation** | Abstract base classes | Shared infrastructure components and common services | • Standardized interfaces and contracts<br/>• Extensible foundation for custom implementations |
49
- | **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 |
50
- | **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 |
51
-
52
- ### Production-Ready with Smart Defaults
53
-
54
- 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.
55
-
56
- | Approach | Best For | Capabilities |
57
- |----------|----------|--------------|
58
- | **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 |
59
- | **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 |
60
-
61
- ### Security & Compliance
62
-
63
- All components include enterprise-grade security by default:
64
-
65
- * **CDK Nag Integration**: Automated security compliance checking
66
- * **AWS Well-Architected**: Security, reliability, and performance best practices
67
- * **Encryption & IAM**: At-rest/in-transit encryption with least-privilege access
68
- * **Compliance Reports**: Generate reports with `npm test -- --testPathPattern="nag.test.ts"`
69
-
70
- ## Essential Commands
45
+ ## Getting Started
71
46
 
72
47
  ### Environment Setup
73
48
 
74
49
  ```bash
75
- # Clone the repository
76
- git clone https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
77
-
78
50
  # Configure AWS credentials and region
79
51
  aws configure
80
52
  # OR set AWS profile: export AWS_PROFILE=your-profile-name
@@ -83,73 +55,74 @@ aws configure
83
55
  npx cdk bootstrap
84
56
  ```
85
57
 
86
- ### Quick Start
58
+ ### Quick Deploy (Complete Solutions)
87
59
 
88
- Deploy a working example in **5 minutes**:
60
+ Deploy working examples in minutes for immediate value:
89
61
 
90
62
  ```bash
91
- # Navigate to any example and deploy
92
- cd examples/document-processing/agentic-document-processing
93
- npm install
94
- npm run deploy
95
- ```
96
-
97
- ### Build & Deploy Project
98
-
99
- ```bash
100
- # Build entire project
101
- npx projen build
63
+ # Clone the repository
64
+ git clone https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
102
65
 
103
- # Deploy with specific profile/region
104
- npx cdk deploy --require-approval never
66
+ # Deploy complete insurance claims processing solution
67
+ cd examples/document-processing/doc-processing-fullstack-webapp
68
+ npm install && npm run deploy
69
+ # Full AI-powered solution with web interface deployed
105
70
 
106
- # Update CDK CLI if needed
107
- npm install aws-cdk@latest
71
+ # Or deploy basic document processing
72
+ cd examples/document-processing/bedrock-document-processing
73
+ npm install && npm run deploy
108
74
  ```
109
75
 
110
- ### Development
111
-
112
- ```bash
113
- # Run all tests
114
- npm test
76
+ ### Using Individual Constructs
115
77
 
116
- # Run specific test pattern
117
- npm test -- --testPathPattern="document-processing"
78
+ Add to your existing CDK projects for custom solutions:
118
79
 
119
- # Generate CDK Nag compliance reports
120
- npm test -- --testPathPattern="nag.test.ts"
80
+ ```bash
81
+ # Install the library
82
+ npm install @cdklabs/appmod-catalog-blueprints
83
+
84
+ # Use in your CDK code
85
+ import { AgenticDocumentProcessing, WebApp } from '@cdklabs/appmod-catalog-blueprints';
86
+
87
+ const docProcessor = new AgenticDocumentProcessing(this, 'Processor', {
88
+ agentDefinition: {
89
+ bedrockModel: { useCrossRegionInference: true },
90
+ systemPrompt: myPrompt,
91
+ tools: [myTools]
92
+ }
93
+ });
121
94
  ```
122
95
 
123
- ## How to Use This Library
124
-
125
- ### Quick Start (Deploy Examples)
96
+ ## Key Design Principles
126
97
 
127
- 1. **Browse Examples**: Start with the [examples](./examples/) folder to see working implementations
128
- 2. **Deploy & Test**: Use `npm run deploy` in any example to get a working system in minutes
129
- 3. **Customize**: Modify example parameters to fit your specific requirements
98
+ AppMod Catalog Blueprints is built on Object-Oriented Programming (OOP) principles, providing a structured approach to infrastructure development through core design concepts:
130
99
 
131
- ### Using Individual Constructs
100
+ ### Composable Architecture
132
101
 
133
- 1. **Import Constructs**: Add `@cdklabs/appmod-catalog-blueprints` to your CDK project
134
- 2. **Choose Your Layer**: Pick the right abstraction level for your needs
135
- 3. **Configure**: Use the configuration options documented in each construct
102
+ Build complex enterprise systems by combining independent, reusable components with standardized interfaces.
136
103
 
137
- ### Understanding the Layers
104
+ * **Independent components** with clear interfaces and loose coupling for maximum flexibility
105
+ * **Mix and match building blocks** to create custom solutions across different contexts and use cases
106
+ * **Scalable composition** that maintains consistency while enabling incremental adoption and gradual modernization
138
107
 
139
- **Foundation Layer** (`use-cases/framework/`, `use-cases/utilities/`)
108
+ ### Multi-Layered Building Blocks Architecture
140
109
 
141
- * **When to use**: Building custom solutions or need specific infrastructure components
142
- * **Components**: VPC networking, observability utilities, data management tools, etc.
110
+ Our blueprints use a multi-layered architecture that bridges the gap between business requirements and technical implementation:
143
111
 
144
- **Use Case Layer** (`use-cases/document-processing/`, `use-cases/webapp/`)
112
+ | Layer | Implementation Type | Purpose | Key Features |
113
+ |-------|-------------------|---------|--------------|
114
+ | **Infrastructure Foundation** | Abstract base classes | Shared infrastructure components and common services | • Standardized interfaces and contracts<br/>• Extensible foundation for custom implementations |
115
+ | **General Use Case Implementation** | Concrete implementation classes | Implementations for common patterns across industries | • Configurable parameters for different environments<br/>• Abstract method implementations with general-purpose solutions |
116
+ | **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 |
145
117
 
146
- * **When to use**: Need proven patterns for common business problems
147
- * **Components**: Document processing workflows, web application hosting, data transformation patterns, etc.
118
+ ### Security & Compliance
148
119
 
149
- **Example Layer** (`examples/`)
120
+ All components include enterprise-grade security by default:
150
121
 
151
- * **When to use**: Want complete, deployable solutions
152
- * **Components**: Industry-specific configurations, end-to-end applications, reference implementations, etc.
122
+ * **CDK Nag Integration**: Automated security compliance checking
123
+ * **AWS Well-Architected**: Security, reliability, and performance best practices
124
+ * **Encryption & IAM**: At-rest/in-transit encryption with least-privilege access
125
+ * **Compliance Reports**: Generate reports with `npm test -- --testPathPattern="nag.test.ts"`
153
126
 
154
127
  ## Contributing
155
128
 
@@ -34,9 +34,9 @@ import constructs._jsii
34
34
 
35
35
  __jsii_assembly__ = jsii.JSIIAssembly.load(
36
36
  "@cdklabs/cdk-appmod-catalog-blueprints",
37
- "1.3.0",
37
+ "1.4.0",
38
38
  __name__[0:-6],
39
- "cdk-appmod-catalog-blueprints@1.3.0.jsii.tgz",
39
+ "cdk-appmod-catalog-blueprints@1.4.0.jsii.tgz",
40
40
  )
41
41
 
42
42
  __all__ = [
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: appmod-catalog-blueprints
3
- Version: 1.3.0
3
+ Version: 1.4.0
4
4
  Summary: Serverless infrastructure components organized by business use cases
5
5
  Home-page: https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
6
6
  Author: Amazon Web Services<aws-cdk-dev@amazon.com>
@@ -22,86 +22,58 @@ License-File: LICENSE
22
22
  Requires-Dist: aws-cdk-lib <3.0.0,>=2.218.0
23
23
  Requires-Dist: aws-cdk.aws-lambda-python-alpha <3.0.0,>=2.218.0.a0
24
24
  Requires-Dist: constructs <11.0.0,>=10.0.5
25
- Requires-Dist: jsii <2.0.0,>=1.115.0
25
+ Requires-Dist: jsii <2.0.0,>=1.118.0
26
26
  Requires-Dist: publication >=0.0.3
27
27
  Requires-Dist: typeguard <4.3.0,>=2.13.3
28
28
 
29
- ---
29
+ # AppMod Catalog Blueprints
30
30
 
31
+ [![Code](https://img.shields.io/badge/code-GitHub-green)](https://github.com/cdklabs/cdk-appmod-catalog-blueprints)
32
+ [![Website](https://img.shields.io/badge/website-cdklabs.github.io-blue)](https://cdklabs.github.io/cdk-appmod-catalog-blueprints/)
33
+ [![Package](https://img.shields.io/badge/package-construct--hub-orange)](https://constructs.dev/packages/@cdklabs/cdk-appmod-catalog-blueprints/)
31
34
 
32
- ## title: Introduction
35
+ Application Modernization (AppMod) Catalog Blueprints is a comprehensive library of use case-driven infrastructure solution blueprints built using AWS well-architected best practices. Designed as composable multi-layered building blocks 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 to accelerate serverless development and modernization on AWS.
33
36
 
34
- # AppMod Catalog Blueprints
37
+ **Key Benefits:**
35
38
 
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.
39
+ * **Use case-driven solutions**: Purpose-built blueprints for common business scenarios like document processing, web applications, and AI workflows, with industry-specific implementations like insurance claims processing
40
+ * **Multi-layered approach**: Infrastructure Foundation → General Use Cases → Industry Examples, allowing you to start with proven patterns and customize as needed.
41
+ * **Composable architecture**: Mix and match independent components with standardized interfaces
42
+ * **Enterprise-ready**: Built-in security, compliance, and AWS Well-Architected best practices
43
+ * **Multi-language support**: Available in TypeScript, Python, Java, and .NET via [JSII](https://aws.github.io/jsii/)
37
44
 
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.
45
+ ## How to Use This Library
39
46
 
40
47
  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
48
 
42
- ## Core Use Cases
49
+ | Approach | Best For | Get Started |
50
+ |----------|----------|-------------|
51
+ | **🚀 Rapid Deployment** | Quick evaluation, immediate solutions, proof-of-concepts | Use [examples](./examples/) - deploy complete solutions in minutes with sensible defaults and AWS Well-Architected best practices |
52
+ | **🔧 Custom Development** | Specific requirements, enterprise integration, tailored solutions | Use [individual constructs](./use-cases/) - override defaults, inject custom logic, configure for your environment |
53
+
54
+ ## Use Case Building Blocks
55
+
56
+ ### Core Use Cases
43
57
 
44
58
  | Use Case | Description | Quick Deploy Examples |
45
59
  |----------|-------------|----------------------|
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/) |
60
+ | **[Document Processing](./use-cases/document-processing/)** | Intelligent 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
61
  | **[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
62
 
49
- ## Foundation and Utilities
63
+ ### Foundation and Utilities
50
64
 
51
65
  | Component | Description |
52
66
  |-----------|-------------|
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
67
+ | **[Agentic AI Framework](./use-cases/framework/agents/)** | Composable enterprise framework for building intelligent AI agents that can be mixed and matched across diverse use cases - from document processing to conversational AI |
68
+ | **[Infrastructure Foundation](./use-cases/framework/foundation/)** | Core infrastructure components including VPC networking, access logging, and EventBridge integration |
69
+ | **[Observability & Monitoring](./use-cases/utilities/#observability)** | Comprehensive monitoring, logging, and alerting with automatic property injection and Lambda Powertools integration |
70
+ | **[Data Masking](./use-cases/utilities/#data-masking)** | Lambda layer for data masking and PII protection in serverless applications |
70
71
 
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
72
+ ## Getting Started
98
73
 
99
74
  ### Environment Setup
100
75
 
101
76
  ```bash
102
- # Clone the repository
103
- git clone https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
104
-
105
77
  # Configure AWS credentials and region
106
78
  aws configure
107
79
  # OR set AWS profile: export AWS_PROFILE=your-profile-name
@@ -110,73 +82,74 @@ aws configure
110
82
  npx cdk bootstrap
111
83
  ```
112
84
 
113
- ### Quick Start
85
+ ### Quick Deploy (Complete Solutions)
114
86
 
115
- Deploy a working example in **5 minutes**:
87
+ Deploy working examples in minutes for immediate value:
116
88
 
117
89
  ```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
90
+ # Clone the repository
91
+ git clone https://github.com/cdklabs/cdk-appmod-catalog-blueprints.git
129
92
 
130
- # Deploy with specific profile/region
131
- npx cdk deploy --require-approval never
93
+ # Deploy complete insurance claims processing solution
94
+ cd examples/document-processing/doc-processing-fullstack-webapp
95
+ npm install && npm run deploy
96
+ # Full AI-powered solution with web interface deployed
132
97
 
133
- # Update CDK CLI if needed
134
- npm install aws-cdk@latest
98
+ # Or deploy basic document processing
99
+ cd examples/document-processing/bedrock-document-processing
100
+ npm install && npm run deploy
135
101
  ```
136
102
 
137
- ### Development
138
-
139
- ```bash
140
- # Run all tests
141
- npm test
103
+ ### Using Individual Constructs
142
104
 
143
- # Run specific test pattern
144
- npm test -- --testPathPattern="document-processing"
105
+ Add to your existing CDK projects for custom solutions:
145
106
 
146
- # Generate CDK Nag compliance reports
147
- npm test -- --testPathPattern="nag.test.ts"
107
+ ```bash
108
+ # Install the library
109
+ npm install @cdklabs/appmod-catalog-blueprints
110
+
111
+ # Use in your CDK code
112
+ import { AgenticDocumentProcessing, WebApp } from '@cdklabs/appmod-catalog-blueprints';
113
+
114
+ const docProcessor = new AgenticDocumentProcessing(this, 'Processor', {
115
+ agentDefinition: {
116
+ bedrockModel: { useCrossRegionInference: true },
117
+ systemPrompt: myPrompt,
118
+ tools: [myTools]
119
+ }
120
+ });
148
121
  ```
149
122
 
150
- ## How to Use This Library
151
-
152
- ### Quick Start (Deploy Examples)
123
+ ## Key Design Principles
153
124
 
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
125
+ AppMod Catalog Blueprints is built on Object-Oriented Programming (OOP) principles, providing a structured approach to infrastructure development through core design concepts:
157
126
 
158
- ### Using Individual Constructs
127
+ ### Composable Architecture
159
128
 
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
129
+ Build complex enterprise systems by combining independent, reusable components with standardized interfaces.
163
130
 
164
- ### Understanding the Layers
131
+ * **Independent components** with clear interfaces and loose coupling for maximum flexibility
132
+ * **Mix and match building blocks** to create custom solutions across different contexts and use cases
133
+ * **Scalable composition** that maintains consistency while enabling incremental adoption and gradual modernization
165
134
 
166
- **Foundation Layer** (`use-cases/framework/`, `use-cases/utilities/`)
135
+ ### Multi-Layered Building Blocks Architecture
167
136
 
168
- * **When to use**: Building custom solutions or need specific infrastructure components
169
- * **Components**: VPC networking, observability utilities, data management tools, etc.
137
+ Our blueprints use a multi-layered architecture that bridges the gap between business requirements and technical implementation:
170
138
 
171
- **Use Case Layer** (`use-cases/document-processing/`, `use-cases/webapp/`)
139
+ | Layer | Implementation Type | Purpose | Key Features |
140
+ |-------|-------------------|---------|--------------|
141
+ | **Infrastructure Foundation** | Abstract base classes | Shared infrastructure components and common services | • Standardized interfaces and contracts<br/>• Extensible foundation for custom implementations |
142
+ | **General Use Case Implementation** | Concrete implementation classes | Implementations for common patterns across industries | • Configurable parameters for different environments<br/>• Abstract method implementations with general-purpose solutions |
143
+ | **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 |
172
144
 
173
- * **When to use**: Need proven patterns for common business problems
174
- * **Components**: Document processing workflows, web application hosting, data transformation patterns, etc.
145
+ ### Security & Compliance
175
146
 
176
- **Example Layer** (`examples/`)
147
+ All components include enterprise-grade security by default:
177
148
 
178
- * **When to use**: Want complete, deployable solutions
179
- * **Components**: Industry-specific configurations, end-to-end applications, reference implementations, etc.
149
+ * **CDK Nag Integration**: Automated security compliance checking
150
+ * **AWS Well-Architected**: Security, reliability, and performance best practices
151
+ * **Encryption & IAM**: At-rest/in-transit encryption with least-privilege access
152
+ * **Compliance Reports**: Generate reports with `npm test -- --testPathPattern="nag.test.ts"`
180
153
 
181
154
  ## Contributing
182
155
 
@@ -0,0 +1,9 @@
1
+ appmod_catalog_blueprints/__init__.py,sha256=LEG4uShzKzMQfX43sj7Nj5dAHHU2MTEJqfXJdNhKgUs,337675
2
+ appmod_catalog_blueprints/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
+ appmod_catalog_blueprints/_jsii/__init__.py,sha256=ScDe_09YtcYlLT6SkBzkxGakgpbW7MBeh3Q5t9yXkxk,1536
4
+ appmod_catalog_blueprints/_jsii/cdk-appmod-catalog-blueprints@1.4.0.jsii.tgz,sha256=Crs26b2_6vw9d5vgvhkuY2xDfxquGFQDJqc51Feq2YM,444365
5
+ appmod_catalog_blueprints-1.4.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
6
+ appmod_catalog_blueprints-1.4.0.dist-info/METADATA,sha256=RAM7MiPomW753pMdh7DQbBgSunrqo-WOJgG2VTq1DPc,9520
7
+ appmod_catalog_blueprints-1.4.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
+ appmod_catalog_blueprints-1.4.0.dist-info/top_level.txt,sha256=Ol8da5ggs2v4ibcxVrkcmnuFeKelb3o03ZaLWHGGcho,26
9
+ appmod_catalog_blueprints-1.4.0.dist-info/RECORD,,
@@ -1,9 +0,0 @@
1
- appmod_catalog_blueprints/__init__.py,sha256=ZrII9-CwkrIN2NTi7wCGqXqVNpfdInuwvw1a_a8BEaM,338211
2
- appmod_catalog_blueprints/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
3
- appmod_catalog_blueprints/_jsii/__init__.py,sha256=qkxXmOkOlRzGxuTABDXsXEYb1JOrZxr_95-plKax8oE,1536
4
- appmod_catalog_blueprints/_jsii/cdk-appmod-catalog-blueprints@1.3.0.jsii.tgz,sha256=haaF5Q_OXQkB5If8GrprQpqNvqfllrU-H0lfv583SSQ,383621
5
- appmod_catalog_blueprints-1.3.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
6
- appmod_catalog_blueprints-1.3.0.dist-info/METADATA,sha256=a6jxEJmLo6lims_qU2LGX8iK_uT-0jagXmvWZcD3CBA,10056
7
- appmod_catalog_blueprints-1.3.0.dist-info/WHEEL,sha256=iAkIy5fosb7FzIOwONchHf19Qu7_1wCWyFNR5gu9nU0,91
8
- appmod_catalog_blueprints-1.3.0.dist-info/top_level.txt,sha256=Ol8da5ggs2v4ibcxVrkcmnuFeKelb3o03ZaLWHGGcho,26
9
- appmod_catalog_blueprints-1.3.0.dist-info/RECORD,,