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

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

Allowed Values: RequestBasedUsage

Required: No

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the RouteCalculator name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.

  • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

CalculatorArn

Synonym for Arn. The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS.

  • Format example: arn:aws:geo:region:account-id:route-calculator/ExampleCalculator

CreateTime

The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

UpdateTime

The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.