Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

api-gw-xray-enabled

Checks if Amazon 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

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

Parameters:

Proactive Evaluation

For steps on how to run this rule in proactive mode, see Evaluating Your Resources with Amazon 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.

Amazon CloudFormation template

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