aws-cdk-lib.aws_iot.CfnTopicRule.LocationActionProperty

interface LocationActionProperty

LanguageType name
.NETAmazon.CDK.AWS.IoT.CfnTopicRule.LocationActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiot#CfnTopicRule_LocationActionProperty
Javasoftware.amazon.awscdk.services.iot.CfnTopicRule.LocationActionProperty
Pythonaws_cdk.aws_iot.CfnTopicRule.LocationActionProperty
TypeScript aws-cdk-lib » aws_iot » CfnTopicRule » LocationActionProperty

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 { aws_iot as iot } from 'aws-cdk-lib';
const locationActionProperty: iot.CfnTopicRule.LocationActionProperty = {
  deviceId: 'deviceId',
  latitude: 'latitude',
  longitude: 'longitude',
  roleArn: 'roleArn',
  trackerName: 'trackerName',

  // the properties below are optional
  timestamp: {
    value: 'value',

    // the properties below are optional
    unit: 'unit',
  },
};

Properties

NameTypeDescription
deviceIdstringThe unique ID of the device providing the location data.
latitudestringA string that evaluates to a double value that represents the latitude of the device's location.
longitudestringA string that evaluates to a double value that represents the longitude of the device's location.
roleArnstringThe IAM role that grants permission to write to the Amazon Location resource.
trackerNamestringThe name of the tracker resource in Amazon Location in which the location is updated.
timestamp?IResolvable | TimestampPropertyThe time that the location data was sampled.

deviceId

Type: string

The unique ID of the device providing the location data.


latitude

Type: string

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


longitude

Type: string

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


roleArn

Type: string

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


trackerName

Type: string

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


timestamp?

Type: IResolvable | TimestampProperty (optional)

The time that the location data was sampled.

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