AWS solutions documentation change
Summary
Added comprehensive documentation for the Sustainability Insights Framework (SIF) on AWS, including overview, architecture diagrams, module descriptions, deployment instructions, and Well-Architected Pillars analysis.
Security assessment
This change adds new solution documentation without addressing any specific security vulnerability. The documentation includes a security section describing authentication with Amazon Cognito, authorization via Access Management module, encryption at rest and in transit, and use of AWS KMS for data encryption. However, there is no evidence this change fixes a security issue; it's general documentation for a new sustainability framework.
Diff
diff --git a/solutions/sustainability-insights-framework-on-aws/index.md b/solutions/sustainability-insights-framework-on-aws/index.md index 8b1378917..f61aca077 100644 --- a//solutions/sustainability-insights-framework-on-aws/index.md +++ b//solutions/sustainability-insights-framework-on-aws/index.md @@ -0,0 +1 @@ +# Guidance for Sustainability Insights Framework on AWS @@ -1,0 +3,313 @@ +[ Go to sample code: SIF ](https://github.com/aws-solutions-library-samples/guidance-for-aws-sustainability-insights-framework)[ Go to sample code: SIF CLI ](https://github.com/aws-solutions-library-samples/guidance-for-aws-sustainability-insights-framework-cli) + +## Overview + +This Guidance demonstrates how you can automate your carbon footprint tracking with the Sustainability Insights Framework (SIF) on AWS. If you are looking to build a new carbon footprint tracking system or to improve an existing one, this Guidance will help you accelerate the design and automate tracking processes. + +## How it works + +Overview + +The SIF is composed of a suite of modules focusing on a specific set of features. This conceptual architecture shows these modules and their interactions. + +[ Download the architecture diagram. ](https://d1.awsstatic.com/solutions/guidance/architecture-diagrams/sustainability-insights-framework-on-aws.pdf)  Step 1 + +Users interact with SIF through REST APIs. + +Step 2 + +The Access Management module is where users and permissions are managed and resources are separated by groups. + +Step 3 + +When performing data processing calculations, the Impacts module enables users to manage resources, such as impact factors, that can be referenced from within the Calculations and Pipelines modules. + +Step 4 + +The Reference Datasets module enables users to manage datasets, such as lookup tables. These datasets can be referenced from within the Calculations and Pipelines modules. + +Step 5 + +The Calculations module enables users to define and manage equations or functions which can be referenced in other modules to perform data processing calculations. + +Step 6 + +The Pipelines module enables users to configure data processing pipelines used to perform calculations. + +Step 7 + +The Pipeline Processor module is responsible for orchestrating pipelines and performing pipeline aggregations. + +Step 8 + +The Calculator module is a backend component that runs operations in a pipeline. This can include arithmetic or the lookup of resources. + +Access Management + +The Access Management Module uses the concepts of users and groups to allow for permissions management and segregation of resources within SIF. SIF users can define users and groups through an external REST API. + +[ Download the architecture diagram. ](https://d1.awsstatic.com/solutions/guidance/architecture-diagrams/sustainability-insights-framework-on-aws.pdf)  Step 1 + +Users of SIF interact with the Access Management module through an externally available API. + +Step 2 + +The externally available API consists of a REST API in **Amazon API Gateway**. The application logic is deployed in **AWS Lambda**. + +Step 3 + +User authentication is done through tokens received from **Amazon Cognito**. + +Step 4 + +The Access Management data is stored in an **Amazon DynamoDB** table. + +Step 5 + +Access Management resource changes emit events to a message bus in **Amazon EventBridge**. Events can be tracked to update other components of the framework. + +Impacts + +The Impacts Module enables users to manage impact-related resources. These resources can be referenced from within the Calculations and Pipelines modules when performing data processing calculations, such as emissions. + +[ Download the architecture diagram. ](https://d1.awsstatic.com/solutions/guidance/architecture-diagrams/sustainability-insights-framework-on-aws.pdf)  Step 1 + +Users of SIF interact with the Impacts module through an externally available API. + +Step 2 + +The externally available API consists of a REST API in **API Gateway**. The application logic is deployed in **Lambda**. + +Step 3 + +User authentication is done through tokens received from **Amazon Cognito**. Authorization is done through the Access Management module. + +Step 4 + +Impact data is stored in a **DynamoDB** table. + +Step 5 + +**Amazon Simple Queue Service (Amazon SQS)** is used along with a Lambda Impact Task Processor to orchestrate bulk Impact creation tasks. + +Step 6 + +Amazon SQS asynchronously processes metadata updates to resources, such as adding searchable tags. + +Step 7 + +Impacts resource changes emit events to a message bus in **EventBridge**. Events can be tracked to update other components of the framework. + +Reference Datasets + +The Reference Datasets Module enables users to manage datasets, such as lookup tables. These datasets can be referenced from within the Calculations and Pipelines modules when performing data processing calculations, such as emissions. + +[ Download the architecture diagram. ](https://d1.awsstatic.com/solutions/guidance/architecture-diagrams/sustainability-insights-framework-on-aws.pdf)  Step 1 + +Users of SIF interact with the Reference Datasets module through an externally available API and file uploads to **Amazon Simple Storage Service (Amazon S3)** through a pre-signed URL. + +Step 2 + +The externally available API consists of a REST API in **API Gateway**. The application logic is deployed in **Lambda**. + +Step 3 + +User authentication is done through tokens received from **Amazon Cognito**. Authorization is done through the Access Management module. + +Step 4 + +Data (such as dataset names) and metadata (such as tags) are stored in a **DynamoDB** table. + +Step 5 + +The dataset is stored in **Amazon S3**. + +Step 6 + +The dataset is indexed on Create/Update using **AWS Step Functions**. + +Step 7 + +Amazon SQS asynchronously processes metadata updates to resources, such as adding searchable tags. + +Step 8 + +Reference Dataset resource changes emit events to a message bus in **EventBridge**. Events can be tracked to update other components of the framework. + +Calculations + +The Calculations Module enables users to define and manage equations or functions. These equations or functions can then be referenced in other Calculations or Pipelines modules when performing data processing calculations, such as emissions. + +[ Download the architecture diagram. ](https://d1.awsstatic.com/solutions/guidance/architecture-diagrams/sustainability-insights-framework-on-aws.pdf)  Step 1 + +Users of SIF interact with the Calculations module through an externally available API. + +Step 2 + +The externally available API consists of a REST API in **API Gateway**. The application logic is deployed in **Lambda**. + +Step 3 + +User authentication is done through tokens received from **Amazon Cognito**. Authorization is done through the Access Management module. + +Step 4 + +Calculations data is stored in a **DynamoDB** table. + +Step 5 + +Amazon SQS asynchronously processes metadata updates to resources, such as adding searchable tags. + +Step 6 + +Calculations resource changes emit events to a message bus in **EventBridge**. Events can be tracked to update other components of the framework. + +Pipelines + +The Pipelines Module enables users to manage Pipeline configurations. These configurations define data processing pipelines used to perform calculations, such as emissions. A Pipeline can be configured to aggregate outputs across executions and groups into metrics. Metrics capture key performance indicators (KPIs), such as total emissions over time. + +[ Download the architecture diagram. ](https://d1.awsstatic.com/solutions/guidance/architecture-diagrams/sustainability-insights-framework-on-aws.pdf)  Step 1 + +Users of SIF interact with the Pipelines module through an externally available API. + +Step 2 + +The externally available API consists of a REST API in **API Gateway**. The application logic is deployed in **Lambda**. + +Step 3 + +User authentication is done through tokens received from **Amazon Cognito**. Authorization is done through the Access Management module. + +Step 4 + +Pipeline configuration is stored in a **DynamoDB** table. + +Step 5 + +The Pipelines module can directly invoke the Calculator module to dry run a pipeline configuration. + +Step 6 + +Amazon SQS asynchronously processes metadata updates to resources, such as adding searchable tags. + +Step 7