trackers

Creates, updates, deletes or gets a tracker resource or lists trackers in a region

Overview

Name	trackers
Type	Resource
Description	Definition of AWS::Location::Tracker Resource Type
Id	aws.location.trackers

Fields

Name	Datatype	Description
create_time	string	The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
description	string
event_bridge_enabled	boolean
kms_key_enable_geospatial_queries	boolean
kms_key_id	string
position_filtering	string
pricing_plan	string
pricing_plan_data_source	string	This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.
tags	array	An array of key-value pairs to apply to this resource.
tracker_arn	string
tracker_name	string
update_time	string	The datetime value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ss.sssZ)
arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TrackerName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all trackers in a region.

SELECT
region,
create_time,
description,
event_bridge_enabled,
kms_key_enable_geospatial_queries,
kms_key_id,
position_filtering,
pricing_plan,
pricing_plan_data_source,
tags,
tracker_arn,
tracker_name,
update_time,
arn
FROM aws.location.trackers
WHERE region = 'us-east-1';

Gets all properties from an individual tracker.

SELECT
region,
create_time,
description,
event_bridge_enabled,
kms_key_enable_geospatial_queries,
kms_key_id,
position_filtering,
pricing_plan,
pricing_plan_data_source,
tags,
tracker_arn,
tracker_name,
update_time,
arn
FROM aws.location.trackers
WHERE region = 'us-east-1' AND data__Identifier = '<TrackerName>';

INSERT example

Use the following StackQL query and manifest file to create a new tracker resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.location.trackers (
 TrackerName,
 region
)
SELECT 
'{{ TrackerName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.location.trackers (
 Description,
 EventBridgeEnabled,
 KmsKeyEnableGeospatialQueries,
 KmsKeyId,
 PositionFiltering,
 PricingPlan,
 PricingPlanDataSource,
 Tags,
 TrackerName,
 region
)
SELECT 
 '{{ Description }}',
 '{{ EventBridgeEnabled }}',
 '{{ KmsKeyEnableGeospatialQueries }}',
 '{{ KmsKeyId }}',
 '{{ PositionFiltering }}',
 '{{ PricingPlan }}',
 '{{ PricingPlanDataSource }}',
 '{{ Tags }}',
 '{{ TrackerName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: tracker
    props:
      - name: Description
        value: '{{ Description }}'
      - name: EventBridgeEnabled
        value: '{{ EventBridgeEnabled }}'
      - name: KmsKeyEnableGeospatialQueries
        value: '{{ KmsKeyEnableGeospatialQueries }}'
      - name: KmsKeyId
        value: '{{ KmsKeyId }}'
      - name: PositionFiltering
        value: '{{ PositionFiltering }}'
      - name: PricingPlan
        value: '{{ PricingPlan }}'
      - name: PricingPlanDataSource
        value: '{{ PricingPlanDataSource }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: TrackerName
        value: '{{ TrackerName }}'

DELETE example

/*+ delete */
DELETE FROM aws.location.trackers
WHERE data__Identifier = '<TrackerName>'
AND region = 'us-east-1';

Permissions

To operate on the trackers resource, the following permissions are required:

Create

geo:CreateTracker,
geo:DescribeTracker,
geo:TagResource,
geo:UntagResource,
kms:DescribeKey,
kms:CreateGrant

Read

geo:DescribeTracker,
kms:DescribeKey

Update

geo:CreateTracker,
geo:DescribeTracker,
geo:TagResource,
geo:UntagResource,
kms:DescribeKey,
kms:CreateGrant,
geo:UpdateTracker

Delete

geo:DeleteTracker,
geo:DescribeTracker

List

geo:ListTrackers