Interface CfnConfigRule.ISourceDetailProperty
Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule.
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISourceDetailProperty
Syntax (vb)
Public Interface ISourceDetailProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// 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"
};
Synopsis
Properties
EventSource | The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources. |
MaximumExecutionFrequency | The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. |
MessageType | The type of notification that triggers AWS Config to run an evaluation for a rule. |
Properties
EventSource
The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
string EventSource { get; }
Property Value
System.String
Remarks
MaximumExecutionFrequency
The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.
virtual string MaximumExecutionFrequency { get; }
Property Value
System.String
Remarks
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 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.
MessageType
The type of notification that triggers AWS Config to run an evaluation for a rule.
string MessageType { get; }
Property Value
System.String
Remarks
You can specify the following notification types:
If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification
and one for OversizedConfigurationItemChangeNotification
.