Skip to content

Commit d9b6755

Browse files
mwunderlmwunderl
committed
Add README.md and tutorial walkthrough for script-only tutorials
1 parent ff07c35 commit d9b6755

10 files changed

Lines changed: 264 additions & 0 deletions

File tree

‎tuts/179-cloudwatch-anomaly-detection/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Cloudwatch Anomaly Detection
2+
3+
An AWS CLI tutorial that demonstrates Cloudwatch operations.
4+
5+
## Running
6+
7+
```bash
8+
bash cloudwatch-anomaly-detection.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash cloudwatch-anomaly-detection.sh
15+
```
16+
17+
## What it does
18+
19+
1. Publishing baseline metrics
20+
2. Creating anomaly detector
21+
3. Creating anomaly detection alarm
22+
4. Describing alarm
23+
24+
## Resources created
25+
26+
- Anomaly Detector
27+
- Metric Alarm
28+
- Metric Data
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 cloudwatch reference](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/index.html)
39+

‎tuts/179-cloudwatch-anomaly-detection/cloudwatch-anomaly-detection.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Cloudwatch Anomaly Detection
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: Publishing baseline metrics
9+
10+
The script handles this step automatically. See `cloudwatch-anomaly-detection.sh` for the exact CLI commands.
11+
12+
## Step 2: Creating anomaly detector
13+
14+
The script handles this step automatically. See `cloudwatch-anomaly-detection.sh` for the exact CLI commands.
15+
16+
## Step 3: Creating anomaly detection alarm
17+
18+
The script handles this step automatically. See `cloudwatch-anomaly-detection.sh` for the exact CLI commands.
19+
20+
## Step 4: Describing alarm
21+
22+
The script handles this step automatically. See `cloudwatch-anomaly-detection.sh` for the exact CLI commands.
23+
24+
## Cleanup
25+
26+
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.
27+

‎tuts/189-cloudwatch-contributor-insights/README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Cloudwatch Contributor Insights
2+
3+
A read-only script that queries Cloudwatch resources and displays information.
4+
5+
## Running
6+
7+
```bash
8+
bash cloudwatch-contributor-insights.sh
9+
```
10+
11+
## What it does
12+
13+
1. Listing existing rules
14+
2. Listing log groups for analysis
15+
3. Getting metric widget image (base64)
16+
17+
## Resources created
18+
19+
None — this script is read-only.
20+
21+
## Cost
22+
23+
No cost. This script only reads existing resources.
24+
25+
## Related docs
26+
27+
- [AWS CLI cloudwatch reference](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/index.html)
28+
- [AWS CLI logs reference](https://docs.aws.amazon.com/cli/latest/reference/logs/index.html)
29+

‎tuts/189-cloudwatch-contributor-insights/cloudwatch-contributor-insights.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Cloudwatch Contributor Insights
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 existing rules
9+
10+
The script handles this step automatically. See `cloudwatch-contributor-insights.sh` for the exact CLI commands.
11+
12+
## Step 2: Listing log groups for analysis
13+
14+
The script handles this step automatically. See `cloudwatch-contributor-insights.sh` for the exact CLI commands.
15+
16+
## Step 3: Getting metric widget image (base64)
17+
18+
The script handles this step automatically. See `cloudwatch-contributor-insights.sh` for the exact CLI commands.
19+

‎tuts/195-cloudwatch-composite-alarms/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Cloudwatch Composite Alarms
2+
3+
An AWS CLI tutorial that demonstrates Cloudwatch operations.
4+
5+
## Running
6+
7+
```bash
8+
bash cloudwatch-composite-alarms.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash cloudwatch-composite-alarms.sh
15+
```
16+
17+
## What it does
18+
19+
1. Publishing metrics
20+
2. Creating metric alarms
21+
3. Creating composite alarm
22+
4. Describing composite alarm
23+
24+
## Resources created
25+
26+
- Composite Alarm
27+
- Metric Alarm
28+
- Metric Data
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 cloudwatch reference](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/index.html)
39+

‎tuts/195-cloudwatch-composite-alarms/cloudwatch-composite-alarms.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Cloudwatch Composite Alarms
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: Publishing metrics
9+
10+
The script handles this step automatically. See `cloudwatch-composite-alarms.sh` for the exact CLI commands.
11+
12+
## Step 2: Creating metric alarms
13+
14+
The script handles this step automatically. See `cloudwatch-composite-alarms.sh` for the exact CLI commands.
15+
16+
## Step 3: Creating composite alarm
17+
18+
The script handles this step automatically. See `cloudwatch-composite-alarms.sh` for the exact CLI commands.
19+
20+
## Step 4: Describing composite alarm
21+
22+
The script handles this step automatically. See `cloudwatch-composite-alarms.sh` for the exact CLI commands.
23+
24+
## Cleanup
25+
26+
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.
27+

‎tuts/210-dynamodb-list-tables/README.md‎

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

‎tuts/210-dynamodb-list-tables/dynamodb-list-tables.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Dynamodb List 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: Listing tables
9+
10+
The script handles this step automatically. See `dynamodb-list-tables.sh` for the exact CLI commands.
11+
12+
## Step 2: Table details
13+
14+
The script handles this step automatically. See `dynamodb-list-tables.sh` for the exact CLI commands.
15+

‎tuts/211-iam-list-users/README.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Iam List Users
2+
3+
A read-only script that queries Iam resources and displays information.
4+
5+
## Running
6+
7+
```bash
8+
bash iam-list-users.sh
9+
```
10+
11+
## What it does
12+
13+
1. Listing IAM users
14+
2. User count"; echo " Total: $(aws iam list-users --query 'Users | length(@)' --output text) users
15+
16+
## Resources created
17+
18+
None — this script is read-only.
19+
20+
## Cost
21+
22+
No cost. This script only reads existing resources.
23+
24+
## Related docs
25+
26+
- [AWS CLI iam reference](https://docs.aws.amazon.com/cli/latest/reference/iam/index.html)
27+

‎tuts/211-iam-list-users/iam-list-users.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Iam List Users
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 IAM users
9+
10+
The script handles this step automatically. See `iam-list-users.sh` for the exact CLI commands.
11+
12+
## Step 2: User count"; echo " Total: $(aws iam list-users --query 'Users | length(@)' --output text) users
13+
14+
The script handles this step automatically. See `iam-list-users.sh` for the exact CLI commands.
15+

0 commit comments

Comments
 (0)