Package software.amazon.awscdk.services.location

Class CfnRouteCalculator

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.location.CfnRouteCalculator
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:59.794Z") @Stability(Stable) public class CfnRouteCalculator extends CfnResource implements IInspectable
A CloudFormation AWS::Location::RouteCalculator.

Specifies a route calculator resource in your AWS account.

You can send requests to a route calculator resource to estimate travel time, distance, and get directions. A route calculator sources traffic and road network data from your chosen data provider.

If your application is tracking or routing assets you use in your business, such as delivery vehicles or employees, you must not use Esri as your geolocation provider. See section 82 of the AWS service terms for more details.

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.*;
 CfnRouteCalculator cfnRouteCalculator = CfnRouteCalculator.Builder.create(this, "MyCfnRouteCalculator")
         .calculatorName("calculatorName")
         .dataSource("dataSource")
         // the properties below are optional
         .description("description")
         .pricingPlan("pricingPlan")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRouteCalculator

      protected CfnRouteCalculator(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRouteCalculator

      protected CfnRouteCalculator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRouteCalculator

      @Stability(Stable) public CfnRouteCalculator(@NotNull Construct scope, @NotNull String id, @NotNull CfnRouteCalculatorProps props)
      Create a new AWS::Location::RouteCalculator.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      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

    • getAttrCalculatorArn

      @Stability(Stable) @NotNull public String getAttrCalculatorArn()
      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

    • getAttrCreateTime

      @Stability(Stable) @NotNull public String getAttrCreateTime()
      The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCalculatorName

      @Stability(Stable) @NotNull public 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 .

    • setCalculatorName

      @Stability(Stable) public void setCalculatorName(@NotNull String value)
      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(Stable) @NotNull public 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:

      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 .

    • setDataSource

      @Stability(Stable) public void setDataSource(@NotNull String value)
      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 .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The optional description for the route calculator resource.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The optional description for the route calculator resource.

    • getPricingPlan

      @Stability(Stable) @Nullable public String getPricingPlan()
      No longer used. If included, the only allowed value is RequestBasedUsage .

      Allowed Values : RequestBasedUsage

    • setPricingPlan

      @Stability(Stable) public void setPricingPlan(@Nullable String value)
      No longer used. If included, the only allowed value is RequestBasedUsage .

      Allowed Values : RequestBasedUsage