Amazon Config · Schema

AggregateComplianceByConfigRule

Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

AuditingComplianceConfiguration ManagementGovernanceSecurity

Properties

Name Type Description
ConfigRuleName object
Compliance object
AccountId object
AwsRegion object
View JSON Schema on GitHub

JSON Schema

config-aggregate-compliance-by-config-rule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-config/refs/heads/main/json-schema/config-aggregate-compliance-by-config-rule-schema.json",
  "title": "AggregateComplianceByConfigRule",
  "description": "<p>Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.</p> <p>A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.</p>",
  "type": "object",
  "properties": {
    "ConfigRuleName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigRuleName"
        },
        {
          "description": "The name of the Config rule."
        }
      ]
    },
    "Compliance": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Compliance"
        },
        {
          "description": "Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance."
        }
      ]
    },
    "AccountId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountId"
        },
        {
          "description": "The 12-digit account ID of the source account."
        }
      ]
    },
    "AwsRegion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsRegion"
        },
        {
          "description": "The source region from where the data is aggregated."
        }
      ]
    }
  }
}