class
Amazonite::EventBridge::InputTransformer
- Amazonite::EventBridge::InputTransformer
- Reference
- Object
Overview
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.
Included Modules
- JSON::Serializable
Defined in:
eventbridge/input_transformer.crConstructors
- .new(pull : JSON::PullParser)
- .new(input_template : String, input_paths_map : Hash(String, String) | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#hash(hasher)
See
Object#hash(hasher) -
#input_paths_map : Hash(String, String) | Nil
Map of JSON paths to be extracted from the event.
-
#input_paths_map=(input_paths_map : Hash(String, String) | Nil)
Map of JSON paths to be extracted from the event.
-
#input_template : String
Input template where you specify placeholders that will be filled with the values of the keys from
InputPathsMapto customize the data sent to the target. -
#input_template=(input_template : String)
Input template where you specify placeholders that will be filled with the values of the keys from
InputPathsMapto customize the data sent to the target. - #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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."
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."
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:
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.
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": " is in state "
}
To have the InputTemplate include quote marks within a JSON string, escape each quote marks
with a slash, as in the following example:
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": " is in state \"\""
}
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following
example:
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": ,"myStatus": " is in state \"\""}'
}
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:
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.
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": " is in state "
}
To have the InputTemplate include quote marks within a JSON string, escape each quote marks
with a slash, as in the following example:
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": " is in state \"\""
}
The InputTemplate can also be valid JSON with varibles in quotes or out, as in the following
example:
{
"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
"InputTemplate": '{"myInstance": ,"myStatus": " is in state \"\""}'
}