Package software.amazon.awscdk.services.location.alpha

Interface RouteCalculatorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RouteCalculatorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.746Z")
@Stability(Experimental)
public interface RouteCalculatorProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a route calculator.

Example:

 RouteCalculator.Builder.create(this, "RouteCalculator")
         .routeCalculatorName("MyRouteCalculator") // optional, defaults to a generated name
         .dataSource(DataSource.ESRI)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RouteCalculatorProps.Builder	builder()
DataSource	getDataSource()	(experimental) Data source for the route calculator.
default String	getDescription()	(experimental) A description for the route calculator.
default String	getRouteCalculatorName()	(experimental) A name for the route calculator.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataSource

@Stability(Experimental)
@NotNull
DataSource getDataSource()

(experimental) Data source for the route calculator.

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) A description for the route calculator.

Default: - no description

getRouteCalculatorName

@Stability(Experimental)
@Nullable
default String getRouteCalculatorName()

(experimental) A name for the route calculator.

Must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores.

Default: - A name is automatically generated

builder

@Stability(Experimental)
static RouteCalculatorProps.Builder builder()

Returns:

a RouteCalculatorProps.Builder of RouteCalculatorProps