Skip to content

Commit 82d6837

Browse files
mwunderlmwunderl
committed
Add README.md and tutorial walkthrough for script-only tutorials
1 parent c02fd96 commit 82d6837

6 files changed

Lines changed: 209 additions & 0 deletions

File tree

‎tuts/126-amazon-firehose-gs/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Amazon Firehose Gs
2+
3+
An AWS CLI tutorial that demonstrates Firehose operations.
4+
5+
## Running
6+
7+
```bash
8+
bash amazon-firehose-gs.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash amazon-firehose-gs.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating S3 bucket: $BUCKET
20+
2. Creating IAM role
21+
3. Creating delivery stream: $STREAM_NAME
22+
4. Sending records
23+
5. Describing stream
24+
25+
## Resources created
26+
27+
- Bucket
28+
- Delivery Stream
29+
- Role
30+
- Record
31+
- Record Batch
32+
33+
The script prompts you to clean up resources when it finishes.
34+
35+
## Cost
36+
37+
Free tier eligible for most operations. Clean up resources after use to avoid charges.
38+
39+
## Related docs
40+
41+
- [AWS CLI firehose reference](https://docs.aws.amazon.com/cli/latest/reference/firehose/index.html)
42+
- [AWS CLI iam reference](https://docs.aws.amazon.com/cli/latest/reference/iam/index.html)
43+
- [AWS CLI s3 reference](https://docs.aws.amazon.com/cli/latest/reference/s3/index.html)
44+

‎tuts/126-amazon-firehose-gs/amazon-firehose-gs.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Amazon Firehose Gs
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 S3 bucket: $BUCKET
9+
10+
The script handles this step automatically. See `amazon-firehose-gs.sh` for the exact CLI commands.
11+
12+
## Step 2: Creating IAM role
13+
14+
The script handles this step automatically. See `amazon-firehose-gs.sh` for the exact CLI commands.
15+
16+
## Step 3: Creating delivery stream: $STREAM_NAME
17+
18+
The script handles this step automatically. See `amazon-firehose-gs.sh` for the exact CLI commands.
19+
20+
## Step 4: Sending records
21+
22+
The script handles this step automatically. See `amazon-firehose-gs.sh` for the exact CLI commands.
23+
24+
## Step 5: Describing stream
25+
26+
The script handles this step automatically. See `amazon-firehose-gs.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/132-amazon-ivs-gs/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Amazon Ivs Gs
2+
3+
An AWS CLI tutorial that demonstrates Ivs operations.
4+
5+
## Running
6+
7+
```bash
8+
bash amazon-ivs-gs.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash amazon-ivs-gs.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating channel: $CHANNEL_NAME
20+
2. Getting channel details
21+
3. Listing channels
22+
4. Getting stream key
23+
24+
## Resources created
25+
26+
- Channel
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 ivs reference](https://docs.aws.amazon.com/cli/latest/reference/ivs/index.html)
37+

‎tuts/132-amazon-ivs-gs/amazon-ivs-gs.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Amazon Ivs Gs
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 channel: $CHANNEL_NAME
9+
10+
The script handles this step automatically. See `amazon-ivs-gs.sh` for the exact CLI commands.
11+
12+
## Step 2: Getting channel details
13+
14+
The script handles this step automatically. See `amazon-ivs-gs.sh` for the exact CLI commands.
15+
16+
## Step 3: Listing channels
17+
18+
The script handles this step automatically. See `amazon-ivs-gs.sh` for the exact CLI commands.
19+
20+
## Step 4: Getting stream key
21+
22+
The script handles this step automatically. See `amazon-ivs-gs.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/137-amazon-location-gs/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Amazon Location Gs
2+
3+
An AWS CLI tutorial that demonstrates Location operations.
4+
5+
## Running
6+
7+
```bash
8+
bash amazon-location-gs.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash amazon-location-gs.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating map: $MAP_NAME
20+
2. Creating place index: $INDEX_NAME
21+
3. Searching for a place
22+
4. Reverse geocoding
23+
5. Listing maps
24+
25+
## Resources created
26+
27+
- Map
28+
- Place Index
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 location reference](https://docs.aws.amazon.com/cli/latest/reference/location/index.html)
39+

‎tuts/137-amazon-location-gs/amazon-location-gs.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Amazon Location Gs
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 map: $MAP_NAME
9+
10+
The script handles this step automatically. See `amazon-location-gs.sh` for the exact CLI commands.
11+
12+
## Step 2: Creating place index: $INDEX_NAME
13+
14+
The script handles this step automatically. See `amazon-location-gs.sh` for the exact CLI commands.
15+
16+
## Step 3: Searching for a place
17+
18+
The script handles this step automatically. See `amazon-location-gs.sh` for the exact CLI commands.
19+
20+
## Step 4: Reverse geocoding
21+
22+
The script handles this step automatically. See `amazon-location-gs.sh` for the exact CLI commands.
23+
24+
## Step 5: Listing maps
25+
26+
The script handles this step automatically. See `amazon-location-gs.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)