Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudWatchEvents.Types.InputTransformer

Description

Synopsis

Documentation

data InputTransformer Source #

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

See: newInputTransformer smart constructor.

Constructors

InputTransformer'

Fields

inputPathsMap :: Maybe (HashMap Text Text)
Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.
InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.
The keys cannot start with "Amazon Web Services."
inputTemplate :: Text
Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.
If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
- The placeholder cannot be used as an object key.
The following example shows the syntax for using InputPathsMap and InputTemplate.
```
 "InputTransformer":
```
```
{
```
```
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
```
```
"InputTemplate": "<instance> is in state <status>"
```
```
}
```
To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:
```
 "InputTransformer":
```
```
{
```
```
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
```
```
"InputTemplate": "<instance> is in state \"<status>\""
```
```
}
```
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:
```
 "InputTransformer":
```
```
{
```
```
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
```
```
"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'
```
```
}
```

Instances

Instances details

FromJSON InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods parseJSON :: Value -> Parser InputTransformer # parseJSONList :: Value -> Parser [InputTransformer] #
ToJSON InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods toJSON :: InputTransformer -> Value # toEncoding :: InputTransformer -> Encoding # toJSONList :: [InputTransformer] -> Value # toEncodingList :: [InputTransformer] -> Encoding #
Generic InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Associated Types type Rep InputTransformer :: Type -> Type # Methods from :: InputTransformer -> Rep InputTransformer x # to :: Rep InputTransformer x -> InputTransformer #
Read InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods readsPrec :: Int -> ReadS InputTransformer # readList :: ReadS [InputTransformer] # readPrec :: ReadPrec InputTransformer # readListPrec :: ReadPrec [InputTransformer] #
Show InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods showsPrec :: Int -> InputTransformer -> ShowS # show :: InputTransformer -> String # showList :: [InputTransformer] -> ShowS #
NFData InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods rnf :: InputTransformer -> () #
Eq InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods (==) :: InputTransformer -> InputTransformer -> Bool # (/=) :: InputTransformer -> InputTransformer -> Bool #
Hashable InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer Methods hashWithSalt :: Int -> InputTransformer -> Int # hash :: InputTransformer -> Int #
type Rep InputTransformer Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.InputTransformer type Rep InputTransformer = D1 ('MetaData "InputTransformer" "Amazonka.CloudWatchEvents.Types.InputTransformer" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "InputTransformer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "inputPathsMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "inputTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInputTransformer Source #

Arguments

:: Text	`$sel:inputTemplate:InputTransformer'`
-> InputTransformer

Create a value of InputTransformer 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:inputPathsMap:InputTransformer', inputTransformer_inputPathsMap - Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "Amazon Web Services."

$sel:inputTemplate:InputTransformer', inputTransformer_inputTemplate - Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

The placeholder cannot be used as an object key.

The following example shows the syntax for using InputPathsMap and InputTemplate.

 "InputTransformer":

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "<instance> is in state <status>"

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

 "InputTransformer":

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "<instance> is in state \"<status>\""

The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following example:

 "InputTransformer":

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in state \"<status>\""}'

inputTransformer_inputPathsMap :: Lens' InputTransformer (Maybe (HashMap Text Text)) Source #

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.