AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::EventBridge::Model::InputTransformer Class Reference

#include <InputTransformer.h>

Public Member Functions

 InputTransformer ()
 
 InputTransformer (Aws::Utils::Json::JsonView jsonValue)
 
InputTransformeroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::Map< Aws::String, Aws::String > & GetInputPathsMap () const
 
bool InputPathsMapHasBeenSet () const
 
void SetInputPathsMap (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetInputPathsMap (Aws::Map< Aws::String, Aws::String > &&value)
 
InputTransformerWithInputPathsMap (const Aws::Map< Aws::String, Aws::String > &value)
 
InputTransformerWithInputPathsMap (Aws::Map< Aws::String, Aws::String > &&value)
 
InputTransformerAddInputPathsMap (const Aws::String &key, const Aws::String &value)
 
InputTransformerAddInputPathsMap (Aws::String &&key, const Aws::String &value)
 
InputTransformerAddInputPathsMap (const Aws::String &key, Aws::String &&value)
 
InputTransformerAddInputPathsMap (Aws::String &&key, Aws::String &&value)
 
InputTransformerAddInputPathsMap (const char *key, Aws::String &&value)
 
InputTransformerAddInputPathsMap (Aws::String &&key, const char *value)
 
InputTransformerAddInputPathsMap (const char *key, const char *value)
 
const Aws::StringGetInputTemplate () const
 
bool InputTemplateHasBeenSet () const
 
void SetInputTemplate (const Aws::String &value)
 
void SetInputTemplate (Aws::String &&value)
 
void SetInputTemplate (const char *value)
 
InputTransformerWithInputTemplate (const Aws::String &value)
 
InputTransformerWithInputTemplate (Aws::String &&value)
 
InputTransformerWithInputTemplate (const char *value)
 

Detailed Description

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

See Also:

AWS API Reference

Definition at line 34 of file InputTransformer.h.

Constructor & Destructor Documentation

◆ InputTransformer() [1/2]

Aws::EventBridge::Model::InputTransformer::InputTransformer ( )

◆ InputTransformer() [2/2]

Aws::EventBridge::Model::InputTransformer::InputTransformer ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddInputPathsMap() [1/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( const Aws::String key,
const Aws::String value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 111 of file InputTransformer.h.

◆ AddInputPathsMap() [2/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( Aws::String &&  key,
const Aws::String value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 121 of file InputTransformer.h.

◆ AddInputPathsMap() [3/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( const Aws::String key,
Aws::String &&  value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 131 of file InputTransformer.h.

◆ AddInputPathsMap() [4/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 141 of file InputTransformer.h.

◆ AddInputPathsMap() [5/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( const char *  key,
Aws::String &&  value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 151 of file InputTransformer.h.

◆ AddInputPathsMap() [6/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( Aws::String &&  key,
const char *  value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 161 of file InputTransformer.h.

◆ AddInputPathsMap() [7/7]

InputTransformer& Aws::EventBridge::Model::InputTransformer::AddInputPathsMap ( const char *  key,
const char *  value 
)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 171 of file InputTransformer.h.

◆ GetInputPathsMap()

const Aws::Map<Aws::String, Aws::String>& Aws::EventBridge::Model::InputTransformer::GetInputPathsMap ( ) const
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 51 of file InputTransformer.h.

◆ GetInputTemplate()

const Aws::String& Aws::EventBridge::Model::InputTransformer::GetInputTemplate ( ) const
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 195 of file InputTransformer.h.

◆ InputPathsMapHasBeenSet()

bool Aws::EventBridge::Model::InputTransformer::InputPathsMapHasBeenSet ( ) const
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 61 of file InputTransformer.h.

◆ InputTemplateHasBeenSet()

bool Aws::EventBridge::Model::InputTransformer::InputTemplateHasBeenSet ( ) const
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 218 of file InputTransformer.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::EventBridge::Model::InputTransformer::Jsonize ( ) const

◆ operator=()

InputTransformer& Aws::EventBridge::Model::InputTransformer::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetInputPathsMap() [1/2]

void Aws::EventBridge::Model::InputTransformer::SetInputPathsMap ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 71 of file InputTransformer.h.

◆ SetInputPathsMap() [2/2]

void Aws::EventBridge::Model::InputTransformer::SetInputPathsMap ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 81 of file InputTransformer.h.

◆ SetInputTemplate() [1/3]

void Aws::EventBridge::Model::InputTransformer::SetInputTemplate ( const Aws::String value)
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 241 of file InputTransformer.h.

◆ SetInputTemplate() [2/3]

void Aws::EventBridge::Model::InputTransformer::SetInputTemplate ( Aws::String &&  value)
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 264 of file InputTransformer.h.

◆ SetInputTemplate() [3/3]

void Aws::EventBridge::Model::InputTransformer::SetInputTemplate ( const char *  value)
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 287 of file InputTransformer.h.

◆ WithInputPathsMap() [1/2]

InputTransformer& Aws::EventBridge::Model::InputTransformer::WithInputPathsMap ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 91 of file InputTransformer.h.

◆ WithInputPathsMap() [2/2]

InputTransformer& Aws::EventBridge::Model::InputTransformer::WithInputPathsMap ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output you want to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys cannot start with "AWS."

Definition at line 101 of file InputTransformer.h.

◆ WithInputTemplate() [1/3]

InputTransformer& Aws::EventBridge::Model::InputTransformer::WithInputTemplate ( const Aws::String value)
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 310 of file InputTransformer.h.

◆ WithInputTemplate() [2/3]

InputTransformer& Aws::EventBridge::Model::InputTransformer::WithInputTemplate ( Aws::String &&  value)
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 333 of file InputTransformer.h.

◆ WithInputTemplate() [3/3]

InputTransformer& Aws::EventBridge::Model::InputTransformer::WithInputTemplate ( const char *  value)
inline

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value> The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder cannot be used as an object key.

  • Object values cannot include quote marks.

The following example shows the syntax for using InputPathsMap and InputTemplate.

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state &lt;status&gt;"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

"InputTransformer":

{

"InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},

"InputTemplate": "&lt;instance&gt; is in state \"<status>""

}

Definition at line 356 of file InputTransformer.h.


The documentation for this class was generated from the following file: