RuleTargetInputProperties
- class aws_cdk.aws_events.RuleTargetInputProperties(*, input=None, input_path=None, input_paths_map=None, input_template=None)
Bases:
object
The input properties for an event target.
- Parameters:
input (
Optional
[str
]) – 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 theinputTemplate
.input_path (
Optional
[str
]) – JsonPath to take input from the input event. Default: - None. The entire matched event is passed as inputinput_paths_map (
Optional
[Mapping
[str
,str
]]) – Paths map to extract values from event and insert intoinputTemplate
. Default: - No values extracted from event.input_template (
Optional
[str
]) – Input template to insert paths map into. Default: - None.
- ExampleMetadata:
fixture=_generated
Example:
# 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" )
Attributes
- input
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
.
- input_path
JsonPath to take input from the input event.
- Default:
None. The entire matched event is passed as input
- input_paths_map
Paths map to extract values from event and insert into
inputTemplate
.- Default:
No values extracted from event.
- input_template
Input template to insert paths map into.
- Default:
None.