Class CfnRouteCalculator
A CloudFormation AWS::Location::RouteCalculator
.
Inherited Members
Namespace: Amazon.CDK.AWS.Location
Assembly: Amazon.CDK.AWS.Location.dll
Syntax (csharp)
public class CfnRouteCalculator : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRouteCalculator
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Location::RouteCalculator
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Location;
var cfnRouteCalculator = new CfnRouteCalculator(this, "MyCfnRouteCalculator", new CfnRouteCalculatorProps {
CalculatorName = "calculatorName",
DataSource = "dataSource",
// the properties below are optional
Description = "description",
PricingPlan = "pricingPlan"
});
Synopsis
Constructors
CfnRouteCalculator(Construct, String, ICfnRouteCalculatorProps) | Create a new |
CfnRouteCalculator(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRouteCalculator(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) for the route calculator resource. |
AttrCalculatorArn | Synonym for |
AttrCreateTime | The timestamp for when the route calculator resource was created in ISO 8601 format: |
AttrUpdateTime | The timestamp for when the route calculator resource was last updated in ISO 8601 format: |
CalculatorName | The name of the route calculator resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataSource | Specifies the data provider of traffic and road network data. |
Description | The optional description for the route calculator resource. |
PricingPlan | No longer used. If included, the only allowed value is |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRouteCalculator(Construct, String, ICfnRouteCalculatorProps)
Create a new AWS::Location::RouteCalculator
.
public CfnRouteCalculator(Construct scope, string id, ICfnRouteCalculatorProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRouteCalculatorProps
- resource properties.
CfnRouteCalculator(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRouteCalculator(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRouteCalculator(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRouteCalculator(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) for the route calculator resource.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
Use the ARN when you specify a resource across all AWS .
CloudformationAttribute: Arn
AttrCalculatorArn
Synonym for Arn
.
public virtual string AttrCalculatorArn { get; }
Property Value
System.String
Remarks
The Amazon Resource Name (ARN) for the route calculator resource. Use the ARN when you specify a resource across all AWS .
CloudformationAttribute: CalculatorArn
AttrCreateTime
The timestamp for when the route calculator resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
public virtual string AttrCreateTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreateTime
AttrUpdateTime
The timestamp for when the route calculator resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
.
public virtual string AttrUpdateTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UpdateTime
CalculatorName
The name of the route calculator resource.
public virtual string CalculatorName { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataSource
Specifies the data provider of traffic and road network data.
public virtual string DataSource { get; set; }
Property Value
System.String
Remarks
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 .
Description
The optional description for the route calculator resource.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
PricingPlan
No longer used. If included, the only allowed value is RequestBasedUsage
.
public virtual string PricingPlan { get; set; }
Property Value
System.String
Remarks
Allowed Values : RequestBasedUsage
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>