# AWS::Location Construct Library

> Version 2.275.0-alpha.0

> **Separate package**
>
> `@aws-cdk/aws-location-alpha` is not part of `aws-cdk-lib` — install it separately:
>
> ```sh
> npm install @aws-cdk/aws-location-alpha
> pip install aws-cdk.aws-location-alpha
> ```
>
> This module is [**experimental**](/stability) (alpha): its API may change in any release, without a major version bump.
---

![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)

> The APIs of higher level constructs in this module are experimental and under active development.
> They are subject to non-backward compatible changes or removal in any future version. These are
> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
> announced in the release notes. This means that while you may use them, you may need to update
> your source code when upgrading to a newer version of this package.

---

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

Amazon Location Service lets you add location data and functionality to applications, which
includes capabilities such as maps, points of interest, geocoding, routing, geofences, and
tracking. Amazon Location provides location-based services (LBS) using high-quality data from
global, trusted providers Esri and HERE. With affordable data, tracking and geofencing
capabilities, and built-in metrics for health monitoring, you can build sophisticated
location-enabled applications.

## Geofence Collection

Geofence collection resources allow you to store and manage geofences—virtual boundaries on a map.
You can evaluate locations against a geofence collection resource and get notifications when the location
update crosses the boundary of any of the geofences in the geofence collection.

```ts
declare const key: kms.Key;

new location.GeofenceCollection(this, 'GeofenceCollection', {
  geofenceCollectionName: 'MyGeofenceCollection', // optional, defaults to a generated name
  kmsKey: key, // optional, defaults to use an AWS managed key
});
```

Use the `grant()` or `grantRead()` method to grant the given identity permissions to perform actions
on the geofence collection:

```ts
declare const role: iam.Role;

const geofenceCollection = new location.GeofenceCollection(this, 'GeofenceCollection', {
  geofenceCollectionName: 'MyGeofenceCollection',
});

geofenceCollection.grantRead(role);
```

## Tracker

A tracker stores position updates for a collection of devices. The tracker can be used to query the devices' current location or location history. It stores the updates, but reduces storage space and visual noise by filtering the locations before storing them.

