AWS::Location::Tracker - AWS CloudFormation

AWS::Location::Tracker

The AWS::Location::Tracker resource specifies a tracker resource in your AWS account, which lets you receive current and historical location of devices.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Location::Tracker", "Properties" : { "Description" : String, "KmsKeyId" : String, "PositionFiltering" : String, "PricingPlan" : String, "PricingPlanDataSource" : String, "TrackerName" : String } }

YAML

Type: AWS::Location::Tracker Properties: Description: String KmsKeyId: String PositionFiltering: String PricingPlan: String PricingPlanDataSource: String TrackerName: String

Properties

Description

An optional description for the tracker resource.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: Replacement

KmsKeyId

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

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

PositionFiltering

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.

Required: No

Type: String

Allowed values: AccuracyBased | DistanceBased | TimeBased

Update requires: Replacement

PricingPlan

No longer used. If included, the only allowed value is RequestBasedUsage.

Required: No

Type: String

Allowed values: MobileAssetManagement | MobileAssetTracking | RequestBasedUsage

Update requires: Replacement

PricingPlanDataSource

This parameter is no longer used.

Required: No

Type: String

Update requires: Replacement

TrackerName

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[-._\w]+$

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Tracker name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

  • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

CreateTime

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

TrackerArn

Synonym for Arn. The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all AWS.

  • Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

UpdateTime

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.