TrackerProps

class aws_cdk.aws_location_alpha.TrackerProps(*, description=None, event_bridge_enabled=None, geofence_collections=None, kms_key=None, kms_key_enable_geospatial_queries=None, position_filtering=None, tracker_name=None)

Bases: object

(experimental) Properties for a tracker.

Parameters:

  • description (Optional[str]) – (experimental) A description for the tracker. Default: - no description

  • event_bridge_enabled (Optional[bool]) – (experimental) Send filtered device position updates to default EventBridge bus. Default: false

  • geofence_collections (Optional[Sequence[IGeofenceCollection]]) – (experimental) An optional list of geofence collections to associate with the tracker resource. Default: - no geofence collections are associated

  • kms_key (Optional[IKeyRef]) – (experimental) 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. Default: - Use an AWS managed key

  • kms_key_enable_geospatial_queries (Optional[bool]) – (experimental) Whether to opt-in to the Bounding Polygon Queries feature with customer managed key. Default: false

  • position_filtering (Optional[PositionFiltering]) – (experimental) The position filtering for the tracker resource. Default: PositionFiltering.TIME_BASED

  • tracker_name (Optional[str]) – (experimental) A name for the tracker. Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores. Default: - A name is automatically generated

Stability:

experimental

ExampleMetadata:

infused

Example:

# role: iam.Role


tracker = location.Tracker(self, "Tracker",
    tracker_name="MyTracker"
)

tracker.grant_read(role)

Attributes

description

(experimental) A description for the tracker.

Default:

  • no description

Stability:

experimental

event_bridge_enabled

(experimental) Send filtered device position updates to default EventBridge bus.

Default:

false

Stability:

experimental

geofence_collections

(experimental) An optional list of geofence collections to associate with the tracker resource.

Default:

  • no geofence collections are associated

Stability:

experimental

kms_key

(experimental) 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.

Default:

  • Use an AWS managed key

Stability:

experimental

kms_key_enable_geospatial_queries

(experimental) Whether to opt-in to the Bounding Polygon Queries feature with customer managed key.

Default:

false

Stability:

experimental

position_filtering

(experimental) The position filtering for the tracker resource.

Default:

PositionFiltering.TIME_BASED

Stability:

experimental

tracker_name

(experimental) A name for the tracker.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

Default:

  • A name is automatically generated

Stability:

experimental