Amazonka.Config.Types.SourceDetail

Documentation

data SourceDetail

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.

See: newSourceDetail smart constructor.

Constructors

SourceDetail'

Fields

• eventSource :: Maybe EventSource

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

• maximumExecutionFrequency :: Maybe 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.

• messageType :: Maybe 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.

Instances

FromJSON SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

parseJSON :: Value -> Parser SourceDetail

parseJSONList :: Value -> Parser [SourceDetail]

ToJSON SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

toJSON :: SourceDetail -> Value

toEncoding :: SourceDetail -> Encoding

toJSONList :: [SourceDetail] -> Value

toEncodingList :: [SourceDetail] -> Encoding

Generic SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Associated Types

type Rep SourceDetail :: Type -> Type

Methods

from :: SourceDetail -> Rep SourceDetail x

to :: Rep SourceDetail x -> SourceDetail

Read SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

readsPrec :: Int -> ReadS SourceDetail

readList :: ReadS [SourceDetail]

readPrec :: ReadPrec SourceDetail

readListPrec :: ReadPrec [SourceDetail]

Show SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

showsPrec :: Int -> SourceDetail -> ShowS

show :: SourceDetail -> String

showList :: [SourceDetail] -> ShowS

NFData SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

rnf :: SourceDetail -> ()

Eq SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

(==) :: SourceDetail -> SourceDetail -> Bool

(/=) :: SourceDetail -> SourceDetail -> Bool

Hashable SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

Methods

hashWithSalt :: Int -> SourceDetail -> Int

hash :: SourceDetail -> Int

type Rep SourceDetail

Defined in Amazonka.Config.Types.SourceDetail

type Rep SourceDetail = D1 ('MetaData "SourceDetail" "Amazonka.Config.Types.SourceDetail" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "SourceDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSource)) :*: (S1 ('MetaSel ('Just "maximumExecutionFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaximumExecutionFrequency)) :*: S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)))))

newSourceDetail :: SourceDetail

Create a value of SourceDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventSource:SourceDetail', sourceDetail_eventSource - The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

$sel:maximumExecutionFrequency:SourceDetail', sourceDetail_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.

$sel:messageType:SourceDetail', sourceDetail_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.

sourceDetail_eventSource :: Lens' SourceDetail (Maybe EventSource)

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

sourceDetail_maximumExecutionFrequency :: Lens' SourceDetail (Maybe 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.

sourceDetail_messageType :: Lens' SourceDetail (Maybe 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.