Package software.amazon.awscdk.services.location

Class CfnRouteCalculator.Builder

java.lang.Object

software.amazon.awscdk.services.location.CfnRouteCalculator.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnRouteCalculator>

Enclosing class:

CfnRouteCalculator

@Stability(Stable)
public static final class CfnRouteCalculator.Builder
extends Object
implements software.amazon.jsii.Builder<CfnRouteCalculator>

A fluent builder for CfnRouteCalculator.

Method Summary

Modifier and Type	Method	Description
CfnRouteCalculator	build()
CfnRouteCalculator.Builder	calculatorName(String calculatorName)	The name of the route calculator resource.
static CfnRouteCalculator.Builder	create(software.constructs.Construct scope, String id)
CfnRouteCalculator.Builder	dataSource(String dataSource)	Specifies the data provider of traffic and road network data.
CfnRouteCalculator.Builder	description(String description)	The optional description for the route calculator resource.
CfnRouteCalculator.Builder	pricingPlan(String pricingPlan)	No longer used.
CfnRouteCalculator.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnRouteCalculator.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnRouteCalculator.Builder.

calculatorName

@Stability(Stable)
public CfnRouteCalculator.Builder calculatorName(String 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 .

Parameters:

calculatorName - The name of the route calculator resource. This parameter is required.

Returns:

this

See Also:

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

dataSource

@Stability(Stable)
public CfnRouteCalculator.Builder dataSource(String dataSource)

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 – 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 .

Parameters:

dataSource - Specifies the data provider of traffic and road network data. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnRouteCalculator.Builder description(String description)

The optional description for the route calculator resource.

Parameters:

description - The optional description for the route calculator resource. This parameter is required.

Returns:

this

See Also:

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

pricingPlan

@Stability(Stable)
public CfnRouteCalculator.Builder pricingPlan(String pricingPlan)

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

Allowed Values : RequestBasedUsage

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage . This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnRouteCalculator.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnRouteCalculator build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnRouteCalculator>

Returns:

a newly built instance of CfnRouteCalculator.