software.amazon.awscdk.services.location

Class CfnRouteCalculator

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.location.CfnRouteCalculator

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.688Z")
 @Stability(value=Stable)
public class CfnRouteCalculator
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Location::RouteCalculator`.

The AWS::Location::RouteCalculator resource 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.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRouteCalculator.Builder A fluent builder for CfnRouteCalculator.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRouteCalculator(software.constructs.Construct scope, String id, CfnRouteCalculatorProps props) Create a new `AWS::Location::RouteCalculator`.
protected	CfnRouteCalculator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRouteCalculator(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) for the route calculator resource.
String	getAttrCalculatorArn() Synonym for `Arn` .
String	getAttrCreateTime() The timestamp for when the route calculator resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
String	getAttrUpdateTime() The timestamp for when the route calculator resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .
String	getCalculatorName() The name of the route calculator resource.
protected Map<String,Object>	getCfnProperties()
String	getDataSource() Specifies the data provider of traffic and road network data.
String	getDescription() The optional description for the route calculator resource.
String	getPricingPlan() No longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCalculatorName(String value) The name of the route calculator resource.
void	setDataSource(String value) Specifies the data provider of traffic and road network data.
void	setDescription(String value) The optional description for the route calculator resource.
void	setPricingPlan(String value) No longer used.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRouteCalculator

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

CfnRouteCalculator

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

CfnRouteCalculator

@Stability(value=Stable)
public CfnRouteCalculator(@NotNull
                                                   software.constructs.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 Detail

inspect

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

The timestamp for when the route calculator resource was created in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getAttrUpdateTime

@Stability(value=Stable)
 @NotNull
public String getAttrUpdateTime()

The timestamp for when the route calculator resource was last updated in [ISO 8601](https://docs.aws.amazon.com/https://www.iso.org/iso-8601-date-and-time-format.html) format: `YYYY-MM-DDThh:mm:ss.sssZ` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCalculatorName

@Stability(value=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(value=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(value=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:

• Esri
• Here

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

setDataSource

@Stability(value=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:

• Esri
• Here

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

getDescription

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

The optional description for the route calculator resource.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The optional description for the route calculator resource.

getPricingPlan

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

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

Allowed Values : RequestBasedUsage

setPricingPlan

@Stability(value=Stable)
public void setPricingPlan(@Nullable
                                                    String value)

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

Allowed Values : RequestBasedUsage