CfnRouteCalculatorProps

class aws_cdk.aws_location.CfnRouteCalculatorProps(*, calculator_name, data_source, description=None, pricing_plan=None)

Bases: object

Properties for defining a CfnRouteCalculator.

Parameters:

  • calculator_name (str) – 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 .

  • data_source (str) – Specifies the data provider of traffic and road network data. .. epigraph:: 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 (Optional[str]) – The optional description for the route calculator resource.

  • pricing_plan (Optional[str]) – No longer used. If included, the only allowed value is RequestBasedUsage . Allowed Values : RequestBasedUsage

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_location as location

cfn_route_calculator_props = location.CfnRouteCalculatorProps(
    calculator_name="calculatorName",
    data_source="dataSource",

    # the properties below are optional
    description="description",
    pricing_plan="pricingPlan"
)

Attributes

calculator_name

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 .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-calculatorname

data_source

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:

Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-datasource

description

The optional description for the route calculator resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-description

pricing_plan

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

Allowed Values : RequestBasedUsage

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-location-routecalculator.html#cfn-location-routecalculator-pricingplan