software.amazon.awscdk.services.location

Interface CfnRouteCalculatorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRouteCalculatorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.689Z")
 @Stability(value=Stable)
public interface CfnRouteCalculatorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnRouteCalculator`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.location.*;
 CfnRouteCalculatorProps cfnRouteCalculatorProps = CfnRouteCalculatorProps.builder()
         .calculatorName("calculatorName")
         .dataSource("dataSource")
         // the properties below are optional
         .description("description")
         .pricingPlan("pricingPlan")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRouteCalculatorProps.Builder A builder for CfnRouteCalculatorProps
static class	CfnRouteCalculatorProps.Jsii$Proxy An implementation for CfnRouteCalculatorProps

Method Summary

Modifier and Type	Method and Description
static CfnRouteCalculatorProps.Builder	builder()
String	getCalculatorName() The name of the route calculator resource.
String	getDataSource() Specifies the data provider of traffic and road network data.
default String	getDescription() The optional description for the route calculator resource.
default String	getPricingPlan() No longer used.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCalculatorName

@Stability(value=Stable)
 @NotNull
String getCalculatorName()

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 .

getDataSource

@Stability(value=Stable)
 @NotNull
String getDataSource()

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:

• Esri
• Here

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

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

The optional description for the route calculator resource.

getPricingPlan

@Stability(value=Stable)
 @Nullable
default String getPricingPlan()

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

Allowed Values : RequestBasedUsage

builder

@Stability(value=Stable)
static CfnRouteCalculatorProps.Builder builder()

Returns:

a CfnRouteCalculatorProps.Builder of CfnRouteCalculatorProps