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
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A description for the tracker.
Default: no description
eventBridgeEnabledoptionalbooleanevent_bridge_enabledoptionalbooleventBridgeEnabledoptionalBooleanEventBridgeEnabledoptionalboolEventBridgeEnabledoptional*bool= false#Send filtered device position updates to default EventBridge bus.
geofenceCollectionsoptionalIGeofenceCollection[]geofence_collectionsoptionaltyping.List[IGeofenceCollection]geofenceCollectionsoptionalList<IGeofenceCollection>GeofenceCollectionsoptionalIGeofenceCollection[]GeofenceCollectionsoptional*[]IGeofenceCollection#An optional list of geofence collections to associate with the tracker resource.
Default: no geofence collections are associated
kmsKeyoptionalIKeyRefkms_keyoptionalIKeyRefkmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRef#The customer managed key to encrypt data.
Default: Use an AWS managed key
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.
kmsKeyEnableGeospatialQueriesoptionalbooleankms_key_enable_geospatial_queriesoptionalboolkmsKeyEnableGeospatialQueriesoptionalBooleanKmsKeyEnableGeospatialQueriesoptionalboolKmsKeyEnableGeospatialQueriesoptional*bool= false#Whether to opt-in to the Bounding Polygon Queries feature with customer managed key.
positionFilteringoptionalPositionFilteringposition_filteringoptionalPositionFilteringpositionFilteringoptionalPositionFilteringPositionFilteringoptionalPositionFilteringPositionFilteringoptionalPositionFiltering= PositionFiltering.TIME_BASED#The position filtering for the tracker resource.
trackerNameoptionalstringtracker_nameoptionalstrtrackerNameoptionalStringTrackerNameoptionalstringTrackerNameoptional*string#A name for the tracker.
Default: A name is automatically generated
Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.