Tracker

class aws_cdk.aws_location_alpha.Tracker(scope, id, *, 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: Resource

(experimental) A Tracker.

See:: https://docs.aws.amazon.com/location/latest/developerguide/geofence-tracker-concepts.html#tracking-overview
Stability:: experimental
ExampleMetadata:: infused

Example:

# role: iam.Role


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

tracker.grant_read(role)

Parameters:

scope (Construct)
id (str)
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

Methods

add_geofence_collections(*geofence_collections)

(experimental) Add Geofence Collections which are associated to the tracker resource.

Parameters:: geofence_collections (IGeofenceCollection)
Stability:: experimental
Return type:: None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:: policy (RemovalPolicy)
Return type:: None

grant(grantee, *actions)

(experimental) Grant the given principal identity permissions to perform the actions on this tracker.

Parameters:

grantee (IGrantable)
actions (str)

Stability:

experimental

Return type:

Grant

grant_read(grantee)

(experimental) Grant the given identity permissions to read device positions from a tracker.

Parameters:: grantee (IGrantable)
See:: https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-read-only-trackers
Stability:: experimental
Return type:: Grant

grant_update_device_positions(grantee)

(experimental) Grant the given identity permissions to update device positions for a tracker.

Parameters:: grantee (IGrantable)
See:: https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-read-only-trackers
Stability:: experimental
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-location-alpha.Tracker'

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

tracker_arn

(experimental) The Amazon Resource Name (ARN) of the tracker resource.

Stability:: experimental

tracker_create_time

(experimental) The timestamp for when the tracker resource was created in ISO 8601 format.

Stability:: experimental
Attribute:: true

tracker_name

(experimental) The name of the tracker.

Stability:: experimental

tracker_update_time

(experimental) The timestamp for when the tracker resource was last updated in ISO 8601 format.

Stability:: experimental
Attribute:: true

Static Methods

classmethod from_tracker_arn(scope, id, tracker_arn)

(experimental) Use an existing tracker by ARN.

Parameters:

scope (Construct)
id (str)
tracker_arn (str)

Stability:

experimental

Return type:

ITracker

classmethod from_tracker_name(scope, id, tracker_name)

(experimental) Use an existing tracker by name.

Parameters:

scope (Construct)
id (str)
tracker_name (str)

Stability:

experimental

Return type:

ITracker

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool