Class RouteCalculator

(experimental) A Route Calculator.

Inheritance

object

Resource

RouteCalculator

Implements

IRouteCalculator

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Location.Alpha

Assembly: Amazon.CDK.AWS.Location.Alpha.dll

Syntax (csharp)

public class RouteCalculator : Resource, IRouteCalculator, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class RouteCalculator Inherits Resource Implements IRouteCalculator, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/location/latest/developerguide/places-concepts.html

ExampleMetadata: infused

Examples

new RouteCalculator(this, "RouteCalculator", new RouteCalculatorProps {
                 RouteCalculatorName = "MyRouteCalculator",  // optional, defaults to a generated name
                 DataSource = DataSource.ESRI
             });

Synopsis

Constructors

RouteCalculator(Construct, string, IRouteCalculatorProps)

(experimental) A Route Calculator.

Properties

PROPERTY_INJECTION_ID	(experimental) Uniquely identifies this class.
RouteCalculatorArn	(experimental) The Amazon Resource Name (ARN) of the route calculator resource.
RouteCalculatorCreateTime	(experimental) The timestamp for when the route calculator resource was created in ISO 8601 format.
RouteCalculatorName	(experimental) The name of the route calculator.
RouteCalculatorUpdateTime	(experimental) The timestamp for when the route calculator resource was last updated in ISO 8601 format.

Methods

FromRouteCalculatorArn(Construct, string, string)	(experimental) Use an existing route calculator by ARN.
FromRouteCalculatorName(Construct, string, string)	(experimental) Use an existing route calculator by name.
Grant(IGrantable, params string[])	(experimental) Grant the given principal identity permissions to perform the actions on this route calculator.
GrantRead(IGrantable)	(experimental) Grant the given identity permissions to access to a route calculator resource to calculate a route.

Constructors

RouteCalculator(Construct, string, IRouteCalculatorProps)

(experimental) A Route Calculator.

public RouteCalculator(Construct scope, string id, IRouteCalculatorProps props)

Parameters

scope Construct
id string
props IRouteCalculatorProps

Remarks

Stability: Experimental

Properties

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Stability: Experimental

RouteCalculatorArn

(experimental) The Amazon Resource Name (ARN) of the route calculator resource.

public virtual string RouteCalculatorArn { get; }

Property Value

string

Remarks

Stability: Experimental

RouteCalculatorCreateTime

(experimental) The timestamp for when the route calculator resource was created in ISO 8601 format.

public virtual string RouteCalculatorCreateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

RouteCalculatorName

(experimental) The name of the route calculator.

public virtual string RouteCalculatorName { get; }

Property Value

string

Remarks

Stability: Experimental

RouteCalculatorUpdateTime

(experimental) The timestamp for when the route calculator resource was last updated in ISO 8601 format.

public virtual string RouteCalculatorUpdateTime { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

FromRouteCalculatorArn(Construct, string, string)

(experimental) Use an existing route calculator by ARN.

public static IRouteCalculator FromRouteCalculatorArn(Construct scope, string id, string routeCalculatorArn)

Parameters

scope Construct
id string
routeCalculatorArn string

Returns

IRouteCalculator

Remarks

Stability: Experimental

FromRouteCalculatorName(Construct, string, string)

(experimental) Use an existing route calculator by name.

public static IRouteCalculator FromRouteCalculatorName(Construct scope, string id, string routeCalculatorName)

Parameters

scope Construct
id string
routeCalculatorName string

Returns

IRouteCalculator

Remarks

Stability: Experimental

Grant(IGrantable, params string[])

(experimental) Grant the given principal identity permissions to perform the actions on this route calculator.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable
actions string[]

Returns

Grant

Remarks

Stability: Experimental

GrantRead(IGrantable)

(experimental) Grant the given identity permissions to access to a route calculator resource to calculate a route.

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

Stability: Experimental

See: https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-calculate-route

Implements

IRouteCalculator

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware