Amazon Config · JSON Structure

Config Source Detail Structure

Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

Type: object Properties: 3
AuditingComplianceConfiguration ManagementGovernanceSecurity

SourceDetail is a JSON Structure definition published by Amazon Config, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

EventSource MessageType MaximumExecutionFrequency

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-config/refs/heads/main/json-structure/config-source-detail-structure.json",
  "name": "SourceDetail",
  "description": "Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for <code>SourceDetail</code> only for custom rules. ",
  "type": "object",
  "properties": {
    "EventSource": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EventSource"
        },
        {
          "description": "The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources."
        }
      ]
    },
    "MessageType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MessageType"
        },
        {
          "description": "<p>The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:</p> <ul> <li> <p> <code>ConfigurationItemChangeNotification</code> - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.</p> </li> <li> <p> <code>OversizedConfigurationItemChangeNotification</code> - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.</p> </li> <li> <p> <code>ScheduledNotification</code> - Triggers a periodic evaluation at the frequency specified for <code>MaximumExecutionFrequency</code>.</p> </li> <li> <p> <code>ConfigurationSnapshotDeliveryCompleted</code> - Triggers a periodic evaluation when Config delivers a configuration snapshot.</p> </li> </ul> <p>If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for <code>ConfigurationItemChangeNotification</code> and one for <code>OversizedConfigurationItemChangeNotification</code>.</p>"
        }
      ]
    },
    "MaximumExecutionFrequency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaximumExecutionFrequency"
        },
        {
          "description": "<p>The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for <code>MaximumExecutionFrequency</code>, then <code>MessageType</code> must use the <code>ScheduledNotification</code> value.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> <p>Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose <code>Three_Hours</code>, Config runs evaluations once every three hours. In this case, <code>Three_Hours</code> is the frequency of this rule. </p> </note>"
        }
      ]
    }
  }
}