software.amazon.awscdk.services.iot

Interface CfnTopicRule.LocationActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.LocationActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(value=Stable)
public static interface CfnTopicRule.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.services.iot.*;
 LocationActionProperty locationActionProperty = LocationActionProperty.builder()
         .deviceId("deviceId")
         .latitude("latitude")
         .longitude("longitude")
         .roleArn("roleArn")
         .trackerName("trackerName")
         // the properties below are optional
         .timestamp(new Date())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.LocationActionProperty.Builder	builder()
String	getDeviceId() The unique ID of the device providing the location data.
String	getLatitude() A string that evaluates to a double value that represents the latitude of the device's location.
String	getLongitude() A string that evaluates to a double value that represents the longitude of the device's location.
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.
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 Detail

getDeviceId

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

The unique ID of the device providing the location data.

getLatitude

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

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

getLongitude

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

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

getRoleArn

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

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

getTrackerName

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

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

getTimestamp

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

The time that the location data was sampled.

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

builder

@Stability(value=Stable)
static CfnTopicRule.LocationActionProperty.Builder builder()

Returns:

a CfnTopicRule.LocationActionProperty.Builder of CfnTopicRule.LocationActionProperty