software.amazon.awscdk.services.iot.actions.alpha

Class IotEventsPutMessageActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.iot.actions.alpha.IotEventsPutMessageActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<IotEventsPutMessageActionProps>

Enclosing interface:

IotEventsPutMessageActionProps

@Stability(value=Experimental)
public static final class IotEventsPutMessageActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<IotEventsPutMessageActionProps>

A builder for IotEventsPutMessageActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
IotEventsPutMessageActionProps.Builder	batchMode(Boolean batchMode) Sets the value of IotEventsPutMessageActionProps.getBatchMode()
IotEventsPutMessageActionProps	build() Builds the configured instance.
IotEventsPutMessageActionProps.Builder	messageId(String messageId) Sets the value of IotEventsPutMessageActionProps.getMessageId()
IotEventsPutMessageActionProps.Builder	role(IRole role) Sets the value of CommonActionProps.getRole()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

batchMode

@Stability(value=Experimental)
public IotEventsPutMessageActionProps.Builder batchMode(Boolean batchMode)

Sets the value of IotEventsPutMessageActionProps.getBatchMode()

Parameters:

batchMode - Whether to process the event actions as a batch. When batchMode is true, you can't specify a messageId.

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage. The resulting array can't have more than 10 messages.

Returns:

this

messageId

@Stability(value=Experimental)
public IotEventsPutMessageActionProps.Builder messageId(String messageId)

Sets the value of IotEventsPutMessageActionProps.getMessageId()

Parameters:

messageId - The ID of the message. When batchMode is true, you can't specify a messageId--a new UUID value will be assigned. Assign a value to this property to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

Returns:

this

role

@Stability(value=Experimental)
public IotEventsPutMessageActionProps.Builder role(IRole role)

Sets the value of CommonActionProps.getRole()

Parameters:

role - The IAM role that allows access to AWS service.

Returns:

this

build

@Stability(value=Experimental)
public IotEventsPutMessageActionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<IotEventsPutMessageActionProps>

Returns:

a new instance of IotEventsPutMessageActionProps

Throws:

NullPointerException - if any required attribute was not provided