Skip to content

Commit 3f1c815

Browse files
mwunderlmwunderl
committed
Add README.md and tutorial walkthrough for script-only tutorials
1 parent 62e3fe2 commit 3f1c815

8 files changed

Lines changed: 283 additions & 0 deletions

File tree

‎tuts/127-amazon-glacier-gs/README.md‎

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

‎tuts/127-amazon-glacier-gs/amazon-glacier-gs.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Amazon Glacier 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 vault: $VAULT_NAME
9+
10+
The script handles this step automatically. See `amazon-glacier-gs.sh` for the exact CLI commands.
11+
12+
## Step 2: Describing vault
13+
14+
The script handles this step automatically. See `amazon-glacier-gs.sh` for the exact CLI commands.
15+
16+
## Step 3: Uploading an archive
17+
18+
The script handles this step automatically. See `amazon-glacier-gs.sh` for the exact CLI commands.
19+
20+
## Step 4: Listing vaults
21+
22+
The script handles this step automatically. See `amazon-glacier-gs.sh` for the exact CLI commands.
23+
24+
## Step 5: Initiating inventory retrieval
25+
26+
The script handles this step automatically. See `amazon-glacier-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/156-s3-event-notifications/README.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# S3 Events
2+
3+
An AWS CLI tutorial that demonstrates S3 operations.
4+
5+
## Running
6+
7+
```bash
8+
bash s3-events.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash s3-events.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating SQS queue for notifications
20+
2. Creating bucket with event notification
21+
3. Uploading a file to trigger notification
22+
4. Reading notification from SQS
23+
24+
## Resources created
25+
26+
- Bucket
27+
- Queue
28+
- Bucket Notification Configuration
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 s3 reference](https://docs.aws.amazon.com/cli/latest/reference/s3/index.html)
39+
- [AWS CLI s3api reference](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
40+
- [AWS CLI sqs reference](https://docs.aws.amazon.com/cli/latest/reference/sqs/index.html)
41+

‎tuts/156-s3-event-notifications/s3-events.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# S3 Events
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 SQS queue for notifications
9+
10+
The script handles this step automatically. See `s3-events.sh` for the exact CLI commands.
11+
12+
## Step 2: Creating bucket with event notification
13+
14+
The script handles this step automatically. See `s3-events.sh` for the exact CLI commands.
15+
16+
## Step 3: Uploading a file to trigger notification
17+
18+
The script handles this step automatically. See `s3-events.sh` for the exact CLI commands.
19+
20+
## Step 4: Reading notification from SQS
21+
22+
The script handles this step automatically. See `s3-events.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/167-s3-presigned-urls/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# S3 Presigned
2+
3+
An AWS CLI tutorial that demonstrates S3 operations.
4+
5+
## Running
6+
7+
```bash
8+
bash s3-presigned.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash s3-presigned.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating bucket
20+
2. Uploading a file
21+
3. Generating presigned download URL (expires in 5 min)
22+
4. Testing presigned download
23+
5. Generating presigned upload URL
24+
6. Listing objects
25+
26+
## Resources created
27+
28+
- Bucket
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 s3 reference](https://docs.aws.amazon.com/cli/latest/reference/s3/index.html)
39+
- [AWS CLI s3api reference](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
40+

‎tuts/167-s3-presigned-urls/s3-presigned.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# S3 Presigned
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 bucket
9+
10+
The script handles this step automatically. See `s3-presigned.sh` for the exact CLI commands.
11+
12+
## Step 2: Uploading a file
13+
14+
The script handles this step automatically. See `s3-presigned.sh` for the exact CLI commands.
15+
16+
## Step 3: Generating presigned download URL (expires in 5 min)
17+
18+
The script handles this step automatically. See `s3-presigned.sh` for the exact CLI commands.
19+
20+
## Step 4: Testing presigned download
21+
22+
The script handles this step automatically. See `s3-presigned.sh` for the exact CLI commands.
23+
24+
## Step 5: Generating presigned upload URL
25+
26+
The script handles this step automatically. See `s3-presigned.sh` for the exact CLI commands.
27+
28+
## Step 6: Listing objects
29+
30+
The script handles this step automatically. See `s3-presigned.sh` for the exact CLI commands.
31+
32+
## Cleanup
33+
34+
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.
35+

‎tuts/171-s3-versioning/README.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# S3 Versioning
2+
3+
An AWS CLI tutorial that demonstrates S3 operations.
4+
5+
## Running
6+
7+
```bash
8+
bash s3-versioning.sh
9+
```
10+
11+
To auto-run with cleanup:
12+
13+
```bash
14+
echo 'y' | bash s3-versioning.sh
15+
```
16+
17+
## What it does
18+
19+
1. Creating versioned bucket
20+
2. Uploading multiple versions
21+
3. Listing versions
22+
4. Getting a specific version
23+
5. Deleting (creates delete marker)
24+
25+
## Resources created
26+
27+
- Bucket
28+
- Bucket Versioning
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 s3 reference](https://docs.aws.amazon.com/cli/latest/reference/s3/index.html)
39+
- [AWS CLI s3api reference](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html)
40+

‎tuts/171-s3-versioning/s3-versioning.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# S3 Versioning
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 versioned bucket
9+
10+
The script handles this step automatically. See `s3-versioning.sh` for the exact CLI commands.
11+
12+
## Step 2: Uploading multiple versions
13+
14+
The script handles this step automatically. See `s3-versioning.sh` for the exact CLI commands.
15+
16+
## Step 3: Listing versions
17+
18+
The script handles this step automatically. See `s3-versioning.sh` for the exact CLI commands.
19+
20+
## Step 4: Getting a specific version
21+
22+
The script handles this step automatically. See `s3-versioning.sh` for the exact CLI commands.
23+
24+
## Step 5: Deleting (creates delete marker)
25+
26+
The script handles this step automatically. See `s3-versioning.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)