AWS Developer Tutorials

A collection of AWS CLI scripts and tutorials for common AWS service use cases, designed to help developers quickly get started with AWS services through the command line.

Overview

This repository contains AWS CLI scripts and tutorials that demonstrate how to use AWS services through the command line interface. The scripts are designed to be interactive, handle errors, and clean up resources after use. The tutorials provide step-by-step guidance on how to use the scripts and understand the underlying AWS services.

These resources serve three main purposes:

1. Running scripts: Execute ready-made scripts to quickly set up and explore AWS services
2. Reading tutorials: Learn how AWS services work through detailed tutorials
3. Generating new scripts: Use Amazon Q Developer CLI to create new scripts for additional use cases

Repository structure

• /tuts: Contains all tutorials and scripts, organized by use case
• /instra: Contains instructions for generating new tutorials and scripts

Each tutorial folder follows a naming convention of XXX-service-usecase where XXX is a three-digit number, and contains:

• A shell script (.sh) that implements the use case
• A tutorial (.md) that explains the use case and how to use the script
• Supporting files for documentation and reference

Running scripts

To run an existing script:

1. Clone this repository or download the specific script you need
2. Make the script executable: chmod +x script-name.sh
3. Run the script: ./script-name.sh

The scripts are interactive and will:

• Prompt for necessary inputs
• Create AWS resources
• Show the results of operations
• Track created resources
• Offer to clean up resources when done

Reading tutorials

Each script comes with a detailed tutorial that explains:

• The AWS service and use case
• Prerequisites and setup
• Step-by-step walkthrough of the script's operations
• Explanation of key AWS CLI commands and parameters
• Best practices and considerations

To read a tutorial, open the corresponding markdown file in the same folder as the script.

Generating new scripts

You can use Amazon Q Developer CLI to generate new scripts based on:

1. Existing scripts: Use an existing script as a template
2. Documentation topics: Generate a script from AWS documentation

To adapt an existing script for your requirements, use a prompt such as the following.

q "Generate a script to set up IPAM for my VPC. Use the following script as an example: 009-vpc-ipam-gs.sh"

To generate a script and tutorial based on AWS Documentation content, see instra/README.md

Contributing

See CONTRIBUTING We welcome contributions to expand the collection of tutorials and scripts. To contribute:

Cleanup

All scripts include resource tracking and cleanup functionality. After provisioning and interacting with resources, the scripts provide a list of resources and ask if you want to clean them up. If a script encounters an issue, it attempts to clean up resources that it created before the error.

License

This project is licensed under the MIT-0 License. See the LICENSE file for details.