tracker_consumers

Creates, updates, deletes or gets a tracker_consumer resource or lists tracker_consumers in a region

Overview

Name	tracker_consumers
Type	Resource
Description	Definition of AWS::Location::TrackerConsumer Resource Type
Id	awscc.location.tracker_consumers

Fields

get (all properties)

Name	Datatype	Description
consumer_arn	string
tracker_name	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
consumer_arn	string
tracker_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	tracker_consumers	INSERT	ConsumerArn, TrackerName, region
delete_resource	tracker_consumers	DELETE	Identifier, region
list_resources	tracker_consumers_list_only	SELECT	region
get_resource	tracker_consumers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual tracker_consumer.

SELECT
  region,
  consumer_arn,
  tracker_name
FROM awscc.location.tracker_consumers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ tracker_name }}|{{ consumer_arn }}';

list (identifiers only)

Lists all tracker_consumers in a region.

SELECT
  region,
  tracker_name,
  consumer_arn
FROM awscc.location.tracker_consumers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.location.tracker_consumers (
  ConsumerArn,
  TrackerName,
  region
)
SELECT
  '{{ consumer_arn }}',
  '{{ tracker_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.location.tracker_consumers (
  ConsumerArn,
  TrackerName,
  region
)
SELECT
  '{{ consumer_arn }}',
  '{{ tracker_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: tracker_consumer
  props:
    - name: consumer_arn
      value: '{{ consumer_arn }}'
    - name: tracker_name
      value: '{{ tracker_name }}'

DELETE example

/*+ delete */
DELETE FROM awscc.location.tracker_consumers
WHERE
  Identifier = '{{ tracker_name }}|{{ consumer_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

geo:AssociateTrackerConsumer,
geo:ListTrackerConsumers

Delete

geo:DisassociateTrackerConsumer,
geo:ListTrackerConsumers

List

geo:ListTrackerConsumers

Read

geo:ListTrackerConsumers