aws-cdk-lib.aws_events.RuleTargetInputProperties

interface RuleTargetInputProperties

LanguageType name
.NETAmazon.CDK.AWS.Events.RuleTargetInputProperties
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#RuleTargetInputProperties
Javasoftware.amazon.awscdk.services.events.RuleTargetInputProperties
Pythonaws_cdk.aws_events.RuleTargetInputProperties
TypeScript (source)aws-cdk-lib » aws_events » RuleTargetInputProperties

Obtainable from RuleTargetInput.bind(), LogGroupTargetInput.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 { aws_events as events } from 'aws-cdk-lib';
const ruleTargetInputProperties: events.RuleTargetInputProperties = {
  input: 'input',
  inputPath: 'inputPath',
  inputPathsMap: {
    inputPathsMapKey: 'inputPathsMap',
  },
  inputTemplate: 'inputTemplate',
};

Properties

NameTypeDescription
input?stringLiteral input to the target service (must be valid JSON).
inputPath?stringJsonPath to take input from the input event.
inputPathsMap?{ [string]: string }Paths map to extract values from event and insert into inputTemplate.
inputTemplate?stringInput 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.