api-gw-xray-enabled - AWS Config

api-gw-xray-enabled

Checks if AWS X-Ray tracing is enabled on Amazon API Gateway REST APIs. The rule is COMPLIANT if X-Ray tracing is enabled and NON_COMPLIANT otherwise.

Identifier: API_GW_XRAY_ENABLED

Resource Types: AWS::ApiGateway::Stage

Trigger type: Configuration changes

AWS Region: All supported AWS regions except Asia Pacific (Jakarta), Asia Pacific (Hyderabad), Asia Pacific (Osaka), Canada West (Calgary), Europe (Spain) Region

Parameters:

None

Proactive Evaluation

For steps on how to run this rule in proactive mode, see Evaluating Your Resources with AWS Config Rules. For this rule to return COMPLIANT in proactive mode, the resource configuration schema for the StartResourceEvaluation API needs to include the following inputs, encoded as a string:

"ResourceConfiguration": ... { "TracingEnabled": BOOLEAN, "RestApiId": "my-rest-api-Id", } ...

For more information on proactive evaluation, see Evaluation Mode.

AWS CloudFormation template

To create AWS Config managed rules with AWS CloudFormation templates, see Creating AWS Config Managed Rules With AWS CloudFormation Templates.