software.amazon.awscdk.services.iotanalytics

Interface CfnPipeline.DeviceRegistryEnrichProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.DeviceRegistryEnrichProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(value=Stable)
public static interface CfnPipeline.DeviceRegistryEnrichProperty
extends software.amazon.jsii.JsiiSerializable

An activity that adds data from the AWS IoT device registry to your message.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotanalytics.*;
 DeviceRegistryEnrichProperty deviceRegistryEnrichProperty = DeviceRegistryEnrichProperty.builder()
         .attribute("attribute")
         .name("name")
         .roleArn("roleArn")
         .thingName("thingName")
         // the properties below are optional
         .next("next")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnPipeline.DeviceRegistryEnrichProperty.Builder	builder()
String	getAttribute() The name of the attribute that is added to the message.
String	getName() The name of the 'deviceRegistryEnrich' activity.
default String	getNext() The next activity in the pipeline.
String	getRoleArn() The ARN of the role that allows access to the device's registry information.
String	getThingName() The name of the IoT device whose registry information is added to the message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttribute

@Stability(value=Stable)
 @NotNull
String getAttribute()

The name of the attribute that is added to the message.

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the 'deviceRegistryEnrich' activity.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The ARN of the role that allows access to the device's registry information.

getThingName

@Stability(value=Stable)
 @NotNull
String getThingName()

The name of the IoT device whose registry information is added to the message.

getNext

@Stability(value=Stable)
 @Nullable
default String getNext()

The next activity in the pipeline.

builder

@Stability(value=Stable)
static CfnPipeline.DeviceRegistryEnrichProperty.Builder builder()

Returns:

a CfnPipeline.DeviceRegistryEnrichProperty.Builder of CfnPipeline.DeviceRegistryEnrichProperty