Package software.amazon.awscdk.cfnpropertymixins.services.iotanalytics

Interface CfnPipelinePropsMixin.DeviceShadowEnrichProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelinePropsMixin.DeviceShadowEnrichProperty.Jsii$Proxy

Enclosing class:

CfnPipelinePropsMixin

@Stability(Stable)
public static interface CfnPipelinePropsMixin.DeviceShadowEnrichProperty
extends software.amazon.jsii.JsiiSerializable

An activity that adds information from the AWS IoT Device Shadows service to a 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.cfnpropertymixins.services.iotanalytics.*;
 DeviceShadowEnrichProperty deviceShadowEnrichProperty = DeviceShadowEnrichProperty.builder()
         .attribute("attribute")
         .name("name")
         .next("next")
         .roleArn("roleArn")
         .thingName("thingName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipelinePropsMixin.DeviceShadowEnrichProperty.Builder	A builder for CfnPipelinePropsMixin.DeviceShadowEnrichProperty
static final class	CfnPipelinePropsMixin.DeviceShadowEnrichProperty.Jsii$Proxy	An implementation for CfnPipelinePropsMixin.DeviceShadowEnrichProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttribute

@Stability(Stable)
@Nullable
default String getAttribute()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the 'deviceShadowEnrich' activity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-name

getNext

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

The next activity in the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn

getThingName

@Stability(Stable)
@Nullable
default String getThingName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname

builder

@Stability(Stable)
static CfnPipelinePropsMixin.DeviceShadowEnrichProperty.Builder builder()

Returns:

a CfnPipelinePropsMixin.DeviceShadowEnrichProperty.Builder of CfnPipelinePropsMixin.DeviceShadowEnrichProperty