« blib/lib/Paws/CloudWatchEvents/HttpParameters.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/KinesisParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchEvents::InputTransformer; | ||
| 3 | use Moose; | ||
| 4 | has InputPathsMap => (is => 'ro', isa => 'Paws::CloudWatchEvents::TransformerPaths'); | ||
| 5 | has InputTemplate => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::CloudWatchEvents::InputTransformer | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::CloudWatchEvents::InputTransformer object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { InputPathsMap => $value, ..., InputTemplate => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::InputTransformer object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->InputPathsMap | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Contains the parameters needed for you to provide custom input to a | ||
| 38 | target based on one or more pieces of data extracted from the event. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 InputPathsMap => L<Paws::CloudWatchEvents::TransformerPaths> | ||
| 44 | |||
| 45 | Map of JSON paths to be extracted from the event. You can then insert | ||
| 46 | these in the template in C<InputTemplate> to produce the output you | ||
| 47 | want to be sent to the target. | ||
| 48 | |||
| 49 | C<InputPathsMap> is an array key-value pairs, where each value is a | ||
| 50 | valid JSON path. You can have as many as 100 key-value pairs. You must | ||
| 51 | use JSON dot notation, not bracket notation. | ||
| 52 | |||
| 53 | The keys cannot start with "AWS." | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> InputTemplate => Str | ||
| 57 | |||
| 58 | Input template where you specify placeholders that will be filled with | ||
| 59 | the values of the keys from C<InputPathsMap> to customize the data sent | ||
| 60 | to the target. Enclose each C<InputPathsMaps> value in brackets: | ||
| 61 | E<lt>I<value>E<gt> The InputTemplate must be valid JSON. | ||
| 62 | |||
| 63 | If C<InputTemplate> is a JSON object (surrounded by curly braces), the | ||
| 64 | following restrictions apply: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | The placeholder cannot be used as an object key. | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | The following example shows the syntax for using C<InputPathsMap> and | ||
| 75 | C<InputTemplate>. | ||
| 76 | |||
| 77 | C<"InputTransformer":> | ||
| 78 | |||
| 79 | C<{> | ||
| 80 | |||
| 81 | C<"InputPathsMap": {"instance": "$.detail.instance","status": | ||
| 82 | "$.detail.status"},> | ||
| 83 | |||
| 84 | C<"InputTemplate": "E<lt>instanceE<gt> is in state E<lt>statusE<gt>"> | ||
| 85 | |||
| 86 | C<}> | ||
| 87 | |||
| 88 | To have the C<InputTemplate> include quote marks within a JSON string, | ||
| 89 | escape each quote marks with a slash, as in the following example: | ||
| 90 | |||
| 91 | C<"InputTransformer":> | ||
| 92 | |||
| 93 | C<{> | ||
| 94 | |||
| 95 | C<"InputPathsMap": {"instance": "$.detail.instance","status": | ||
| 96 | "$.detail.status"},> | ||
| 97 | |||
| 98 | C<"InputTemplate": "E<lt>instanceE<gt> is in state | ||
| 99 | \"E<lt>statusE<gt>\""> | ||
| 100 | |||
| 101 | C<}> | ||
| 102 | |||
| 103 | The C<InputTemplate> can also be valid JSON with varibles in quotes or | ||
| 104 | out, as in the following example: | ||
| 105 | |||
| 106 | C<"InputTransformer":> | ||
| 107 | |||
| 108 | C<{> | ||
| 109 | |||
| 110 | C<"InputPathsMap": {"instance": "$.detail.instance","status": | ||
| 111 | "$.detail.status"},> | ||
| 112 | |||
| 113 | C<"InputTemplate": '{"myInstance": E<lt>instanceE<gt>,"myStatus": | ||
| 114 | "E<lt>instanceE<gt> is in state \"E<lt>statusE<gt>\""}'> | ||
| 115 | |||
| 116 | C<}> | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |