Skip to content

Single cross service level README template

Jump to bottom
Liz Kellebrew-Davies edited this page Aug 10, 2022 · 17 revisions

[Example](link to example) <-- Delete this sentence from template

[Title of example, in imperative form]

Overview

High-level description of the real-world use case that this example addresses. <-- Delete this sentence from template

⚠️ Important

  • Running this code might result in charges to your AWS account.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Prerequisites

List prerequisites. <-- Delete this sentence from template

Create the resources

Writer can choose to use the CDK, console, or an SDK for their example. This section should be comprehensive and include every step. If using the console, images are helpful. <-- Delete this sentence from template

Build the code

Varies by language, and clearly illustrates the workflow of building the app. Should include descriptions of code not included as code comments in actual examples. <-- Delete this sentence from template

Delete the resources

This section should walk the user step-by-step through deleting the resources using the CDK. Or, if they created the resources manually, provide a reminder to delete them. <-- Delete this sentence from template

To avoid charges, delete all the resources that you created for this tutorial.

If you created your resources through the AWS Management Console, or modified them by running the app, you must use the console to delete them.

If you created your resources using AWS CloudFormation, you can delete them by deleting the stack. For more information, see Deleting a stack on the AWS CloudFormation console.

Note: By running the app, you modified the table and the bucket, so you must delete these resources manually through the console before you can delete the stack.

Next steps

Congratulations! You have [description of what example achieves].

[Describe other potential use cases for the skills they learned.] <-- Delete this sentence from template

Additional resources

  • [Cross-service examples](link to cross-service level README for the language)
  • [Relevant service developer guide(s)](link to developer guide(s))
  • [Relevant service API reference guide(s)](link to developer guide(s))
  • [Relevant SDK API reference guide](link to API reference guide(s))
Clone this wiki locally