File tree 1 file changed +7
-3
lines changed
packages/@aws-cdk/aws-events/lib 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -11,8 +11,12 @@ export abstract class RuleTargetInput {
11
11
/**
12
12
* Pass text to the event target
13
13
*
14
- * May contain strings returned by EventField.from() to substitute in parts of the
14
+ * May contain strings returned by ` EventField.from()` to substitute in parts of the
15
15
* matched event.
16
+ *
17
+ * The Rule Target input value will be a single string: the string you pass
18
+ * here. Do not use this method to pass a complex value like a JSON object to
19
+ * a Rule Target. Use `RuleTargetInput.fromObject()` instead.
16
20
*/
17
21
public static fromText ( text : string ) : RuleTargetInput {
18
22
return new FieldAwareEventInput ( text , InputType . Text ) ;
@@ -24,7 +28,7 @@ export abstract class RuleTargetInput {
24
28
* This is only useful when passing to a target that does not
25
29
* take a single argument.
26
30
*
27
- * May contain strings returned by EventField.from() to substitute in parts
31
+ * May contain strings returned by ` EventField.from()` to substitute in parts
28
32
* of the matched event.
29
33
*/
30
34
public static fromMultilineText ( text : string ) : RuleTargetInput {
@@ -34,7 +38,7 @@ export abstract class RuleTargetInput {
34
38
/**
35
39
* Pass a JSON object to the event target
36
40
*
37
- * May contain strings returned by EventField.from() to substitute in parts of the
41
+ * May contain strings returned by ` EventField.from()` to substitute in parts of the
38
42
* matched event.
39
43
*/
40
44
public static fromObject ( obj : any ) : RuleTargetInput {
You can’t perform that action at this time.
0 commit comments