Skip to content

Commit 96c3be6

Browse files
mwunderlmwunderl
committed
Add README.md and tutorial walkthrough for script-only tutorials
1 parent 3a3bd5e commit 96c3be6

10 files changed

Lines changed: 323 additions & 0 deletions

File tree

‎tuts/153-dynamodb-streams/README.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Dynamodb Streams
2+
3+
An AWS CLI tutorial that demonstrates Dynamodb operations.
4+
5+
## Running
6+
7+
```bash
8+
bash dynamodb-streams.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash dynamodb-streams.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating table with streams enabled
20+
2. Writing items to trigger stream events
21+
3. Reading stream records
22+
23+
## Resources created
24+
25+
- Table
26+
- Item
27+
28+
The script prompts you to clean up resources when it finishes.
29+
30+
## Cost
31+
32+
Free tier eligible for most operations. Clean up resources after use to avoid charges.
33+
34+
## Related docs
35+
36+
- [AWS CLI dynamodb reference](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/index.html)
37+
- [AWS CLI dynamodbstreams reference](https://docs.aws.amazon.com/cli/latest/reference/dynamodbstreams/index.html)
38+

‎tuts/153-dynamodb-streams/dynamodb-streams.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Dynamodb Streams
2+
3+
## Prerequisites
4+
5+
1. AWS CLI installed and configured (`aws configure`)
6+
2. Appropriate IAM permissions for the AWS services used
7+
8+
## Step 1: Creating table with streams enabled
9+
10+
The script handles this step automatically. See `dynamodb-streams.sh` for the exact CLI commands.
11+
12+
## Step 2: Writing items to trigger stream events
13+
14+
The script handles this step automatically. See `dynamodb-streams.sh` for the exact CLI commands.
15+
16+
## Step 3: Reading stream records
17+
18+
The script handles this step automatically. See `dynamodb-streams.sh` for the exact CLI commands.
19+
20+
## Cleanup
21+
22+
The script prompts you to clean up all created resources. If you need to clean up manually, check the script log for the resource names that were created.
23+

‎tuts/162-dynamodb-continuous-backups/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Dynamodb Global Tables
2+
3+
An AWS CLI tutorial that demonstrates Dynamodb operations.
4+
5+
## Running
6+
7+
```bash
8+
bash dynamodb-global-tables.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash dynamodb-global-tables.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating table
20+
2. Enabling point-in-time recovery
21+
3. Describing continuous backups
22+
4. Writing and reading items
23+
5. Table details
24+
25+
## Resources created
26+
27+
- Table
28+
- Item
29+
30+
The script prompts you to clean up resources when it finishes.
31+
32+
## Cost
33+
34+
Free tier eligible for most operations. Clean up resources after use to avoid charges.
35+
36+
## Related docs
37+
38+
- [AWS CLI dynamodb reference](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/index.html)
39+

‎tuts/162-dynamodb-continuous-backups/dynamodb-global-tables.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Dynamodb Global Tables
2+
3+
## Prerequisites
4+
5+
1. AWS CLI installed and configured (`aws configure`)
6+
2. Appropriate IAM permissions for the AWS services used
7+
8+
## Step 1: Creating table
9+
10+
The script handles this step automatically. See `dynamodb-global-tables.sh` for the exact CLI commands.
11+
12+
## Step 2: Enabling point-in-time recovery
13+
14+
The script handles this step automatically. See `dynamodb-global-tables.sh` for the exact CLI commands.
15+
16+
## Step 3: Describing continuous backups
17+
18+
The script handles this step automatically. See `dynamodb-global-tables.sh` for the exact CLI commands.
19+
20+
## Step 4: Writing and reading items
21+
22+
The script handles this step automatically. See `dynamodb-global-tables.sh` for the exact CLI commands.
23+
24+
## Step 5: Table details
25+
26+
The script handles this step automatically. See `dynamodb-global-tables.sh` for the exact CLI commands.
27+
28+
## Cleanup
29+
30+
The script prompts you to clean up all created resources. If you need to clean up manually, check the script log for the resource names that were created.
31+

