Skip to content

/AWS1/CL_CFSSOURCEDETAIL

Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want 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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_eventsource TYPE /AWS1/CFSEVENTSOURCE /AWS1/CFSEVENTSOURCE

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

iv_messagetype TYPE /AWS1/CFSMESSAGETYPE /AWS1/CFSMESSAGETYPE

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. 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 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.

iv_maximumexecutionfrequency TYPE /AWS1/CFSMAXIMUMEXECFREQUENCY /AWS1/CFSMAXIMUMEXECFREQUENCY

The frequency at which you want 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.

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, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

Queryable Attributes

EventSource

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

Accessible with the following methods

Method Description
GET_EVENTSOURCE() Getter for EVENTSOURCE, with configurable default
ASK_EVENTSOURCE() Getter for EVENTSOURCE w/ exceptions if field has no value
HAS_EVENTSOURCE() Determine if EVENTSOURCE has a value

MessageType

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. 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 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.

Accessible with the following methods

Method Description
GET_MESSAGETYPE() Getter for MESSAGETYPE, with configurable default
ASK_MESSAGETYPE() Getter for MESSAGETYPE w/ exceptions if field has no value
HAS_MESSAGETYPE() Determine if MESSAGETYPE has a value

MaximumExecutionFrequency

The frequency at which you want 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.

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, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

Accessible with the following methods

Method Description
GET_MAXIMUMEXECFREQUENCY() Getter for MAXIMUMEXECUTIONFREQUENCY, with configurable defa
ASK_MAXIMUMEXECFREQUENCY() Getter for MAXIMUMEXECUTIONFREQUENCY w/ exceptions if field
HAS_MAXIMUMEXECFREQUENCY() Determine if MAXIMUMEXECUTIONFREQUENCY has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_SOURCEDETAILS

TYPES TT_SOURCEDETAILS TYPE STANDARD TABLE OF REF TO /AWS1/CL_CFSSOURCEDETAIL WITH DEFAULT KEY
.