Experimental
@aws-cdk/aws-location-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
TrackerProps Struct
Properties for a tracker.
Example
ts
declare const role: iam.Role;
const tracker = new location.Tracker(this, 'Tracker', {
trackerName: 'MyTracker',
});
tracker.grantRead(role);
Properties
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#A description for the tracker.
eventBridgeEnabledbooleanevent_bridge_enabledbooleventBridgeEnabledBooleanEventBridgeEnabledboolEventBridgeEnabled*bool= false#Send filtered device position updates to default EventBridge bus.
geofenceCollectionsIGeofenceCollection[]geofence_collectionstyping.List[IGeofenceCollection]geofenceCollectionsList<IGeofenceCollection>GeofenceCollectionsIGeofenceCollection[]GeofenceCollections*[]IGeofenceCollection= no geofence collections are asso…#An optional list of geofence collections to associate with the tracker resource.
default
Default: no geofence collections are associated
The customer managed key to encrypt data.
If you set customer managed key, the Bounding Polygon Queries feature will be disabled by default. You can choose to opt-in to the Bounding Polygon Queries feature by setting the kmsKeyEnableGeospatialQueries parameter to true.
kmsKeyEnableGeospatialQueriesbooleankms_key_enable_geospatial_queriesboolkmsKeyEnableGeospatialQueriesBooleanKmsKeyEnableGeospatialQueriesboolKmsKeyEnableGeospatialQueries*bool= false#Whether to opt-in to the Bounding Polygon Queries feature with customer managed key.
positionFilteringPositionFilteringposition_filteringPositionFilteringpositionFilteringPositionFilteringPositionFilteringPositionFilteringPositionFilteringPositionFiltering= PositionFiltering.TIME_BASED#The position filtering for the tracker resource.
trackerNamestringtracker_namestrtrackerNameStringTrackerNamestringTrackerName*string= A name is automatically generate…#A name for the tracker.
Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.
default
Default: A name is automatically generated