Package software.amazon.awscdk.cfnpropertymixins.services.iot

Interface CfnTopicRulePropsMixin.LocationActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRulePropsMixin.LocationActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRulePropsMixin

@Stability(Stable)
public static interface CfnTopicRulePropsMixin.LocationActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.

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.iot.*;
 LocationActionProperty locationActionProperty = LocationActionProperty.builder()
         .deviceId("deviceId")
         .latitude("latitude")
         .longitude("longitude")
         .roleArn("roleArn")
         .timestamp(TimestampProperty.builder()
                 .unit("unit")
                 .value("value")
                 .build())
         .trackerName("trackerName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTopicRulePropsMixin.LocationActionProperty.Builder	builder()
default String	getDeviceId()	The unique ID of the device providing the location data.
default String	getLatitude()	A string that evaluates to a double value that represents the latitude of the device's location.
default String	getLongitude()	A string that evaluates to a double value that represents the longitude of the device's location.
default String	getRoleArn()	The IAM role that grants permission to write to the Amazon Location resource.
default Object	getTimestamp()	The time that the location data was sampled.
default String	getTrackerName()	The name of the tracker resource in Amazon Location in which the location is updated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeviceId

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

The unique ID of the device providing the location data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-deviceid

getLatitude

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

A string that evaluates to a double value that represents the latitude of the device's location.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-latitude

getLongitude

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

A string that evaluates to a double value that represents the longitude of the device's location.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-longitude

getRoleArn

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

The IAM role that grants permission to write to the Amazon Location resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-rolearn

getTimestamp

@Stability(Stable)
@Nullable
default Object getTimestamp()

The time that the location data was sampled.

The default value is the time the MQTT message was processed.

Returns union: either IResolvable or CfnTopicRulePropsMixin.TimestampProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-timestamp

getTrackerName

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

The name of the tracker resource in Amazon Location in which the location is updated.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-locationaction.html#cfn-iot-topicrule-locationaction-trackername

builder

@Stability(Stable)
static CfnTopicRulePropsMixin.LocationActionProperty.Builder builder()

Returns:

a CfnTopicRulePropsMixin.LocationActionProperty.Builder of CfnTopicRulePropsMixin.LocationActionProperty