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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb

Overview

Note:

When making an API call, you may pass InputTransformer data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#input_paths_mapHash<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 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 can't start with "AWS".

Returns:

  • (Hash<String,String>)


894
895
896
897
898
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 894

class InputTransformer < Struct.new(
  :input_paths_map,
  :input_template)
  include Aws::Structure
end

#input_templateString

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 can't be used as an object key

  • Object values can't 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:

"InputTransformer":

\{

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

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

\}

Returns:

  • (String)


894
895
896
897
898
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 894

class InputTransformer < Struct.new(
  :input_paths_map,
  :input_template)
  include Aws::Structure
end