Skip to content

Commit 5828f7e

Browse files
tebanieotebanieo
committed
feat: Implementing the change as listed on issue aws-samples#109 
1 parent e9a65e3 commit 5828f7e

File tree

7 files changed

+77
-5
lines changed

7 files changed

+77
-5
lines changed

‎infrastructure_as_code/README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1-
- [`cloudformation`](./infrastructure_as_code/cloudformation/README.md): Includes all the templates in this repository that are deployable via AWS Cloudformation. One folder per solution that includes a deployable cloudformation template, the project MUST have a README.md file that explains the need of the template.
2-
- [`cdk`](./infrastructure_as_code/cdk/README.md): One folder per solution that includes a deployable CDK project. The project MUST have a README.md file that explains why this project is important, the pre-requisites and how to deploy it.
3-
- [`security`](./infrastructure_as_code/security/README.md): IAM policies examples in JSON format, optionally you can include CDK and Cloudformation examples.
1+
# 🗂️ Infrastructure as Code # Update me !!
42

5-
We have [IAM policies for DynamoDB](https://github.com/aws-samples/aws-dynamodb-examples/tree/master/DynamoDBIAMPolicies), [a script to load an existing table](https://github.com/aws-samples/aws-dynamodb-examples/tree/master/nosqlworkbenchscript) into NoSQL Workbench, [CloudFormation examples](https://github.com/aws-samples/aws-dynamodb-examples/tree/master/cloudformation), and [a CDK to track table size and item count histories to CloudWatch](https://github.com/aws-samples/aws-dynamodb-examples/tree/master/DynamoDBCustomMetrics).
3+
This folder contains templates and projects for deploying Amazon DynamoDB resources to AWS using Infrastructure as Code (IaC) tools.
64

7-
We also have AWS SDK [code examples for DynamoDB in various languages](https://github.com/aws-samples/aws-dynamodb-examples/tree/master/DynamoDB-SDK-Examples). You can find each language examples here:
5+
## 📁 CloudFormation
6+
7+
The cloudformation folder includes all the templates in this repository that are deployable via AWS CloudFormation. Each solution has a dedicated folder that contains a deployable CloudFormation template, along with a README.md file that explains the purpose of the template.
8+
9+
[Explore the CloudFormation templates »](./cloudformation/README.md)
10+
11+
## 📁 AWS CDK
12+
13+
The cdk folder contains AWS CDK projects, with one folder per solution that includes a deployable CDK stack. Each project has a README.md file that explains the importance of the solution, the pre-requisites, and how to deploy it.
14+
15+
[Check out the AWS CDK examples »](./cdk/README.md)
16+
17+
## 📁 Security
18+
19+
The security folder includes examples of IAM policies in JSON format that can be used to secure your DynamoDB resources. Optionally, you can find CDK and CloudFormation examples for these policies as well.
20+
21+
[Discover the DynamoDB security policies »](./security/README.md)

‎infrastructure_as_code/cdk/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Update me !!

‎infrastructure_as_code/cloudformation/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Update me !!

‎infrastructure_as_code/security/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Update me !!

‎schema_design/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# 🗂️ Schema Design - # Update me !!
2+
3+
Designing an efficient and scalable data model is crucial when working with Amazon DynamoDB. This folder contains a collection of schema design patterns and best practices that you can leverage in your DynamoDB table implementations.
4+
5+
## 🔍 Explore the Patterns
6+
7+
Delve into the various schema design approaches and discover how they can help you optimize your DynamoDB data models:
8+
9+
Global Secondary Indexes (GSI): Learn how to leverage GSIs to enable efficient queries and data access patterns.
10+
Composite Primary Keys: Understand how to structure your primary keys to support complex query requirements.
11+
Time Series Data: Explore strategies for modeling time-series data in DynamoDB, such as using Time to Live (TTL) and Time Series Tables.
12+
One-to-Many Relationships: Discover techniques for modeling one-to-many relationships in your DynamoDB tables.
13+
Many-to-Many Relationships: Investigate approaches for handling many-to-many relationships using DynamoDB's flexible data model.
14+
Hierarchical Data: Learn how to represent hierarchical data structures, such as organizational charts or nested categories, in your DynamoDB tables.
15+
16+
Each design pattern is accompanied by sample code, performance considerations, and real-world use cases to help you make informed decisions for your DynamoDB applications.
17+
18+
[Dive into the schema design patterns »](https://console.harmony.a2z.com/README.md)

‎scripts/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# 🗒️ Scripts # Update me !!
2+
3+
The scripts folder contains a variety of utility scripts that can be executed locally or on an EC2 instance to perform specific actions on your DynamoDB tables. These scripts serve a particular purpose and are intended to achieve a very specific task.
4+
5+
## 🛠️ Tailored Automation
6+
7+
If you're looking for examples or ideas on how to use the AWS SDK to interact with DynamoDB, you should visit the [SDK examples](./examples/SDK/README.md) section of the repository. The scripts in this folder are designed to address more specialized use cases and requirements.
8+
9+
Some of the script categories you'll find in this folder include:
10+
11+
Data Manipulation: Scripts for bulk importing, exporting, or transforming data in your DynamoDB tables.
12+
Performance Optimization: Scripts to analyze and optimize the performance of your DynamoDB tables, such as managing indexes or provisioned capacity.
13+
Monitoring and Alerting: Scripts that integrate with AWS services like CloudWatch to monitor and trigger alerts for your DynamoDB resources.
14+
DevOps Automation: Scripts that automate common DynamoDB-related tasks, such as table creation, backup, or restoration.
15+
16+
## 🔍 Explore the Scripts
17+
18+
Each script in this folder is accompanied by a README file that explains the script's purpose, its usage, and any relevant prerequisites or dependencies. Feel free to browse the scripts and adapt them to your specific needs.
19+
20+
[Discover the DynamoDB utility scripts »](./README.md)

‎workshops/README.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# 🗓️ Workshops
2+
3+
The workshops folder temporarily stores workshop content and materials that can be used to learn how to use Amazon DynamoDB in real-life applications. These workshops are designed to provide hands-on experience and guide you through the process of building DynamoDB-powered solutions.
4+
5+
## 🌟 Hands-On Learning
6+
7+
The workshops in this folder cover a wide range of topics, from DynamoDB fundamentals to advanced use cases. Each workshop includes:
8+
9+
Comprehensive Instructions: Detailed step-by-step guides that walk you through the workshop exercises.
10+
Sample Code and Resources: Supporting code samples, configuration files, and other resources needed to complete the workshops.
11+
Real-world Scenarios: The workshops focus on practical, real-world applications of DynamoDB, helping you develop skills that are directly applicable to your own projects.
12+
13+
## 📚 Explore the Workshops
14+
15+
Whether you're new to DynamoDB or looking to expand your expertise, these workshops provide an invaluable learning experience. Browse the available workshops and choose the ones that align with your specific goals and interests.
16+
17+
[Check out the DynamoDB workshops »](./README.md)

0 commit comments

Comments
 (0)