AWS::Location::GeofenceCollection - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Location::GeofenceCollection

The AWS::Location::GeofenceCollection resource specifies the ability to detect and act when a tracked device enters or exits a defined geographical boundary known as a geofence.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Location::GeofenceCollection",
  "Properties" : {
      "CollectionName" : String,
      "Description" : String,
      "KmsKeyId" : String,
      "PricingPlan" : String,
      "PricingPlanDataSource" : String
    }
}

YAML

Type: AWS::Location::GeofenceCollection
Properties: 
  CollectionName: String
  Description: String
  KmsKeyId: String
  PricingPlan: String
  PricingPlanDataSource: String

Properties

CollectionName

The name for the geofence collection.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[-._\w]+$

Update requires: Replacement

Description

An optional description for the geofence collection.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: Replacement

KmsKeyId

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

PricingPlan

Specifies the pricing plan for the geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Required: Yes

Type: String

Allowed values: MobileAssetManagement | MobileAssetTracking | RequestBasedUsage

Update requires: Replacement

PricingPlanDataSource

Specifies the data provider for the geofence collection.

  • Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Note

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data will not be shared with the data provider, and will remain in your AWS account or region unless you move it.

Valid Values: Esri | Here

Required: No

Type: String

Update requires: Replacement

Return values

Ref

Fn::GetAtt

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the GeofenceCollectionName

For more information about using the Ref function, see Ref.

Arn

Not currently supported by AWS CloudFormation.

CreateTime

Not currently supported by AWS CloudFormation.