Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.location.RouteCalculator
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Location::RouteCalculator Resource Type
Create RouteCalculator Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RouteCalculator(name: string, args: RouteCalculatorArgs, opts?: CustomResourceOptions);@overload
def RouteCalculator(resource_name: str,
args: RouteCalculatorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RouteCalculator(resource_name: str,
opts: Optional[ResourceOptions] = None,
data_source: Optional[str] = None,
calculator_name: Optional[str] = None,
description: Optional[str] = None,
pricing_plan: Optional[RouteCalculatorPricingPlan] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewRouteCalculator(ctx *Context, name string, args RouteCalculatorArgs, opts ...ResourceOption) (*RouteCalculator, error)public RouteCalculator(string name, RouteCalculatorArgs args, CustomResourceOptions? opts = null)
public RouteCalculator(String name, RouteCalculatorArgs args)
public RouteCalculator(String name, RouteCalculatorArgs args, CustomResourceOptions options)
type: aws-native:location:RouteCalculator
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RouteCalculatorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RouteCalculatorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RouteCalculatorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RouteCalculatorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RouteCalculatorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
RouteCalculator Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RouteCalculator resource accepts the following input properties:
- Data
Source 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
HEREreturns 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 .
- Calculator
Name 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.
- Description string
- The optional description for the route calculator resource.
- Pricing
Plan Pulumi.Aws Native. Location. Route Calculator Pricing Plan No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values :
RequestBasedUsage-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource.
- Data
Source 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
HEREreturns 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 .
- Calculator
Name 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.
- Description string
- The optional description for the route calculator resource.
- Pricing
Plan RouteCalculator Pricing Plan No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values :
RequestBasedUsage-
Tag
Args - An array of key-value pairs to apply to this resource.
- data
Source 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
HEREreturns 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 .
- calculator
Name 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.
- description String
- The optional description for the route calculator resource.
- pricing
Plan RouteCalculator Pricing Plan No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values :
RequestBasedUsage- List<Tag>
- An array of key-value pairs to apply to this resource.
- data
Source 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
HEREreturns 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 .
- calculator
Name 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.
- description string
- The optional description for the route calculator resource.
- pricing
Plan RouteCalculator Pricing Plan No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values :
RequestBasedUsage- Tag[]
- An array of key-value pairs to apply to this resource.
- data_
source str Specifies the data provider of traffic and road network data.
This field is case-sensitive. Enter the valid values as shown. For example, entering
HEREreturns 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 .
- 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.
- description str
- The optional description for the route calculator resource.
- pricing_
plan RouteCalculator Pricing Plan No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values :
RequestBasedUsage-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource.
- data
Source 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
HEREreturns 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 .
- calculator
Name 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.
- description String
- The optional description for the route calculator resource.
- pricing
Plan "RequestBased Usage" No longer used. If included, the only allowed value is
RequestBasedUsage.Allowed Values :
RequestBasedUsage- List<Property Map>
- An array of key-value pairs to apply to this resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the RouteCalculator resource produces the following output properties:
- Arn string
- 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
- Format example:
- Calculator
Arn string - 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
- Format example:
- Create
Time string - The timestamp for when the route calculator resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. - Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - The timestamp for when the route calculator resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
- Arn string
- 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
- Format example:
- Calculator
Arn string - 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
- Format example:
- Create
Time string - The timestamp for when the route calculator resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. - Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - The timestamp for when the route calculator resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
- arn String
- 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
- Format example:
- calculator
Arn String - 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
- Format example:
- create
Time String - The timestamp for when the route calculator resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. - id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - The timestamp for when the route calculator resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
- arn string
- 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
- Format example:
- calculator
Arn string - 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
- Format example:
- create
Time string - The timestamp for when the route calculator resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. - id string
- The provider-assigned unique ID for this managed resource.
- update
Time string - The timestamp for when the route calculator resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
- arn str
- 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
- Format example:
- calculator_
arn str - 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
- Format example:
- create_
time str - The timestamp for when the route calculator resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. - id str
- The provider-assigned unique ID for this managed resource.
- update_
time str - The timestamp for when the route calculator resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
- arn String
- 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
- Format example:
- calculator
Arn String - 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
- Format example:
- create
Time String - The timestamp for when the route calculator resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ. - id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - The timestamp for when the route calculator resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ.
Supporting Types
RouteCalculatorPricingPlan, RouteCalculatorPricingPlanArgs
- Request
Based Usage - RequestBasedUsage
- Route
Calculator Pricing Plan Request Based Usage - RequestBasedUsage
- Request
Based Usage - RequestBasedUsage
- Request
Based Usage - RequestBasedUsage
- REQUEST_BASED_USAGE
- RequestBasedUsage
- "Request
Based Usage" - RequestBasedUsage
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.