Class: Aws::ConfigService::Types::SourceDetail

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::SourceDetail

Includes:

Structure

Defined in:

lib/aws-sdk-configservice/types.rb

Overview

Note:

When making an API call, you may pass SourceDetail data as a hash:

{
  event_source: "aws.config", # accepts aws.config
  message_type: "ConfigurationItemChangeNotification", # accepts ConfigurationItemChangeNotification, ConfigurationSnapshotDeliveryCompleted, ScheduledNotification, OversizedConfigurationItemChangeNotification
  maximum_execution_frequency: "One_Hour", # accepts One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours
}

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #event_source ⇒ String

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

• #maximum_execution_frequency ⇒ String

  The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger.

• #message_type ⇒ String

  The type of notification that triggers AWS Config to run an evaluation for a rule.

Instance Attribute Details

#event_source ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4022

class SourceDetail < Struct.new(
  :event_source,
  :message_type,
  :maximum_execution_frequency)
  include Aws::Structure
end

#maximum_execution_frequency ⇒ String

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

<note markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4022

class SourceDetail < Struct.new(
  :event_source,
  :message_type,
  :maximum_execution_frequency)
  include Aws::Structure
end

#message_type ⇒ String

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

• ‘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`.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4022

class SourceDetail < Struct.new(
  :event_source,
  :message_type,
  :maximum_execution_frequency)
  include Aws::Structure
end