‎tuts/164-rds-snapshots/README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Rds Snapshots
2+
3+
A read-only script that queries Rds resources and displays information.
4+
5+
## Running
6+
7+
```bash
8+
bash rds-snapshots.sh
9+
```
10+
11+
## What it does
12+
13+
1. Listing RDS instances
14+
2. Listing automated snapshots
15+
3. Listing manual snapshots
16+
4. Listing cluster snapshots
17+
18+
## Resources created
19+
20+
None — this script is read-only.
21+
22+
## Cost
23+
24+
No cost. This script only reads existing resources.
25+
26+
## Related docs
27+
28+
- [AWS CLI rds reference](https://docs.aws.amazon.com/cli/latest/reference/rds/index.html)
29+

‎tuts/164-rds-snapshots/rds-snapshots.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Rds Snapshots
2+
3+
## Prerequisites
4+
5+
1. AWS CLI installed and configured (`aws configure`)
6+
2. Appropriate IAM permissions for the AWS services used
7+
8+
## Step 1: Listing RDS instances
9+
10+
The script handles this step automatically. See `rds-snapshots.sh` for the exact CLI commands.
11+
12+
## Step 2: Listing automated snapshots
13+
14+
The script handles this step automatically. See `rds-snapshots.sh` for the exact CLI commands.
15+
16+
## Step 3: Listing manual snapshots
17+
18+
The script handles this step automatically. See `rds-snapshots.sh` for the exact CLI commands.
19+
20+
## Step 4: Listing cluster snapshots
21+
22+
The script handles this step automatically. See `rds-snapshots.sh` for the exact CLI commands.
23+

‎tuts/168-dynamodb-queries/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Dynamodb Queries
2+
3+
An AWS CLI tutorial that demonstrates Dynamodb operations.
4+
5+
## Running
6+
7+
```bash
8+
bash dynamodb-queries.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash dynamodb-queries.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating table with GSI
20+
2. Writing items
21+
3. Query by partition key
22+
4. Query GSI (active users)
23+
5. Scan with filter
24+
25+
## Resources created
26+
27+
- Table
28+
- Item
29+
30+
The script prompts you to clean up resources when it finishes.
31+
32+
## Cost
33+
34+
Free tier eligible for most operations. Clean up resources after use to avoid charges.
35+
36+
## Related docs
37+
38+
- [AWS CLI dynamodb reference](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/index.html)
39+

‎tuts/168-dynamodb-queries/dynamodb-queries.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Dynamodb Queries
2+
3+
## Prerequisites
4+
5+
1. AWS CLI installed and configured (`aws configure`)
6+
2. Appropriate IAM permissions for the AWS services used
7+
8+
## Step 1: Creating table with GSI
9+
10+
The script handles this step automatically. See `dynamodb-queries.sh` for the exact CLI commands.
11+
12+
## Step 2: Writing items
13+
14+
The script handles this step automatically. See `dynamodb-queries.sh` for the exact CLI commands.
15+
16+
## Step 3: Query by partition key
17+
18+
The script handles this step automatically. See `dynamodb-queries.sh` for the exact CLI commands.
19+
20+
## Step 4: Query GSI (active users)
21+
22+
The script handles this step automatically. See `dynamodb-queries.sh` for the exact CLI commands.
23+
24+
## Step 5: Scan with filter
25+
26+
The script handles this step automatically. See `dynamodb-queries.sh` for the exact CLI commands.
27+
28+
## Cleanup
29+
30+
The script prompts you to clean up all created resources. If you need to clean up manually, check the script log for the resource names that were created.
31+

‎tuts/173-dynamodb-ttl/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Dynamodb Ttl
2+
3+
An AWS CLI tutorial that demonstrates Dynamodb operations.
4+
5+
## Running
6+
7+
```bash
8+
bash dynamodb-ttl.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash dynamodb-ttl.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating table
20+
2. Enabling TTL
21+
3. Writing items with TTL
22+
4. Describing TTL
23+
5. Scanning items
24+
25+
## Resources created
26+
27+
- Table
28+
- Item
29+
30+
The script prompts you to clean up resources when it finishes.
31+
32+
## Cost
33+
34+
Free tier eligible for most operations. Clean up resources after use to avoid charges.
35+
36+
## Related docs
37+
38+
- [AWS CLI dynamodb reference](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/index.html)
39+

‎tuts/173-dynamodb-ttl/dynamodb-ttl.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Dynamodb Ttl
2+
3+
## Prerequisites
4+
5+
1. AWS CLI installed and configured (`aws configure`)
6+
2. Appropriate IAM permissions for the AWS services used
7+
8+
## Step 1: Creating table
9+
10+
The script handles this step automatically. See `dynamodb-ttl.sh` for the exact CLI commands.
11+
12+
## Step 2: Enabling TTL
13+
14+
The script handles this step automatically. See `dynamodb-ttl.sh` for the exact CLI commands.
15+
16+
## Step 3: Writing items with TTL
17+
18+
The script handles this step automatically. See `dynamodb-ttl.sh` for the exact CLI commands.
19+
20+
## Step 4: Describing TTL
21+
22+
The script handles this step automatically. See `dynamodb-ttl.sh` for the exact CLI commands.
23+
24+
## Step 5: Scanning items
25+
26+
The script handles this step automatically. See `dynamodb-ttl.sh` for the exact CLI commands.
27+
28+
## Cleanup
29+
30+
The script prompts you to clean up all created resources. If you need to clean up manually, check the script log for the resource names that were created.
31+

0 commit comments

Comments
 (0)