Package software.amazon.awscdk.services.location.alpha

Class RouteCalculator

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.location.alpha.RouteCalculator

All Implemented Interfaces:

IResource, IRouteCalculator, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:18.292Z")
@Stability(Experimental)
public class RouteCalculator
extends Resource
implements IRouteCalculator

(experimental) A Route Calculator.

Example:

 RouteCalculator.Builder.create(this, "RouteCalculator")
         .routeCalculatorName("MyRouteCalculator") // optional, defaults to a generated name
         .dataSource(DataSource.ESRI)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RouteCalculator.Builder	(experimental) A fluent builder for RouteCalculator.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.location.alpha.IRouteCalculator

IRouteCalculator.Jsii$Default, IRouteCalculator.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RouteCalculator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RouteCalculator(software.amazon.jsii.JsiiObjectRef objRef)
	RouteCalculator(software.constructs.Construct scope, String id, RouteCalculatorProps props)

Method Summary

Modifier and Type	Method	Description
static IRouteCalculator	fromRouteCalculatorArn(software.constructs.Construct scope, String id, String routeCalculatorArn)	(experimental) Use an existing route calculator by ARN.
static IRouteCalculator	fromRouteCalculatorName(software.constructs.Construct scope, String id, String routeCalculatorName)	(experimental) Use an existing route calculator by name.
String	getRouteCalculatorArn()	(experimental) The Amazon Resource Name (ARN) of the route calculator resource.
String	getRouteCalculatorCreateTime()	(experimental) The timestamp for when the route calculator resource was created in ISO 8601 format.
String	getRouteCalculatorName()	(experimental) The name of the route calculator.
String	getRouteCalculatorUpdateTime()	(experimental) The timestamp for when the route calculator resource was last updated in ISO 8601 format.
Grant	grant(IGrantable grantee, @NotNull String... actions)	(experimental) Grant the given principal identity permissions to perform the actions on this route calculator.
Grant	grantRead(IGrantable grantee)	(experimental) Grant the given identity permissions to access to a route calculator resource to calculate a route.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

RouteCalculator

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

RouteCalculator

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

RouteCalculator

@Stability(Experimental)
public RouteCalculator(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 RouteCalculatorProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromRouteCalculatorArn

@Stability(Experimental)
@NotNull
public static IRouteCalculator fromRouteCalculatorArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String routeCalculatorArn)

(experimental) Use an existing route calculator by ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

routeCalculatorArn - This parameter is required.

fromRouteCalculatorName

@Stability(Experimental)
@NotNull
public static IRouteCalculator fromRouteCalculatorName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String routeCalculatorName)

(experimental) Use an existing route calculator by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

routeCalculatorName - This parameter is required.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(Experimental)
@NotNull
public Grant grantRead(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

See Also:

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

getRouteCalculatorArn

@Stability(Experimental)
@NotNull
public String getRouteCalculatorArn()

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

Specified by:

getRouteCalculatorArn in interface IRouteCalculator

getRouteCalculatorCreateTime

@Stability(Experimental)
@NotNull
public String getRouteCalculatorCreateTime()

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

getRouteCalculatorName

@Stability(Experimental)
@NotNull
public String getRouteCalculatorName()

(experimental) The name of the route calculator.

Specified by:

getRouteCalculatorName in interface IRouteCalculator

getRouteCalculatorUpdateTime

@Stability(Experimental)
@NotNull
public String getRouteCalculatorUpdateTime()

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