AWS::Config::ConfigRule SourceDetail - Amazon CloudFormation
SyntaxProperties
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).

AWS::Config::ConfigRule 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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "EventSource" : String,
  "MaximumExecutionFrequency" : String,
  "MessageType" : String
}

YAML

  EventSource: String
  MaximumExecutionFrequency: String
  MessageType: String

Properties

EventSource

The source of the event, such as an Amazon service, that triggers Amazon Config to evaluate your Amazon resources.

Required: Yes

Type: String

Allowed values: aws.config

Update requires: No interruption

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, then MessageType must use the ScheduledNotification 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.

Required: No

Type: String

Allowed values: One_Hour | Three_Hours | Six_Hours | Twelve_Hours | TwentyFour_Hours

Update requires: No interruption

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 for MaximumExecutionFrequency.

  • 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 for OversizedConfigurationItemChangeNotification.

Required: Yes

Type: String

Allowed values: ConfigurationItemChangeNotification | ConfigurationSnapshotDeliveryCompleted | ScheduledNotification | OversizedConfigurationItemChangeNotification

Update requires: No interruption