aws-cdk-lib.aws_events.CfnRule.InputTransformerProperty

InputTransformerProperty Struct

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.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_events as events } from 'aws-cdk-lib';
const inputTransformerProperty: events.CfnRule.InputTransformerProperty = {
  inputTemplate: 'inputTemplate',

  // the properties below are optional
  inputPathsMap: {
    inputPathsMapKey: 'inputPathsMap',
  },
};

Properties

inputPathsMapIResolvable | { [key: string]: string }input_paths_maptyping.Union[IResolvable, typing.Mapping[str, str]]inputPathsMapIResolvableInputPathsMapIResolvableInputPathsMapinterface{}#

Map of JSON paths to be extracted from the event.

notes

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

inputTemplatestringinput_templatestrinputTemplateStringInputTemplatestringInputTemplate*stringrequired#

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.

notes

Enclose each InputPathsMaps value in brackets: < value >

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>\""}'

}