Skip to content
v2.278.0

RuleTargetInputProperties Struct ​

The input properties for an event target.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_events as events

rule_target_input_properties = events.RuleTargetInputProperties(
    input="input",
    input_path="inputPath",
    input_paths_map={
        "input_paths_map_key": "inputPathsMap"
    },
    input_template="inputTemplate"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.events.*;

RuleTargetInputProperties ruleTargetInputProperties = RuleTargetInputProperties.builder()
        .input("input")
        .inputPath("inputPath")
        .inputPathsMap(Map.of(
                "inputPathsMapKey", "inputPathsMap"))
        .inputTemplate("inputTemplate")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;

var ruleTargetInputProperties = new RuleTargetInputProperties {
    Input = "input",
    InputPath = "inputPath",
    InputPathsMap = new Dictionary<string, string> {
        { "inputPathsMapKey", "inputPathsMap" }
    },
    InputTemplate = "inputTemplate"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

ruleTargetInputProperties := &RuleTargetInputProperties{
	Input: jsii.String("input"),
	InputPath: jsii.String("inputPath"),
	InputPathsMap: map[string]*string{
		"inputPathsMapKey": jsii.String("inputPathsMap"),
	},
	InputTemplate: jsii.String("inputTemplate"),
}

Properties ​

inputoptionalstringinputoptionalstrinputoptionalStringInputoptionalstringInputoptional*string #
Literal input to the target service (must be valid JSON).

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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string #
JsonPath to take input from the input event.

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

inputPathsMapoptional{ [key: string]: string }input_paths_mapoptionaltyping.Mapping[str, str]inputPathsMapoptionalMap<String, String>InputPathsMapoptionalIDictionary<string, string>InputPathsMapoptional*map[string]*string #
Paths map to extract values from event and insert into `inputTemplate`.

Default: No values extracted from event.

inputTemplateoptionalstringinput_templateoptionalstrinputTemplateoptionalStringInputTemplateoptionalstringInputTemplateoptional*string = None. #
Input template to insert paths map into.