aws-cdk-lib.aws_location.CfnRouteCalculatorProps

interface CfnRouteCalculatorProps

LanguageType name
.NETAmazon.CDK.AWS.Location.CfnRouteCalculatorProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslocation#CfnRouteCalculatorProps
Javasoftware.amazon.awscdk.services.location.CfnRouteCalculatorProps
Pythonaws_cdk.aws_location.CfnRouteCalculatorProps
TypeScript aws-cdk-lib » aws_location » CfnRouteCalculatorProps

Properties for defining a CfnRouteCalculator.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_location as location } from 'aws-cdk-lib';
const cfnRouteCalculatorProps: location.CfnRouteCalculatorProps = {
  calculatorName: 'calculatorName',
  dataSource: 'dataSource',

  // the properties below are optional
  description: 'description',
  pricingPlan: 'pricingPlan',
};

Properties

NameTypeDescription
calculatorNamestringThe name of the route calculator resource.
dataSourcestringSpecifies the data provider of traffic and road network data.
description?stringThe optional description for the route calculator resource.
pricingPlan?stringNo longer used. If included, the only allowed value is RequestBasedUsage .

calculatorName

Type: 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 .

dataSource

Type: 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 's coverage in your region of interest, see Esri details on street networks and traffic coverage .

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 ' coverage, see GrabMaps countries and areas covered .
  • Here – For additional information about HERE Technologies ' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage .

For additional information , see Data providers on the Amazon Location Service Developer Guide .


description?

Type: string (optional)

The optional description for the route calculator resource.


pricingPlan?

Type: string (optional)

No longer used. If included, the only allowed value is RequestBasedUsage .

Allowed Values : RequestBasedUsage