AWS prescriptive-guidance documentation change
Summary
Restructured documentation into distinct phases with clearer headings, renumbered steps for each phase, updated image path, and added explicit authentication/authorization steps for Amazon Bedrock usage.
Security assessment
Changes are organizational improvements (phase separation, step renumbering) and operational clarifications. Added authentication/authorization steps (steps 4-5 in documentation phase) describe standard security practices for API access but don't address a specific vulnerability or introduce new security features.
Diff
diff --git a/prescriptive-guidance/latest/automating-aws-infrastructure-documentation-generation-and-analysis/architecture.md b/prescriptive-guidance/latest/automating-aws-infrastructure-documentation-generation-and-analysis/architecture.md index eea8cfba4..1129e5a97 100644 --- a//prescriptive-guidance/latest/automating-aws-infrastructure-documentation-generation-and-analysis/architecture.md +++ b//prescriptive-guidance/latest/automating-aws-infrastructure-documentation-generation-and-analysis/architecture.md @@ -6,0 +7,2 @@ +Resource scanning phaseDocumentation generation phaseDependency mapping phase + @@ -11 +13 @@ The Infrastructure Documentation Generator is designed with a modular architectu - * **_Resource scanning_** – The initial process of querying AWS services to discover and inventory resources, collecting metadata and policies needed for further documentation and dependency analysis. The subsequent phases rely on the data collected in this phase. + * Resource scanning –The initial process of querying AWS services to discover and inventory resources, collecting metadata and policies needed for further documentation and dependency analysis. The subsequent phases rely on the data collected in this phase. @@ -13 +15 @@ The Infrastructure Documentation Generator is designed with a modular architectu - * **_Documentation generation_** – The system creates detailed Markdown-based reports that describe AWS resource configurations, best practices, and security posture. + * Documentation generation – The system creates detailed Markdown-based reports that describe AWS resource configurations, best practices, and security posture. @@ -15 +17 @@ The Infrastructure Documentation Generator is designed with a modular architectu - * **_Dependency mapping_** – A process that analyzes resource-based policies and identifiers to build a graph of how AWS resources relate and interact with each other, enabling visualization of resource connections and access paths. + * Dependency mapping – A process that analyzes resource-based policies and identifiers to build a graph of how AWS resources relate and interact with each other, enabling visualization of resource connections and access paths. @@ -22 +24 @@ Each phase follows a structured sequence of steps, as shown in the following dia - + @@ -24 +26 @@ Each phase follows a structured sequence of steps, as shown in the following dia -The following list provides details about each step: +## Resource scanning phase @@ -26 +28 @@ The following list provides details about each step: - 1. **_Resource scanning phase_** +The following steps occur in the resource scanning phase: @@ -28 +30 @@ The following list provides details about each step: -**Request resource information** – The process begins when a client sends an initial request to the system to gather information about their AWS infrastructure. + 1. **Request resource information** – The process begins when a client sends an initial request to the system to gather information about their AWS infrastructure. @@ -44 +45,0 @@ The following list provides details about each step: -**_Documentation generation phase_** @@ -46 +46,0 @@ The following list provides details about each step: - 9. **Request documentation generation** – The client initiates the documentation process based on the scanned resource data, triggering the documentation generator component. @@ -48 +47,0 @@ The following list provides details about each step: - 10. **Use resource configurations** – The system retrieves cached resource data from the scanning phase to serve as the foundation for documentation generation. @@ -50 +49,13 @@ The following list provides details about each step: - 11. **Initiate AI documentation generation** – The system begins the AI-powered documentation process using Amazon Bedrock, preparing the necessary context and prompts for documentation creation. +## Documentation generation phase + + 1. **Request documentation generation** – The client initiates the documentation process based on the scanned resource data, triggering the documentation generator component. + + 2. **Use resource configurations** – The system retrieves cached resource data from the scanning phase to serve as the foundation for documentation generation. + + 3. **Initiate AI documentation generation** – The system begins the AI-powered documentation process using Amazon Bedrock, preparing the necessary context and prompts for documentation creation. + + 4. **Authenticate for** Amazon Bedrock**API** – The system establishes a connection to Amazon Bedrock by making authenticated API requests with valid credentials. + + 5. **Authorize access for documentation** – IAM permissions are verified to make sure that the system is allowed to use Amazon Bedrock for generating documentation. + + 6. **Store generated AI documentation** – The AI-generated documentation is saved in persistent storage for future reference. @@ -52 +63 @@ The following list provides details about each step: - 12. **Authenticate for Amazon Bedrock API** – The system establishes a connection to Amazon Bedrock by making authenticated API requests with valid credentials. + 7. **Transfer documentation to cache** – The generated documentation is copied into cache storage for quicker access and performance. @@ -54 +65 @@ The following list provides details about each step: - 13. **Authorize access for documentation** – IAM permissions are verified to make sure that the system is allowed to use Amazon Bedrock for generating documentation. + 8. **Return documentation response** – The system formats and sends the generated documentation back to the client. @@ -56 +67 @@ The following list provides details about each step: - 14. **Store generated AI documentation** – The AI-generated documentation is saved in persistent storage for future reference. + 9. **Display documentation** – The documentation is presented to the client through the interface in a clear and organized format. @@ -58 +68,0 @@ The following list provides details about each step: - 15. **Transfer documentation to cache** – The generated documentation is copied into cache storage for quicker access and performance. @@ -60 +69,0 @@ The following list provides details about each step: - 16. **Return documentation response** – The system formats and sends the generated documentation back to the client. @@ -62 +70,0 @@ The following list provides details about each step: - 17. **Display documentation** – The documentation is presented to the client through the interface in a clear and organized format. @@ -64 +72 @@ The following list provides details about each step: -**_Dependency mapping phase_** +## Dependency mapping phase @@ -66 +74 @@ The following list provides details about each step: - 18. **Request dependency analysis** –The client initiates the process to analyze and map relationships between AWS resources. + 1. **Request dependency analysis** –The client initiates the process to analyze and map relationships between AWS resources. @@ -68 +76 @@ The following list provides details about each step: - 19. **Use resource configurations** – The system accesses cached resource data from the scanning phase to identify interdependencies among resources. + 2. **Use resource configurations** – The system accesses cached resource data from the scanning phase to identify interdependencies among resources. @@ -70 +78 @@ The following list provides details about each step: - 20. **Initiate relationship analysis** – The dependency mapper processes the resource data to identify and map connections between AWS services. + 3. **Initiate relationship analysis** – The dependency mapper processes the resource data to identify and map connections between AWS services. @@ -72 +80 @@ The following list provides details about each step: - 21. **Authenticate for Amazon Bedrock** – The system establishes a connection to Amazon Bedrock by making authenticated API requests with valid credentials. + 4. **Authenticate for** Amazon Bedrock – The system establishes a connection to Amazon Bedrock by making authenticated API requests with valid credentials. @@ -74 +82 @@ The following list provides details about each step: - 22. **Authorize access for dependency analysis** – IAM permissions are verified to ensure the system can use Amazon Bedrock for dependency analysis tasks. + 5. **Authorize access for dependency analysis** – IAM permissions are verified to ensure the system can use Amazon Bedrock for dependency analysis tasks. @@ -76 +84 @@ The following list provides details about each step: - 23. **Store dependency results** – The completed dependency analysis results are saved in persistent storage. + 6. **Store dependency results** – The completed dependency analysis results are saved in persistent storage. @@ -78 +86 @@ The following list provides details about each step: - 24. **Transfer mappings to cache** – Dependency mapping data is moved into cache storage for faster access and reuse. + 7. **Transfer mappings to cache** – Dependency mapping data is moved into cache storage for faster access and reuse. @@ -80 +88 @@ The following list provides details about each step: - 25. **Return dependency response** – The system prepares and sends the dependency analysis results back to the client. + 8. **Return dependency response** – The system prepares and sends the dependency analysis results back to the client. @@ -82 +90 @@ The following list provides details about each step: - 26. **Display dependency graph** – The final dependency relationships are visualized and shown to the client as an interactive graph, illustrating service connections and resource dependencies. + 9. **Display dependency graph** – The final dependency relationships are visualized and shown to the client as an interactive graph, illustrating service connections and resource dependencies.