From 388678f822b9658f8a705c510e080f1dd9d64491 Mon Sep 17 00:00:00 2001 From: Pepe Fagoaga Date: Mon, 16 Oct 2023 14:50:11 +0200 Subject: [PATCH] chore(docs): Add report.region criteria (#2930) --- docs/developer-guide/checks.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/developer-guide/checks.md b/docs/developer-guide/checks.md index c66bc425..affa6a1d 100644 --- a/docs/developer-guide/checks.md +++ b/docs/developer-guide/checks.md @@ -107,6 +107,13 @@ All the checks MUST fill the `report.status` and `report.status_extended` with t - MUST end in a dot `.` - MUST include the service audited with the resource and a brief explanation of the result generated, e.g.: `EC2 AMI ami-0123456789 is not public.` +### Check Region + +All the checks MUST fill the `report.region` with the following criteria: + +- If the audited resource is regional use the `region` attribute within the resource object. +- If the audited resource is global use the `service_client.region` within the service client object. + ### Resource ID, Name and ARN All the checks MUST fill the `report.resource_id` and `report.resource_arn` with the following criteria: