Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Config.Types.SourceDetail

Description

Documentation

data SourceDetail Source #

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

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.
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.
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.

Instances

Instances details

Eq SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods (==) :: SourceDetail -> SourceDetail -> Bool # (/=) :: SourceDetail -> SourceDetail -> Bool #
Read SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods readsPrec :: Int -> ReadS SourceDetail # readList :: ReadS [SourceDetail] # readPrec :: ReadPrec SourceDetail # readListPrec :: ReadPrec [SourceDetail] #
Show SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods showsPrec :: Int -> SourceDetail -> ShowS # show :: SourceDetail -> String # showList :: [SourceDetail] -> ShowS #
Generic SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Associated Types type Rep SourceDetail :: Type -> Type # Methods from :: SourceDetail -> Rep SourceDetail x # to :: Rep SourceDetail x -> SourceDetail #
NFData SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods rnf :: SourceDetail -> () #
Hashable SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods hashWithSalt :: Int -> SourceDetail -> Int # hash :: SourceDetail -> Int #
ToJSON SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods toJSON :: SourceDetail -> Value # toEncoding :: SourceDetail -> Encoding # toJSONList :: [SourceDetail] -> Value # toEncodingList :: [SourceDetail] -> Encoding #
FromJSON SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail Methods parseJSON :: Value -> Parser SourceDetail # parseJSONList :: Value -> Parser [SourceDetail] #
type Rep SourceDetail Source #
Instance details Defined in Amazonka.Config.Types.SourceDetail type Rep SourceDetail = D1 ('MetaData "SourceDetail" "Amazonka.Config.Types.SourceDetail" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "SourceDetail'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageType)) :: (S1 ('MetaSel ('Just "maximumExecutionFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaximumExecutionFrequency)) :: S1 ('MetaSel ('Just "eventSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventSource)))))

newSourceDetail :: SourceDetail Source #

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: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.

$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: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.

sourceDetail_messageType :: Lens' SourceDetail (Maybe MessageType) Source #

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_maximumExecutionFrequency :: Lens' SourceDetail (Maybe MaximumExecutionFrequency) Source #

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_eventSource :: Lens' SourceDetail (Maybe EventSource) Source #

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