AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Location::GeofenceCollection

CfnGeofenceCollection

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.

Import

import { CfnGeofenceCollection } from 'aws-cdk-lib/aws-location';

Or use the module namespace:

import * as location from 'aws-cdk-lib/aws-location';
// location.CfnGeofenceCollection

Properties

Configuration passed to the constructor as CfnGeofenceCollectionProps.

collectionNameRequired
string

A custom name for the geofence collection. Requirements: - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). - Must be a unique geofence collection name. - No spaces allowed. For example, `ExampleGeofenceCollection` .

descriptionOptional
string

An optional description for the geofence collection.

kmsKeyIdOptional
string

A key identifier for an [AWS KMS customer managed key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html) . Enter a key ID, key ARN, alias name, or alias ARN.

pricingPlanOptionalDeprecated
string

Deprecated: this property has been deprecated

pricingPlanDataSourceOptionalDeprecated
string

This shape is deprecated since 2022-02-01: Deprecated. No longer allowed.

Deprecated: this property has been deprecated

tagsOptional
CfnTag[]

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them. Format: `"key" : "value"` Restrictions: - Maximum 50 tags per resource - Each resource tag must be unique with a maximum of one value. - Maximum key length: 128 Unicode characters in UTF-8 - Maximum value length: 256 Unicode characters in UTF-8 - Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : /

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Location::GeofenceCollectionView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-location
CFN TypeAWS::Location::GeofenceCollection
Properties6

Related Constructs

Explore This Service

External Links