SourceDetail
Provides the source and the message types that trigger Amazon Config to evaluate your Amazon resources against a rule. It also
provides the frequency with which you want Amazon 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.
Contents
- EventSource
-
The source of the event, such as an Amazon service, that triggers Amazon Config to evaluate your Amazon resources.
Type: String
Valid Values:
aws.config
Required: No
- MaximumExecutionFrequency
-
The frequency at which you want Amazon Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for
MaximumExecutionFrequency
, thenMessageType
must use theScheduledNotification
value.Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequency
parameter.Based on the valid value you choose, Amazon Config runs evaluations once for each valid value. For example, if you choose
Three_Hours
, Amazon Config runs evaluations once every three hours. In this case,Three_Hours
is the frequency of this rule.Type: String
Valid Values:
One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours
Required: No
- MessageType
-
The type of notification that triggers Amazon Config to run an evaluation for a rule. You can specify the following notification types:
-
ConfigurationItemChangeNotification
- Triggers an evaluation when Amazon Config delivers a configuration item as a result of a resource change. -
OversizedConfigurationItemChangeNotification
- Triggers an evaluation when Amazon Config delivers an oversized configuration item. Amazon Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS. -
ScheduledNotification
- Triggers a periodic evaluation at the frequency specified forMaximumExecutionFrequency
. -
ConfigurationSnapshotDeliveryCompleted
- Triggers a periodic evaluation when Amazon Config delivers a configuration snapshot.
If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
ConfigurationItemChangeNotification
and one forOversizedConfigurationItemChangeNotification
.Type: String
Valid Values:
ConfigurationItemChangeNotification | ConfigurationSnapshotDeliveryCompleted | ScheduledNotification | OversizedConfigurationItemChangeNotification
Required: No
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: