class CfnRouteCalculator (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Location.CfnRouteCalculator`
Java	`software.amazon.awscdk.services.location.CfnRouteCalculator`
Python	`aws_cdk.aws_location.CfnRouteCalculator`
TypeScript	`@aws-cdk/aws-location` » `CfnRouteCalculator`

Implements IConstruct, IConstruct, IDependable, 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 * as location from '@aws-cdk/aws-location';
const cfnRouteCalculator = new location.CfnRouteCalculator(this, 'MyCfnRouteCalculator', {
  calculatorName: 'calculatorName',
  dataSource: 'dataSource',

  // the properties below are optional
  description: 'description',
  pricingPlan: 'pricingPlan',
});

Initializer

new CfnRouteCalculator(scope: Construct, id: string, props: CfnRouteCalculatorProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnRouteCalculatorProps — - resource properties.

Create a new AWS::Location::RouteCalculator.

Construct Props

Name	Type	Description
calculatorName	`string`	The name of the route calculator resource.
dataSource	`string`	Specifies the data provider of traffic and road network data.
description?	`string`	The optional description for the route calculator resource.
pricingPlan?	`string`	No longer used. If included, the only allowed value is `RequestBasedUsage` .

calculatorName

Type: string

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 .

dataSource

Type: string

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 .

description?

Type: string (optional)

The optional description for the route calculator resource.

pricingPlan?

Type: string (optional)

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

Allowed Values : RequestBasedUsage

Properties

Name	Type	Description
attrArn	`string`	The Amazon Resource Name (ARN) for the route calculator resource.
attrCalculatorArn	`string`	Synonym for `Arn` .
attrCreateTime	`string`	The timestamp for when the route calculator resource was created in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ` .
attrUpdateTime	`string`	The timestamp for when the route calculator resource was last updated in ISO 8601 format: `YYYY-MM-DDThh:mm:ss.sssZ` .
calculatorName	`string`	The name of the route calculator resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
dataSource	`string`	Specifies the data provider of traffic and road network data.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
description?	`string`	The optional description for the route calculator resource.
pricingPlan?	`string`	No longer used. If included, the only allowed value is `RequestBasedUsage` .
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

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

attrCalculatorArn

Type: string

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

attrCreateTime

Type: string

The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

attrUpdateTime

Type: string

The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ .

calculatorName

Type: string

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 .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

dataSource

Type: string

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 .

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

description?

Type: string (optional)

The optional description for the route calculator resource.

pricingPlan?

Type: string (optional)

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

Allowed Values : RequestBasedUsage

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }