AWS::Location::TrackerConsumer
The AWS::Location::TrackerConsumer
resource specifies an association
between a geofence collection and a tracker resource. The geofence collection is
referred to as the consumer of the tracker. This allows the tracker resource
to communicate location data to the linked geofence collection.
Note
Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Location::TrackerConsumer", "Properties" : { "ConsumerArn" :
String
, "TrackerName" :String
} }
YAML
Type: AWS::Location::TrackerConsumer Properties: ConsumerArn:
String
TrackerName:String
Properties
ConsumerArn
-
The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS.
-
Format example:
arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollectionConsumer
Required: Yes
Type: String
Pattern:
^arn(:[a-z0-9]+([.-][a-z0-9]+)*){2}(:([a-z0-9]+([.-][a-z0-9]+)*)?){2}:([^/].*)?$
Maximum:
1600
Update requires: Replacement
-
TrackerName
-
The name for the tracker resource.
Requirements:
-
Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_).
-
Must be a unique tracker resource name.
-
No spaces allowed. For example,
ExampleTracker
.
Required: Yes
Type: String
Pattern:
^[-._\w]+$
Minimum:
1
Maximum:
100
Update requires: Replacement
-
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the TrackerConsumer
name.
For more information about using the Ref
function, see Ref
.