Interface CfnConfigRule.SourceDetailProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConfigRule.SourceDetailProperty.Jsii$Proxy
- Enclosing class:
- CfnConfigRule
It also provides the frequency with which you want AWS 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.config.*; SourceDetailProperty sourceDetailProperty = SourceDetailProperty.builder() .eventSource("eventSource") .messageType("messageType") // the properties below are optional .maximumExecutionFrequency("maximumExecutionFrequency") .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnConfigRule.SourceDetailProperty
static final class
An implementation forCfnConfigRule.SourceDetailProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.default String
The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.The type of notification that triggers AWS Config to run an evaluation for a rule.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEventSource
The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. -
getMessageType
The type of notification that triggers AWS Config to run an evaluation for a rule.You can specify the following notification types:
ConfigurationItemChangeNotification
- Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.OversizedConfigurationItemChangeNotification
- Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS 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 AWS 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
. -
getMaximumExecutionFrequency
The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.If you specify a value for
MaximumExecutionFrequency
, thenMessageType
must use theScheduledNotification
value.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, AWS Config runs evaluations once for each valid value. For example, if you choose
Three_Hours
, AWS Config runs evaluations once every three hours. In this case,Three_Hours
is the frequency of this rule. -
builder
-