software.amazon.awscdk.services.location

Class CfnRouteCalculator

java.lang.Object

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

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:26.750Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRouteCalculator(Construct scope, java.lang.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
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) for the route calculator resource.
java.lang.String	getAttrCalculatorArn() Synonym for `Arn` .
java.lang.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` .
java.lang.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` .
java.lang.String	getCalculatorName() The name of the route calculator resource.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDataSource() Specifies the data provider of traffic and road network data.
java.lang.String	getDescription() The optional description for the route calculator resource.
java.lang.String	getPricingPlan() No longer used.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCalculatorName(java.lang.String value) The name of the route calculator resource.
void	setDataSource(java.lang.String value) Specifies the data provider of traffic and road network data.
void	setDescription(java.lang.String value) The optional description for the route calculator resource.
void	setPricingPlan(java.lang.String value) No longer used.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnRouteCalculator(Construct scope,
                          java.lang.String id,
                          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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.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

public java.lang.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

public java.lang.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

public java.lang.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

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCalculatorName

public java.lang.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

public void setCalculatorName(java.lang.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

public java.lang.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

public void setDataSource(java.lang.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

public java.lang.String getDescription()

The optional description for the route calculator resource.

setDescription

public void setDescription(java.lang.String value)

The optional description for the route calculator resource.

getPricingPlan

public java.lang.String getPricingPlan()

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

Allowed Values : RequestBasedUsage

setPricingPlan

public void setPricingPlan(java.lang.String value)

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

Allowed Values : RequestBasedUsage