Package software.amazon.awscdk.services.events

Interface RuleTargetInputProperties

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RuleTargetInputProperties.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-10T21:56:51.834Z")
@Stability(Stable)
public interface RuleTargetInputProperties
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.events.*;
 RuleTargetInputProperties ruleTargetInputProperties = RuleTargetInputProperties.builder()
         .input("input")
         .inputPath("inputPath")
         .inputPathsMap(Map.of(
                 "inputPathsMapKey", "inputPathsMap"))
         .inputTemplate("inputTemplate")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RuleTargetInputProperties.Builder	A builder for RuleTargetInputProperties
static final class	RuleTargetInputProperties.Jsii$Proxy	An implementation for RuleTargetInputProperties

Method Summary

Modifier and Type	Method	Description
static RuleTargetInputProperties.Builder	builder()
default String	getInput()	Literal input to the target service (must be valid JSON).
default String	getInputPath()	JsonPath to take input from the input event.
default Map<String,String>	getInputPathsMap()	Paths map to extract values from event and insert into inputTemplate.
default String	getInputTemplate()	Input template to insert paths map into.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInput

@Stability(Stable)
@Nullable
default String getInput()

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`.

getInputPath

@Stability(Stable)
@Nullable
default String getInputPath()

JsonPath to take input from the input event.

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

getInputPathsMap

@Stability(Stable)
@Nullable
default Map<String,String> getInputPathsMap()

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

Default: - No values extracted from event.

getInputTemplate

@Stability(Stable)
@Nullable
default String getInputTemplate()

Input template to insert paths map into.

Default: - None.

builder

@Stability(Stable)
static RuleTargetInputProperties.Builder builder()

Returns:

a RuleTargetInputProperties.Builder of RuleTargetInputProperties