Package software.amazon.awscdk.services.iotevents

Class CfnDetectorModel.Builder

java.lang.Object

software.amazon.awscdk.services.iotevents.CfnDetectorModel.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDetectorModel>

Enclosing class:

CfnDetectorModel

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

A fluent builder for CfnDetectorModel.

Method Summary

Modifier and Type	Method	Description
CfnDetectorModel	build()
static CfnDetectorModel.Builder	create(software.constructs.Construct scope, String id)
CfnDetectorModel.Builder	detectorModelDefinition(IResolvable detectorModelDefinition)	Information that defines how a detector operates.
CfnDetectorModel.Builder	detectorModelDefinition(CfnDetectorModel.DetectorModelDefinitionProperty detectorModelDefinition)	Information that defines how a detector operates.
CfnDetectorModel.Builder	detectorModelDescription(String detectorModelDescription)	A brief description of the detector model.
CfnDetectorModel.Builder	detectorModelName(String detectorModelName)	The name of the detector model.
CfnDetectorModel.Builder	evaluationMethod(String evaluationMethod)	Information about the order in which events are evaluated and how actions are executed.
CfnDetectorModel.Builder	key(String key)	The value used to identify a detector instance.
CfnDetectorModel.Builder	roleArn(String roleArn)	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
CfnDetectorModel.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnDetectorModel.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDetectorModel.Builder.

detectorModelDefinition

@Stability(Stable)
public CfnDetectorModel.Builder detectorModelDefinition(IResolvable detectorModelDefinition)

Information that defines how a detector operates.

Parameters:

detectorModelDefinition - Information that defines how a detector operates. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition

detectorModelDefinition

@Stability(Stable)
public CfnDetectorModel.Builder detectorModelDefinition(CfnDetectorModel.DetectorModelDefinitionProperty detectorModelDefinition)

Information that defines how a detector operates.

Parameters:

detectorModelDefinition - Information that defines how a detector operates. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldefinition

roleArn

@Stability(Stable)
public CfnDetectorModel.Builder roleArn(String roleArn)

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

Parameters:

roleArn - The ARN of the role that grants permission to AWS IoT Events to perform its operations. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-rolearn

detectorModelDescription

@Stability(Stable)
public CfnDetectorModel.Builder detectorModelDescription(String detectorModelDescription)

A brief description of the detector model.

Parameters:

detectorModelDescription - A brief description of the detector model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodeldescription

detectorModelName

@Stability(Stable)
public CfnDetectorModel.Builder detectorModelName(String detectorModelName)

The name of the detector model.

Parameters:

detectorModelName - The name of the detector model. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-detectormodelname

evaluationMethod

@Stability(Stable)
public CfnDetectorModel.Builder evaluationMethod(String evaluationMethod)

Information about the order in which events are evaluated and how actions are executed.

Parameters:

evaluationMethod - Information about the order in which events are evaluated and how actions are executed. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-evaluationmethod

key

@Stability(Stable)
public CfnDetectorModel.Builder key(String key)

The value used to identify a detector instance.

When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the same attribute-value.

Parameters:

key - The value used to identify a detector instance. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-key

tags

@Stability(Stable)
public CfnDetectorModel.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-detectormodel.html#cfn-iotevents-detectormodel-tags

build

@Stability(Stable)
public CfnDetectorModel build()

Specified by:

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

Returns:

a newly built instance of CfnDetectorModel.