AWS::Location::RouteCalculator - AWS CloudFormation

AWS::Location::RouteCalculator

The AWS::Location::RouteCalculator resource 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Location::RouteCalculator", "Properties" : { "CalculatorName" : String, "DataSource" : String, "Description" : String, "PricingPlan" : String } }

YAML

Type: AWS::Location::RouteCalculator Properties: CalculatorName: String DataSource: String Description: String PricingPlan: String

Properties

CalculatorName

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: ^[-._\w]+$

Update requires: Replacement

DataSource

Specifies the data provider of traffic and road network data.

Note

This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.

Valid values include:

  • Esri

  • Here

For more information about data providers, see the Amazon Location Service data providers page.

Required: Yes

Type: String

Update requires: Replacement

Description

The optional description for the route calculator resource.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Update requires: Replacement

PricingPlan

Specifies the pricing plan for your route calculator resource.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

Required: Yes

Type: String

Allowed values: MobileAssetManagement | MobileAssetTracking | RequestBasedUsage

Update requires: Replacement