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

Class IotEventsPutMessageAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<IotEventsPutMessageAction>

Enclosing class:

IotEventsPutMessageAction

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

(experimental) A fluent builder for IotEventsPutMessageAction.

Method Summary

Modifier and Type	Method	Description
IotEventsPutMessageAction.Builder	batchMode(Boolean batchMode)	(experimental) Whether to process the event actions as a batch.
IotEventsPutMessageAction	build()
static IotEventsPutMessageAction.Builder	create(IInput input)
IotEventsPutMessageAction.Builder	messageId(String messageId)	(experimental) The ID of the message.
IotEventsPutMessageAction.Builder	role(IRole role)	(experimental) The IAM role that allows access to AWS service.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static IotEventsPutMessageAction.Builder create(IInput input)

Parameters:

input - The IoT Events input to put messages. This parameter is required.

Returns:

a new instance of IotEventsPutMessageAction.Builder.

role

@Stability(Experimental)
public IotEventsPutMessageAction.Builder role(IRole role)

(experimental) The IAM role that allows access to AWS service.

Default: a new role will be created

Parameters:

role - The IAM role that allows access to AWS service. This parameter is required.

Returns:

this

batchMode

@Stability(Experimental)
public IotEventsPutMessageAction.Builder batchMode(Boolean batchMode)

(experimental) 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.

Default: false

Parameters:

batchMode - Whether to process the event actions as a batch. This parameter is required.

Returns:

this

messageId

@Stability(Experimental)
public IotEventsPutMessageAction.Builder messageId(String messageId)

(experimental) 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.

Default: - none -- a new UUID value will be assigned

Parameters:

messageId - The ID of the message. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public IotEventsPutMessageAction build()

Specified by:

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

Returns:

a newly built instance of IotEventsPutMessageAction.