interface TrackerProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Location.Alpha.TrackerProps |
![]() | github.com/aws/aws-cdk-go/awscdklocationalpha/v2#TrackerProps |
![]() | software.amazon.awscdk.services.location.alpha.TrackerProps |
![]() | aws_cdk.aws_location_alpha.TrackerProps |
![]() | @aws-cdk/aws-location-alpha ยป TrackerProps |
Properties for a tracker.
Example
declare const role: iam.Role;
const tracker = new location.Tracker(this, 'Tracker', {
trackerName: 'MyTracker',
});
tracker.grantRead(role);
Properties
Name | Type | Description |
---|---|---|
description? | string | A description for the tracker. |
event | boolean | Send filtered device position updates to default EventBridge bus. |
geofence | IGeofence [] | An optional list of geofence collections to associate with the tracker resource. |
kms | IKey | The customer managed key to encrypt data. |
kms | boolean | Whether to opt-in to the Bounding Polygon Queries feature with customer managed key. |
position | Position | The position filtering for the tracker resource. |
tracker | string | A name for the tracker. |
description?
Type:
string
(optional, default: no description)
A description for the tracker.
eventBridgeEnabled?
Type:
boolean
(optional, default: false)
Send filtered device position updates to default EventBridge bus.
geofenceCollections?
Type:
IGeofence
[]
(optional, default: no geofence collections are associated)
An optional list of geofence collections to associate with the tracker resource.
kmsKey?
Type:
IKey
(optional, default: Use an AWS managed key)
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.
kmsKeyEnableGeospatialQueries?
Type:
boolean
(optional, default: false)
Whether to opt-in to the Bounding Polygon Queries feature with customer managed key.
positionFiltering?
Type:
Position
(optional, default: PositionFiltering.TIME_BASED)
The position filtering for the tracker resource.
trackerName?
Type:
string
(optional, default: A name is automatically generated)
A name for the tracker.
Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.