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	awscc.location.trackers

Fields

get (all properties)

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
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
tracker_name	string
region	string	AWS region.

For more information, see AWS::Location::Tracker.

Methods

Name	Resource	Accessible by	Required Params
create_resource	trackers	INSERT	TrackerName, region
delete_resource	trackers	DELETE	Identifier, region
update_resource	trackers	UPDATE	Identifier, PatchDocument, region
list_resources	trackers_list_only	SELECT	region
get_resource	trackers	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.location.trackers
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ tracker_name }}';

list (identifiers only)

Lists all trackers in a region.

SELECT
  region,
  tracker_name
FROM awscc.location.trackers_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.location.trackers (
  Description,
  EventBridgeEnabled,
  KmsKeyEnableGeospatialQueries,
  KmsKeyId,
  PositionFiltering,
  PricingPlan,
  PricingPlanDataSource,
  Tags,
  TrackerName,
  region
)
SELECT
  '{{ description }}',
  '{{ event_bridge_enabled }}',
  '{{ kms_key_enable_geospatial_queries }}',
  '{{ kms_key_id }}',
  '{{ position_filtering }}',
  '{{ pricing_plan }}',
  '{{ pricing_plan_data_source }}',
  '{{ tags }}',
  '{{ tracker_name }}',
  '{{ 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: event_bridge_enabled
        value: '{{ event_bridge_enabled }}'
      - name: kms_key_enable_geospatial_queries
        value: '{{ kms_key_enable_geospatial_queries }}'
      - name: kms_key_id
        value: '{{ kms_key_id }}'
      - name: position_filtering
        value: '{{ position_filtering }}'
      - name: pricing_plan
        value: '{{ pricing_plan }}'
      - name: pricing_plan_data_source
        value: '{{ pricing_plan_data_source }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: tracker_name
        value: '{{ tracker_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.location.trackers
SET PatchDocument = string('{{ {
    "Description": description,
    "EventBridgeEnabled": event_bridge_enabled,
    "KmsKeyEnableGeospatialQueries": kms_key_enable_geospatial_queries,
    "PositionFiltering": position_filtering,
    "PricingPlan": pricing_plan,
    "PricingPlanDataSource": pricing_plan_data_source,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ tracker_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.location.trackers
WHERE
  Identifier = '{{ tracker_name }}' 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