For more information, see [Trackers](https://docs.aws.amazon.com/location/latest/developerguide/geofence-tracker-concepts.html#tracking-overview).

To create a tracker, define a [`Tracker`](/v2/docs/@aws-cdk_aws-location-alpha.Tracker):

```ts
declare const key: kms.Key;

new location.Tracker(this, 'Tracker', {
  trackerName: 'MyTracker', // optional, defaults to a generated name
  kmsKey: key, // optional, defaults to use an AWS managed key
});
```

Use the `grant()`, `grantUpdateDevicePositions()` or `grantRead()` method to grant the given identity permissions to perform actions
on the geofence collection:

```ts
declare const role: iam.Role;

const tracker = new location.Tracker(this, 'Tracker', {
  trackerName: 'MyTracker',
});

tracker.grantRead(role);
```

If you want to associate a tracker with geofence collections, define a `geofenceCollections` property or use the `addGeofenceCollections()` method.

```ts
declare const geofenceCollection: location.GeofenceCollection;
declare const geofenceCollectionForAdd: location.GeofenceCollection;
declare const tracker: location.Tracker;

const tracker = new location.Tracker(this, 'Tracker', {
  trackerName: 'MyTracker',
  geofenceCollections: [geofenceCollection],
});

tracker.addGeofenceCollections(geofenceCollectionForAdd);
```

## API key

API keys are a key value that is associated with specific Amazon Location Service resources or API in your AWS account, and specific actions that you can perform on those resources.
You can use an API key in your application to make unauthenticated calls to the Amazon Location APIs for those resources.

For more information, see [Use API keys to authenticate](https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html).

To create an API key, define an [`ApiKey`](/v2/docs/@aws-cdk_aws-location-alpha.ApiKey):

```ts
new location.ApiKey(this, 'APIKeyAny', {
  // specify allowed actions
  allowMapsActions: [
    location.AllowMapsAction.GET_STATIC_MAP,
  ],
  allowPlacesActions: [
    location.AllowPlacesAction.GET_PLACE,
  ],
  allowRoutesActions: [
    location.AllowRoutesAction.CALCULATE_ISOLINES,
  ],
});
```

> Note: [`ApiKey`](/v2/docs/@aws-cdk_aws-location-alpha.ApiKey) construct only supports [Enhanced Places, Routes, and Maps](https://aws.amazon.com/blogs/aws/announcing-new-apis-for-amazon-location-service-routes-places-and-maps/) This API key grants access to AWS-managed Places, Routes, and Maps.

## Legacy Resources

AWS has released new [Enhanced Places, Routes, and Maps](https://aws.amazon.com/about-aws/whats-new/2024/11/amazon-location-service-enhanced-places-routes-maps/?nc1=h_ls). Since these use AWS-managed resources, users no longer need to create Maps, Places, and Routes resources themselves.

As a result, the following constructs are now considered legacy.

For more information, see [developer guide](https://docs.aws.amazon.com/location/latest/developerguide/what-is.html).

### Map

The Amazon Location Service Map resource gives you access to the underlying basemap data for a map.
You use the Map resource with a map rendering library to add an interactive map to your application.
You can add other functionality to your map, such as markers (or pins), routes, and polygon areas, as needed for your application.

For information about how to use map resources in practice, see [Using Amazon Location Maps in your application](https://docs.aws.amazon.com/location/latest/developerguide/using-maps.html).

To create a map, define a [`Map`](/v2/docs/@aws-cdk_aws-location-alpha.Map):

```ts
new location.Map(this, 'Map', {
  mapName: 'my-map',
  style: location.Style.VECTOR_ESRI_NAVIGATION,
  customLayers: [location.CustomLayer.POI],
});
```

Use the `grant()` or `grantRendering()` method to grant the given identity permissions to perform actions
on the map:

```ts
declare const role: iam.Role;

const map = new location.Map(this, 'Map', {
  style: location.Style.VECTOR_ESRI_NAVIGATION,
});
map.grantRendering(role);
```

### Place Index

A key function of Amazon Location Service is the ability to search the geolocation information.
Amazon Location provides this functionality via the Place index resource. The place index includes
which [data provider](https://docs.aws.amazon.com/location/latest/developerguide/what-is-data-provider.html)
to use for the search.

To create a place index, define a [`PlaceIndex`](/v2/docs/@aws-cdk_aws-location-alpha.PlaceIndex):

```ts
new location.PlaceIndex(this, 'PlaceIndex', {
  placeIndexName: 'MyPlaceIndex', // optional, defaults to a generated name
  dataSource: location.DataSource.HERE, // optional, defaults to Esri
});
```

Use the `grant()` or `grantSearch()` method to grant the given identity permissions to perform actions
on the place index:

```ts
declare const role: iam.Role;

const placeIndex = new location.PlaceIndex(this, 'PlaceIndex');
placeIndex.grantSearch(role);
```

### Route Calculator

Route calculator resources allow you to find routes and estimate travel time based on up-to-date road network and live traffic information from your chosen data provider.

For more information, see [Routes](https://docs.aws.amazon.com/location/latest/developerguide/route-concepts.html).

To create a route calculator, define a [`RouteCalculator`](/v2/docs/@aws-cdk_aws-location-alpha.RouteCalculator):

```ts
new location.RouteCalculator(this, 'RouteCalculator', {
  routeCalculatorName: 'MyRouteCalculator', // optional, defaults to a generated name
  dataSource: location.DataSource.ESRI,
});
```

Use the `grant()` or `grantRead()` method to grant the given identity permissions to perform actions
on the route calculator:

```ts
declare const role: iam.Role;

const routeCalculator = new location.RouteCalculator(this, 'RouteCalculator', {
  dataSource: location.DataSource.ESRI,
});
routeCalculator.grantRead(role);
```

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`ApiKey`](/v2/docs/@aws-cdk_aws-location-alpha.ApiKey) | Construct (L2) | An API Key. |
| [`GeofenceCollection`](/v2/docs/@aws-cdk_aws-location-alpha.GeofenceCollection) | Construct (L2) | A Geofence Collection. |
| [`Map`](/v2/docs/@aws-cdk_aws-location-alpha.Map) | Construct (L2) | The Amazon Location Service Map. |
| [`PlaceIndex`](/v2/docs/@aws-cdk_aws-location-alpha.PlaceIndex) | Construct (L2) | A Place Index. |
| [`RouteCalculator`](/v2/docs/@aws-cdk_aws-location-alpha.RouteCalculator) | Construct (L2) | A Route Calculator. |
| [`Tracker`](/v2/docs/@aws-cdk_aws-location-alpha.Tracker) | Construct (L2) | A Tracker. |
| [`AllowMapsAction`](/v2/docs/@aws-cdk_aws-location-alpha.AllowMapsAction) | Enum | Actions for Maps that an API key resource grants permissions to perform. |
| [`AllowPlacesAction`](/v2/docs/@aws-cdk_aws-location-alpha.AllowPlacesAction) | Enum | Actions for Places that an API key resource grants permissions to perform. |
| [`AllowRoutesAction`](/v2/docs/@aws-cdk_aws-location-alpha.AllowRoutesAction) | Enum | Actions for Routes that an API key resource grants permissions to perform. |
| [`ApiKeyProps`](/v2/docs/@aws-cdk_aws-location-alpha.ApiKeyProps) | Struct | Properties for an API Key. |
| [`CustomLayer`](/v2/docs/@aws-cdk_aws-location-alpha.CustomLayer) | Enum | An additional layer you can enable for a map style. |
| [`DataSource`](/v2/docs/@aws-cdk_aws-location-alpha.DataSource) | Enum | Data source for a place index. |
| [`GeofenceCollectionProps`](/v2/docs/@aws-cdk_aws-location-alpha.GeofenceCollectionProps) | Struct | Properties for a geofence collection. |
| [`IApiKey`](/v2/docs/@aws-cdk_aws-location-alpha.IApiKey) | Interface | An API Key. |
| [`IGeofenceCollection`](/v2/docs/@aws-cdk_aws-location-alpha.IGeofenceCollection) | Interface | A Geofence Collection. |
| [`IMap`](/v2/docs/@aws-cdk_aws-location-alpha.IMap) | Interface | Represents the Amazon Location Service Map. |
| [`IntendedUse`](/v2/docs/@aws-cdk_aws-location-alpha.IntendedUse) | Enum | Intend use for the results of an operation. |
| [`IPlaceIndex`](/v2/docs/@aws-cdk_aws-location-alpha.IPlaceIndex) | Interface | A Place Index. |
| [`IRouteCalculator`](/v2/docs/@aws-cdk_aws-location-alpha.IRouteCalculator) | Interface | A Route Calculator. |
| [`ITracker`](/v2/docs/@aws-cdk_aws-location-alpha.ITracker) | Interface | A Tracker. |
| [`MapProps`](/v2/docs/@aws-cdk_aws-location-alpha.MapProps) | Struct | Properties for the Amazon Location Service Map. |
| [`PlaceIndexProps`](/v2/docs/@aws-cdk_aws-location-alpha.PlaceIndexProps) | Struct | Properties for a place index. |
| [`PoliticalView`](/v2/docs/@aws-cdk_aws-location-alpha.PoliticalView) | Enum | The map political view. |
| [`PositionFiltering`](/v2/docs/@aws-cdk_aws-location-alpha.PositionFiltering) | Enum | The position filtering for the tracker resource. |
| [`RouteCalculatorProps`](/v2/docs/@aws-cdk_aws-location-alpha.RouteCalculatorProps) | Struct | Properties for a route calculator. |
| [`Style`](/v2/docs/@aws-cdk_aws-location-alpha.Style) | Enum | The map style selected from an available data provider. |
| [`TrackerProps`](/v2/docs/@aws-cdk_aws-location-alpha.TrackerProps) | Struct | Properties for a tracker. |