SourceDetailProperty Struct
Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule.
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 { aws_config as config } from 'aws-cdk-lib';
const sourceDetailProperty: config.CfnConfigRule.SourceDetailProperty = {
eventSource: 'eventSource',
messageType: 'messageType',
// the properties below are optional
maximumExecutionFrequency: 'maximumExecutionFrequency',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_config as config
source_detail_property = config.CfnConfigRule.SourceDetailProperty(
event_source="eventSource",
message_type="messageType",
# the properties below are optional
maximum_execution_frequency="maximumExecutionFrequency"
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Config;
var sourceDetailProperty = new SourceDetailProperty {
EventSource = "eventSource",
MessageType = "messageType",
// the properties below are optional
MaximumExecutionFrequency = "maximumExecutionFrequency"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sourceDetailProperty := &SourceDetailProperty{
EventSource: jsii.String("eventSource"),
MessageType: jsii.String("messageType"),
// the properties below are optional
MaximumExecutionFrequency: jsii.String("maximumExecutionFrequency"),
}
Properties
maximumExecutionFrequencyoptionalstringmaximum_execution_frequencyoptionalstrmaximumExecutionFrequencyoptionalStringMaximumExecutionFrequencyoptionalstringMaximumExecutionFrequencyoptional*string#notes
If you specify a value for MaximumExecutionFrequency , then MessageType must use the ScheduledNotification value.
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the
MaximumExecutionFrequencyparameter.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_Hoursis the frequency of this rule.
notes
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 for OversizedConfigurationItemChangeNotification .