You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudWatchEvents::Types::InputTransformer

Inherits:

Struct

Object
Struct
Aws::CloudWatchEvents::Types::InputTransformer

show all

Defined in:: (unknown)

Overview

Note:

When passing InputTransformer as input to an Aws::Client method, you can use a vanilla Hash:

{
  input_paths_map: {
    "InputTransformerPathKey" => "TargetInputPath",
  },
  input_template: "TransformerInput", # required
}

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.

Returned by:

Target#input_transformer

Instance Attribute Summary collapse

#input_paths_map ⇒ Hash<String,String>
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 InputPathsMap to customize the data sent to the target.

Instance Attribute Details

#input_paths_map ⇒ `Hash<String,String>`

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 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with \"AWS.\"

Returns:

(Hash<String,String>) —
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 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.
Object values cannot include quote marks.

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: