Package software.amazon.awscdk.cfnpropertymixins.services.iotevents

Class CfnDetectorModelPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iotevents.CfnDetectorModelPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDetectorModelPropsMixin>

Enclosing class:

CfnDetectorModelPropsMixin

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

A fluent builder for CfnDetectorModelPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnDetectorModelPropsMixin	build()
static CfnDetectorModelPropsMixin.Builder	create()
static CfnDetectorModelPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnDetectorModelPropsMixin.Builder	detectorModelDefinition(CfnDetectorModelPropsMixin.DetectorModelDefinitionProperty detectorModelDefinition)	Information that defines how a detector operates.
CfnDetectorModelPropsMixin.Builder	detectorModelDefinition(IResolvable detectorModelDefinition)	Information that defines how a detector operates.
CfnDetectorModelPropsMixin.Builder	detectorModelDescription(String detectorModelDescription)	A brief description of the detector model.
CfnDetectorModelPropsMixin.Builder	detectorModelName(String detectorModelName)	The name of the detector model.
CfnDetectorModelPropsMixin.Builder	evaluationMethod(String evaluationMethod)	Information about the order in which events are evaluated and how actions are executed.
CfnDetectorModelPropsMixin.Builder	key(String key)	The value used to identify a detector instance.
CfnDetectorModelPropsMixin.Builder	roleArn(String roleArn)	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
CfnDetectorModelPropsMixin.Builder	roleArn(IRoleRef roleArn)	The ARN of the role that grants permission to AWS IoT Events to perform its operations.
CfnDetectorModelPropsMixin.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 CfnDetectorModelPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnDetectorModelPropsMixin.Builder.

create

@Stability(Stable)
public static CfnDetectorModelPropsMixin.Builder create()

Returns:

a new instance of CfnDetectorModelPropsMixin.Builder.

detectorModelDefinition

@Stability(Stable)
public CfnDetectorModelPropsMixin.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 CfnDetectorModelPropsMixin.Builder detectorModelDefinition(CfnDetectorModelPropsMixin.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

detectorModelDescription

@Stability(Stable)
public CfnDetectorModelPropsMixin.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 CfnDetectorModelPropsMixin.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 CfnDetectorModelPropsMixin.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 CfnDetectorModelPropsMixin.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

roleArn

@Stability(Stable)
public CfnDetectorModelPropsMixin.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

roleArn

@Stability(Stable)
public CfnDetectorModelPropsMixin.Builder roleArn(IRoleRef 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

tags

@Stability(Stable)
public CfnDetectorModelPropsMixin.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 CfnDetectorModelPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnDetectorModelPropsMixin.