AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/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 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_sourceString

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

Returns:

  • (String)


8181
8182
8183
8184
8185
8186
8187
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8181

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

#maximum_execution_frequencyString

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.

Returns:

  • (String)


8181
8182
8183
8184
8185
8186
8187
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8181

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

#message_typeString

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.

Returns:

  • (String)


8181
8182
8183
8184
8185
8186
8187
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 8181

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