-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(location): support RouteCalculator (#30682)
### Issue # (if applicable) Closes #30681 . ### Reason for this change In [aws-location-alpha](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-location-alpha-readme.html), [route calculator](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_location.CfnRouteCalculator.html) has not been supported yet. ### Description of changes Add `RouteCalculator` class. ### Description of how you validated changes Add unit tests and integ tests. ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
- Loading branch information
Showing
16 changed files
with
710 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
export * from './geofence-collection'; | ||
export * from './place-index'; | ||
export * from './route-calculator'; | ||
export * from './util'; | ||
|
||
// AWS::Location CloudFormation Resources: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
158 changes: 158 additions & 0 deletions
158
packages/@aws-cdk/aws-location-alpha/lib/route-calculator.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
import * as iam from 'aws-cdk-lib/aws-iam'; | ||
import { ArnFormat, IResource, Lazy, Resource, Stack, Token } from 'aws-cdk-lib/core'; | ||
import { Construct } from 'constructs'; | ||
import { CfnRouteCalculator } from 'aws-cdk-lib/aws-location'; | ||
import { generateUniqueId, DataSource } from './util'; | ||
|
||
/** | ||
* A Route Calculator | ||
*/ | ||
export interface IRouteCalculator extends IResource { | ||
/** | ||
* The name of the route calculator | ||
* | ||
* @attribute | ||
*/ | ||
readonly routeCalculatorName: string; | ||
|
||
/** | ||
* The Amazon Resource Name (ARN) of the route calculator resource | ||
* | ||
* @attribute Arn,CalculatorArn | ||
*/ | ||
readonly routeCalculatorArn: string; | ||
} | ||
|
||
/** | ||
* Properties for a route calculator | ||
*/ | ||
export interface RouteCalculatorProps { | ||
/** | ||
* A name for the route calculator | ||
* | ||
* Must be between 1 and 100 characters and contain only alphanumeric characters, | ||
* hyphens, periods and underscores. | ||
* | ||
* @default - A name is automatically generated | ||
*/ | ||
readonly routeCalculatorName?: string; | ||
|
||
/** | ||
* Data source for the route calculator | ||
*/ | ||
readonly dataSource: DataSource; | ||
|
||
/** | ||
* A description for the route calculator | ||
* | ||
* @default - no description | ||
*/ | ||
readonly description?: string; | ||
} | ||
|
||
/** | ||
* A Route Calculator | ||
* | ||
* @see https://docs.aws.amazon.com/location/latest/developerguide/places-concepts.html | ||
*/ | ||
export class RouteCalculator extends Resource implements IRouteCalculator { | ||
/** | ||
* Use an existing route calculator by name | ||
*/ | ||
public static fromRouteCalculatorName(scope: Construct, id: string, routeCalculatorName: string): IRouteCalculator { | ||
const routeCalculatorArn = Stack.of(scope).formatArn({ | ||
service: 'geo', | ||
resource: 'route-calculator', | ||
resourceName: routeCalculatorName, | ||
}); | ||
|
||
return RouteCalculator.fromRouteCalculatorArn(scope, id, routeCalculatorArn); | ||
} | ||
|
||
/** | ||
* Use an existing route calculator by ARN | ||
*/ | ||
public static fromRouteCalculatorArn(scope: Construct, id: string, routeCalculatorArn: string): IRouteCalculator { | ||
const parsedArn = Stack.of(scope).splitArn(routeCalculatorArn, ArnFormat.SLASH_RESOURCE_NAME); | ||
|
||
if (!parsedArn.resourceName) { | ||
throw new Error(`Route Calculator Arn ${routeCalculatorArn} does not have a resource name.`); | ||
} | ||
|
||
class Import extends Resource implements IRouteCalculator { | ||
public readonly routeCalculatorName = parsedArn.resourceName!; | ||
public readonly routeCalculatorArn = routeCalculatorArn; | ||
} | ||
|
||
return new Import(scope, id, { | ||
account: parsedArn.account, | ||
region: parsedArn.region, | ||
}); | ||
} | ||
|
||
public readonly routeCalculatorName: string; | ||
|
||
public readonly routeCalculatorArn: string; | ||
|
||
/** | ||
* The timestamp for when the route calculator resource was created in ISO 8601 format | ||
* | ||
* @attribute | ||
*/ | ||
public readonly routeCalculatorCreateTime: string; | ||
|
||
/** | ||
* The timestamp for when the route calculator resource was last updated in ISO 8601 format | ||
* | ||
* @attribute | ||
*/ | ||
public readonly routeCalculatorUpdateTime: string; | ||
|
||
constructor(scope: Construct, id: string, props: RouteCalculatorProps) { | ||
|
||
if (props.description && !Token.isUnresolved(props.description) && props.description.length > 1000) { | ||
throw new Error(`\`description\` must be between 0 and 1000 characters. Received: ${props.description.length} characters`); | ||
} | ||
|
||
if (props.routeCalculatorName && !Token.isUnresolved(props.routeCalculatorName) && !/^[-.\w]{1,100}$/.test(props.routeCalculatorName)) { | ||
throw new Error(`Invalid route calculator name. The route calculator name must be between 1 and 100 characters and contain only alphanumeric characters, hyphens, periods and underscores. Received: ${props.routeCalculatorName}`); | ||
} | ||
|
||
super(scope, id, { | ||
physicalName: props.routeCalculatorName ?? Lazy.string({ produce: () => generateUniqueId(this) }), | ||
}); | ||
|
||
const routeCalculator = new CfnRouteCalculator(this, 'Resource', { | ||
calculatorName: this.physicalName, | ||
dataSource: props.dataSource ?? DataSource.ESRI, | ||
description: props.description, | ||
}); | ||
|
||
this.routeCalculatorName = routeCalculator.ref; | ||
this.routeCalculatorArn = routeCalculator.attrArn; | ||
this.routeCalculatorCreateTime = routeCalculator.attrCreateTime; | ||
this.routeCalculatorUpdateTime = routeCalculator.attrUpdateTime; | ||
} | ||
|
||
/** | ||
* Grant the given principal identity permissions to perform the actions on this route calculator. | ||
*/ | ||
public grant(grantee: iam.IGrantable, ...actions: string[]): iam.Grant { | ||
return iam.Grant.addToPrincipal({ | ||
grantee: grantee, | ||
actions: actions, | ||
resourceArns: [this.routeCalculatorArn], | ||
}); | ||
} | ||
|
||
/** | ||
* Grant the given identity permissions to access to a route calculator resource to calculate a route. | ||
* | ||
* @see https://docs.aws.amazon.com/location/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-calculate-route | ||
*/ | ||
public grantRead(grantee: iam.IGrantable): iam.Grant { | ||
return this.grant(grantee, | ||
'geo:CalculateRoute', | ||
); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
...ute-calculator.js.snapshot/RouteCalculatorTestDefaultTestDeployAssert5893D6F4.assets.json
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
36 changes: 36 additions & 0 deletions
36
...e-calculator.js.snapshot/RouteCalculatorTestDefaultTestDeployAssert5893D6F4.template.json
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
19 changes: 19 additions & 0 deletions
19
...a/test/integ.route-calculator.js.snapshot/cdk-integ-location-route-calculator.assets.json
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
45 changes: 45 additions & 0 deletions
45
...test/integ.route-calculator.js.snapshot/cdk-integ-location-route-calculator.template.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
{ | ||
"Resources": { | ||
"RouteCalculator0F2D109D": { | ||
"Type": "AWS::Location::RouteCalculator", | ||
"Properties": { | ||
"CalculatorName": "cdkinteglocationroutecalculatorRouteCalculator916939B5", | ||
"DataSource": "Esri" | ||
} | ||
} | ||
}, | ||
"Parameters": { | ||
"BootstrapVersion": { | ||
"Type": "AWS::SSM::Parameter::Value<String>", | ||
"Default": "/cdk-bootstrap/hnb659fds/version", | ||
"Description": "Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]" | ||
} | ||
}, | ||
"Rules": { | ||
"CheckBootstrapVersion": { | ||
"Assertions": [ | ||
{ | ||
"Assert": { | ||
"Fn::Not": [ | ||
{ | ||
"Fn::Contains": [ | ||
[ | ||
"1", | ||
"2", | ||
"3", | ||
"4", | ||
"5" | ||
], | ||
{ | ||
"Ref": "BootstrapVersion" | ||
} | ||
] | ||
} | ||
] | ||
}, | ||
"AssertDescription": "CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI." | ||
} | ||
] | ||
} | ||
} | ||
} |
1 change: 1 addition & 0 deletions
1
packages/@aws-cdk/aws-location-alpha/test/integ.route-calculator.js.snapshot/cdk.out
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.