aws-cdk-lib.aws_events.RuleTargetInputProperties

RuleTargetInputProperties Struct

The input properties for an event target.

Source

aws-events/lib/input.ts

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 ruleTargetInputProperties: events.RuleTargetInputProperties = {
  input: 'input',
  inputPath: 'inputPath',
  inputPathsMap: {
    inputPathsMapKey: 'inputPathsMap',
  },
  inputTemplate: 'inputTemplate',
};

Properties

inputstringinputstrinputStringInputstringInput*string= input for the event target. If t…#

Literal input to the target service (must be valid JSON).

default

Default: input for the event target. If the input contains a paths map values wil be extracted from event and inserted into the inputTemplate.

inputPathstringinput_pathstrinputPathStringInputPathstringInputPath*string= None. The entire matched event i…#

JsonPath to take input from the input event.

default

Default: None. The entire matched event is passed as input

inputPathsMap{ [key: string]: string }input_paths_maptyping.Mapping[str, str]inputPathsMapMap<String, String>InputPathsMapIDictionary<string, string>InputPathsMap*map[string]*string= No values extracted from event.#

Paths map to extract values from event and insert into `inputTemplate`.

inputTemplatestringinput_templatestrinputTemplateStringInputTemplatestringInputTemplate*string= None.#

Input template to insert paths map into.