AWS CDK Location Service (Alpha)

2.250.0a0 · active · verified Fri Apr 17

The AWS CDK Location Service Alpha module provides L2 (Level 2) constructs for interacting with AWS Location Service. This allows developers to define Location Service resources like Trackers, Geofence Collections, Maps, and Place Indexes using Python. As an 'alpha' module, its APIs are subject to change and it's generally not recommended for production use. It is released in lockstep with the main `aws-cdk-lib` package.

Common errors

```
ModuleNotFoundError: No module named 'aws_cdk.aws_location_alpha'
```
cause The `aws-cdk-aws-location-alpha` Python package is not installed, or there's a version mismatch with `aws-cdk-lib`.

fix Run `pip install aws-cdk-aws-location-alpha`. Ensure `aws-cdk-aws-location-alpha` and `aws-cdk-lib` share the same major.minor.patch version prefix.
```
AttributeError: module 'aws_cdk.aws_location' has no attribute 'Tracker'
```
cause Attempting to import L2 constructs (like `Tracker`) from the non-alpha `aws_cdk.aws_location` module, while they only exist in the `_alpha` module.

fix Change your import statement to `import aws_cdk.aws_location_alpha as location` and then use `location.Tracker(...)`.
```
jsii.errors.JavaScriptError: TypeError: Class constructor Location cannot be invoked without 'new'
```
cause This often indicates a deep incompatibility issue, frequently caused by a mismatch between the `aws-cdk-lib` and `aws-cdk-aws-location-alpha` package versions, or an outdated `jsii` runtime.

fix Ensure `aws-cdk-lib` and `aws-cdk-aws-location-alpha` are installed with matching major.minor.patch versions. You may need to update `jsii` or reinstall your `node_modules` if you are working in a JSII-enabled environment.
```
Error: There are no 'context' values defined for this stack.
```
cause CDK expects an AWS environment (account and region) to synthesize or deploy the stack, but it was not provided in the `App` or via environment variables.

fix Pass an `env` object to your Stack, e.g., `env=Environment(account=os.environ.get('CDK_DEFAULT_ACCOUNT'), region=os.environ.get('CDK_DEFAULT_REGION'))`. Ensure `CDK_DEFAULT_ACCOUNT` and `CDK_DEFAULT_REGION` are set in your shell environment.

Warnings

breaking As an 'alpha' module (`a0` suffix in version, `_alpha` in module name), APIs are subject to breaking changes without major version bumps. This module is not recommended for production workloads.
Fix: Review release notes for `aws-cdk-lib` and `aws-cdk-aws-location-alpha` with each update. For production, consider using L1 (Cfn) constructs from `aws_cdk.aws_location` if L2 constructs are not available in a stable module.
gotcha Alpha modules (`aws-cdk-aws-location-alpha`) must be strictly version-locked with the core `aws-cdk-lib` package. Mismatched versions can lead to `ModuleNotFoundError`, `AttributeError`, or `TypeError` due to underlying JSII compatibility issues.
Fix: Always install `aws-cdk-aws-location-alpha` with the same major.minor.patch version prefix as your `aws-cdk-lib`. For example, if `aws-cdk-lib==2.250.0`, install `aws-cdk-aws-location-alpha==2.250.0a0`.
gotcha Deploying AWS CDK applications requires the AWS CDK CLI (`aws-cdk`) to be installed globally and configured with valid AWS credentials and a default region/account.
Fix: Install the CLI via `npm install -g aws-cdk`. Configure your AWS credentials (e.g., `aws configure` or environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION`). Ensure `CDK_DEFAULT_ACCOUNT` and `CDK_DEFAULT_REGION` are set or specified in your `App`.

Install

pip install aws-cdk-aws-location-alpha Install library
npm install -g aws-cdk Install AWS CDK CLI (globally)

Imports

aws_location_alpha
wrong:
```
import aws_cdk.aws_location as location
```
correct:
```
import aws_cdk.aws_location_alpha as location
```
L2 constructs (e.g., `Tracker`) for Location Service are typically found in the `_alpha` module. The non-alpha `aws_cdk.aws_location` module usually contains only L1 (Cfn) constructs.
Stack
```
from aws_cdk import Stack
```
Standard import for defining a CDK Stack.

Quickstart

This example demonstrates how to define a basic AWS CDK Stack that provisions an AWS Location Service Tracker and a Geofence Collection using the `aws-cdk-aws-location-alpha` module. Ensure `CDK_DEFAULT_ACCOUNT` and `CDK_DEFAULT_REGION` environment variables are set or explicitly provided for deployment.

import os
from aws_cdk import (
    Stack,
    App,
    Environment,
)
import aws_cdk.aws_location_alpha as location
from constructs import Construct

class MyLocationStack(Stack):
    def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
        super().__init__(scope, construct_id, **kwargs)

        # Create an AWS Location Tracker
        tracker = location.Tracker(
            self, "MySimpleTracker",
            tracker_name="MyExampleTracker",
            description="A simple tracker for demonstration"
        )

        # Optional: Create a Geofence Collection
        geofence_collection = location.GeofenceCollection(
            self, "MySimpleGeofenceCollection",
            geofence_collection_name="MyExampleGeofenceCollection",
            description="A simple geofence collection"
        )

app = App()
MyLocationStack(app, "MyLocationServiceStack",
    env=Environment(
        account=os.environ.get("CDK_DEFAULT_ACCOUNT"),
        region=os.environ.get("CDK_DEFAULT_REGION"),
    )
)
app.synth()

view raw JSON →