API Gateway has no X-Ray active

ID

aws_api_gateway_x_ray

Severity

low

Remediation Complexity

auto_fix

Remediation Risk

low

Remediation Effort

low

Vendor

AWS

Resource

Logging

Tags

ASVS50:v16.2.1, ASVS50:v16.3.1, non-reachable

Description

API Gateway has no X-Ray active. Traces will not be collected for this api gateway, which can impede incident management.

To fix it, you must configure tracing_enabled=true.

Learn more about this topic at AWS Enabling X-Ray.

Examples

---
- name: Example playbook
  hosts: localhost
  tasks:
    - name: API definition
      community.aws.api_gateway:
        swagger_file: my_api.yml
        stage: production
        cache_enabled: true
        cache_size: '1.6'
        endpoint_type: PRIVATE
        state: present

Mitigation / Fix

---
- name: Example playbook
  hosts: localhost
  tasks:
    - name: API definition
      community.aws.api_gateway:
        swagger_file: my_api.yml
        stage: production
        cache_enabled: true
        cache_size: '1.6'
        tracing_enabled: true
        endpoint_type: PRIVATE
        state: present