README.md

Customize Well-Architected Reviews for DynamoDB

The AWS Well-Archtected Tool makes it easy to create custom lenses by providing a json template that you can use. The template outlines how the lens content must be defined, and it controls how the lens is presented within the AWS Well-Architected Tool. This repo contains the recommended DynamoDB custom lens json file which can be used to create a DynamoDB Custom Lens in Well-Architected console from json template with the following steps:

1. Prepare your custom lens Well-Architected template json file
2. Navigate to the AWS Well-Architected Tool on the AWS console and create custom lens
3. Publish your custom lens and attach a version tag
4. Review workloads using custom lenses

Prepare your custom lens Well-Architected template json file

Prepare your custom lens Well-Architected template json file or just download the provided recommended dynamodb custom lens file.

{
   "schemaVersion":"2022-11-01",
   "name":"DynamoDB Best Practice Lens",
   "description":"Best practices for optimization your DynamoDB",
   "pillars":[
        {
         "id":"DDBOPS",
         "name":"Operational Excellence",
         "questions":[
            {
               "id":"ddbops1",
               "title":"How do you backup DynamoDB tables?",
               "description":"With proper backup process, you will be able to prevent unexpected data lost.",
               "choices":[
                  {
                     "id":"ddbops1_1",
                     "title":"Use On-Demand Backup for DynamoDB tables",
                     "description":"Some helpful choice description",
                     "helpfulResource":{
                        "displayText":"A detail description or definition of this best practice, and give a clear scope of this best practice in pillar, also the impact of the risk.",
                        "url":"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html"
                     },
                     "improvementPlan":{
                        "displayText":"Enable On-Demand Backup",
                        "url":"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html"
                     }
                  },...
               ]
            },...
         ]
      }
   ]
}

Navigate to the AWS Well-Architected Tool on the AWS console and create custom lens

After you prepare your custom lens Well-Architected template json file, you can navigate to the AWS Well-Architected Tool on the AWS console and create custom lens.

Upload the your custom lens Well-Architected template json template, and submit it.

Publish your custom lens and attach a version tag

And then you will find your Well-Architected custom lens in draft version.

Publish your draft version and provide a version tag.

Review workloads using custom lenses

After your Well-Architected custom lens is published, you can define a workload in your AWS Well-Architected console.

Input your workload information, and select the Well-Architected custom lens you just published.

Choose Continue reviewing for the just published DynamoDB Well-Architected custom lens.

Now you can review your DynamoDB workload with DynamoDB Well-Architected Custom Lens.