AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Location::RouteCalculator

CfnRouteCalculator

Specifies a route calculator resource in your AWS account. You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider. > If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the [AWS service terms](https://docs.aws.amazon.com/service-terms) for more details.

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as CfnRouteCalculatorProps.

calculatorNameRequired
string

The name of the route calculator resource. Requirements: - Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_). - Must be a unique Route calculator resource name. - No spaces allowed. For example, `ExampleRouteCalculator` .

dataSourceRequired
string

Specifies the data provider of traffic and road network data. > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error. Valid values include: - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/previous/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on street networks and traffic coverage](https://docs.aws.amazon.com/https://doc.arcgis.com/en/arcgis-online/reference/network-coverage.htm) . Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km. - `Grab` – Grab provides routing functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/previous/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area) . - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html) ' coverage in your region of interest, see [HERE car routing coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/car-routing.html) and [HERE truck routing coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/routing-api/dev_guide/topics/coverage/truck-routing.html) . For additional information , see [Data providers](https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html) on the *Amazon Location Service Developer Guide* .

descriptionOptional
string

The optional description for the route calculator resource.

pricingPlanOptional
string

No longer used. If included, the only allowed value is `RequestBasedUsage` . *Allowed Values* : `RequestBasedUsage`

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource.

CloudFormation Resource

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

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::RouteCalculator
Properties5

External Links