1.204.0

interface CfnTrackerProps

LanguageType name
.NETAmazon.CDK.AWS.Location.CfnTrackerProps
Javasoftware.amazon.awscdk.services.location.CfnTrackerProps
Pythonaws_cdk.aws_location.CfnTrackerProps
TypeScript @aws-cdk/aws-location » CfnTrackerProps

Properties for defining a CfnTracker.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as location from '@aws-cdk/aws-location';
const cfnTrackerProps: location.CfnTrackerProps = {
  trackerName: 'trackerName',

  // the properties below are optional
  description: 'description',
  kmsKeyId: 'kmsKeyId',
  positionFiltering: 'positionFiltering',
};

Properties

NameTypeDescription
trackerNamestringThe name for the tracker resource.
description?stringAn optional description for the tracker resource.
kmsKeyId?stringA key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.
positionFiltering?stringSpecifies the position filtering for the tracker resource.

trackerName

Type: string

The name for the tracker resource.

Requirements:

  • Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
  • Must be a unique tracker resource name.
  • No spaces allowed. For example, ExampleTracker .

description?

Type: string (optional)

An optional description for the tracker resource.

kmsKeyId?

Type: string (optional)

A key identifier for an AWS KMS customer managed key . Enter a key ID, key ARN, alias name, or alias ARN.

positionFiltering?

Type: string (optional)

Specifies the position filtering for the tracker resource.

Valid values:

  • TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.
  • DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this area are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.
  • AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This can reduce the effects of GPS noise when displaying device trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.

This field is optional. If not specified, the default value is TimeBased .

← PreviousNext →