AWS::Location::RouteCalculator - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Location::RouteCalculator

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.

Note

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 for more details.

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,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Location::RouteCalculator
Properties:
  CalculatorName: String
  DataSource: String
  Description: String
  PricingPlan: String
  Tags: 
    - Tag

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

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

Minimum: 1

Maximum: 100

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:

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

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: No interruption

PricingPlan

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

Allowed Values: RequestBasedUsage

Required: No

Type: String

Allowed values: RequestBasedUsage

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 200

Update requires: No interruption

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.