Back to Checks
iac

SAM HTTP API stages for V1 and V2 should have access logging enabled

AWS-0116
Service: samSeverity: medium
OfficialBuilt-inVerified

API Gateway stages should have access log settings block configured to track all access to a particular stage. This should be applied to both v1 and v2 gateway stages.

Run this check with Prowler

Run in Prowler Cloud
Run
prowler iac --checks AWS-0116

Recommendation

Enable logging for API Gateway stages

Check Code

# METADATA
# title: SAM HTTP API stages for V1 and V2 should have access logging enabled
# description: |
#   API Gateway stages should have access log settings block configured to track all access to a particular stage. This should be applied to both v1 and v2 gateway stages.
# scope: package
# schemas:
#   - input: schema["cloud"]
# related_resources:
#   - https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-httpapi.html#sam-httpapi-accesslogsettings
# custom:
#   id: AWS-0116
#   long_id: aws-sam-enable-http-api-access-logging
#   aliases:
#     - AVD-AWS-0116
#     - enable-http-api-access-logging
#     - aws-sam-enable-http-api-access-logging
#   provider: aws
#   service: sam
#   severity: MEDIUM
#   recommended_action: Enable logging for API Gateway stages
#   input:
#     selector:
#       - type: cloud
#         subtypes:
#           - service: sam
#             provider: aws
#   examples: checks/cloud/aws/sam/enable_http_api_access_logging.yaml
package builtin.aws.sam.aws0116

import rego.v1

import data.lib.cloud.metadata
import data.lib.cloud.value

deny contains res if {
	some api in input.aws.sam.httpapis
	isManaged(api)
	without_logging(api)
	res := result.new(
		"Access logging is not configured.",
		metadata.obj_by_path(api, ["accesslogging", "cloudwatchloggrouparn"]),
	)
}

without_logging(api) if value.is_empty(api.accesslogging.cloudwatchloggrouparn)

without_logging(api) if not api.accesslogging.cloudwatchloggrouparn