software.amazon.awscdk.services.iotevents

Interface InputProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InputProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:10.554Z")
 @Stability(value=Experimental)
public interface InputProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for defining an AWS IoT Events input.

Example:

 import software.amazon.awscdk.core.*;
 Input.Builder.create(this, "MyInput")
         .inputName("my_input")
         .attributeJsonPaths(List.of("payload.temperature"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static InputProps.Builder	builder()
List<String>	getAttributeJsonPaths() (experimental) An expression that specifies an attribute-value pair in a JSON structure.
default String	getInputName() (experimental) The name of the input.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttributeJsonPaths

@Stability(value=Experimental)
 @NotNull
List<String> getAttributeJsonPaths()

(experimental) An expression that specifies an attribute-value pair in a JSON structure.

Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to AWS IoT Events (BatchPutMessage). Each such message contains a JSON payload. The attribute (and its paired value) specified here are available for use in the condition expressions used by detectors.

getInputName

@Stability(value=Experimental)
 @Nullable
default String getInputName()

(experimental) The name of the input.

Default: - CloudFormation will generate a unique name of the input

builder

@Stability(value=Experimental)
static InputProps.Builder builder()

Returns:

a InputProps.Builder of InputProps