interface RuleTargetInputProperties

Language	Type name
.NET	Amazon.CDK.AWS.Events.RuleTargetInputProperties
Java	software.amazon.awscdk.services.events.RuleTargetInputProperties
Python	aws_cdk.aws_events.RuleTargetInputProperties
TypeScript (source)	@aws-cdk/aws-events » RuleTargetInputProperties

Obtainable from RuleTargetInput.bind()

The input properties for an event target.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as events from '@aws-cdk/aws-events';
const ruleTargetInputProperties: events.RuleTargetInputProperties = {
  input: 'input',
  inputPath: 'inputPath',
  inputPathsMap: {
    inputPathsMapKey: 'inputPathsMap',
  },
  inputTemplate: 'inputTemplate',
};

Properties

Name	Type	Description
input?	string	Literal input to the target service (must be valid JSON).
inputPath?	string	JsonPath to take input from the input event.
inputPathsMap?	{ [string]: string }	Paths map to extract values from event and insert into inputTemplate.
inputTemplate?	string	Input template to insert paths map into.

---

input?

Type: string (optional, default: input for the event target. If the input contains a paths map values wil be extracted from event and inserted into the inputTemplate.)

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

---

inputPath?

Type: string (optional, default: None. The entire matched event is passed as input)

JsonPath to take input from the input event.

---

inputPathsMap?

Type: { [string]: string } (optional, default: No values extracted from event.)

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

---

inputTemplate?

Type: string (optional, default: None.)

Input template to insert paths map into.