software.amazon.awssdk.services.cloudwatchevents.model

Class InputTransformer

java.lang.Object

software.amazon.awssdk.services.cloudwatchevents.model.InputTransformer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InputTransformer.Builder,InputTransformer>

@Generated(value="software.amazon.awssdk:codegen")
public final class InputTransformer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InputTransformer.Builder,InputTransformer>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputTransformer.Builder

Method Summary

Modifier and Type	Method and Description
static InputTransformer.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputPathsMap() Returns true if the InputPathsMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,String>	inputPathsMap() Map of JSON paths to be extracted from the event.
String	inputTemplate() 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.
List<SdkField<?>>	sdkFields()
static Class<? extends InputTransformer.Builder>	serializableBuilderClass()
InputTransformer.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasInputPathsMap

public boolean hasInputPathsMap()

Returns true if the InputPathsMap property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

inputPathsMap

public Map<String,String> inputPathsMap()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasInputPathsMap() to see if a value was sent in this field.

Returns:

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

inputTemplate

public String inputTemplate()

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": "<instance> is in state <status>"

}

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": "<instance> is in state \"<status>\""

}

Returns:

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": "<instance> is in state <status>"

}

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": "<instance> is in state \"<status>\""

}

toBuilder

public InputTransformer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InputTransformer.Builder,InputTransformer>

builder

public static InputTransformer.Builder builder()

serializableBuilderClass

public static Class<? extends InputTransformer.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo