interface ApiKeyRestrictionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Location.CfnAPIKey.ApiKeyRestrictionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslocation#CfnAPIKey_ApiKeyRestrictionsProperty`
Java	`software.amazon.awscdk.services.location.CfnAPIKey.ApiKeyRestrictionsProperty`
Python	`aws_cdk.aws_location.CfnAPIKey.ApiKeyRestrictionsProperty`
TypeScript	`aws-cdk-lib` » `aws_location` » `CfnAPIKey` » `ApiKeyRestrictionsProperty`

API Restrictions on the allowed actions, resources, and referers for an API key resource.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_location as location } from 'aws-cdk-lib';
const apiKeyRestrictionsProperty: location.CfnAPIKey.ApiKeyRestrictionsProperty = {
  allowActions: ['allowActions'],
  allowResources: ['allowResources'],

  // the properties below are optional
  allowReferers: ['allowReferers'],
};

Properties

Name	Type	Description
allowActions	`string[]`	A list of allowed actions that an API key resource grants permissions to perform.
allowResources	`string[]`	A list of allowed resource ARNs that a API key bearer can perform actions on.
allowReferers?	`string[]`	An optional list of allowed HTTP referers for which requests must originate from.

allowActions

Type: string[]

A list of allowed actions that an API key resource grants permissions to perform.

You must have at least one action for each type of resource. For example, if you have a place resource, you must include at least one place action.

The following are valid values for the actions.

Map actions
geo:GetMap* - Allows all actions needed for map rendering.
Enhanced Maps actions
geo-maps:GetTile - Allows getting map tiles for rendering.
geo-maps:GetStaticMap - Allows getting static map images.
Place actions
geo:SearchPlaceIndexForText - Allows finding geo coordinates of a known place.
geo:SearchPlaceIndexForPosition - Allows getting nearest address to geo coordinates.
geo:SearchPlaceIndexForSuggestions - Allows suggestions based on an incomplete or misspelled query.
geo:GetPlace - Allows getting details of a place.
Enhanced Places actions
geo-places:Autcomplete - Allows auto-completion of search text.
geo-places:Geocode - Allows finding geo coordinates of a known place.
geo-places:GetPlace - Allows getting details of a place.
geo-places:ReverseGeocode - Allows getting nearest address to geo coordinates.
geo-places:SearchNearby - Allows category based places search around geo coordinates.
geo-places:SearchText - Allows place or address search based on free-form text.
geo-places:Suggest - Allows suggestions based on an incomplete or misspelled query.
Route actions
geo:CalculateRoute - Allows point to point routing.
geo:CalculateRouteMatrix - Allows matrix routing.
Enhanced Routes actions
geo-routes:CalculateIsolines - Allows isoline calculation.
geo-routes:CalculateRoutes - Allows point to point routing.
geo-routes:CalculateRouteMatrix - Allows matrix routing.
geo-routes:OptimizeWaypoints - Allows computing the best sequence of waypoints.
geo-routes:SnapToRoads - Allows snapping GPS points to a likely route.

You must use these strings exactly. For example, to provide access to map rendering, the only valid action is geo:GetMap* as an input to the list. ["geo:GetMap*"] is valid but ["geo:GetTile"] is not. Similarly, you cannot use ["geo:SearchPlaceIndexFor*"] - you must list each of the Place actions separately.

allowResources

Type: string[]

A list of allowed resource ARNs that a API key bearer can perform actions on.

The ARN must be the correct ARN for a map, place, or route ARN. You may include wildcards in the resource-id to match multiple resources of the same type.
The resources must be in the same partition , region , and account-id as the key that is being created.
Other than wildcards, you must include the full ARN, including the arn , partition , service , region , account-id and resource-id delimited by colons (:).
No spaces allowed, even with wildcards. For example, arn:aws:geo:region: *account-id* :map/ExampleMap* .

For more information about ARN format, see Amazon Resource Names (ARNs) .

allowReferers?

Type: string[] (optional)

An optional list of allowed HTTP referers for which requests must originate from.

Requests using this API key from other domains will not be allowed.

Requirements:

Contain only alphanumeric characters (A–Z, a–z, 0–9) or any symbols in this list $\-._+!*(),;/?:@=&`
May contain a percent (%) if followed by 2 hexadecimal digits (A-F, a-f, 0-9); this is used for URL encoding purposes.
May contain wildcard characters question mark (?) and asterisk (*).

Question mark (?) will replace any single character (including hexadecimal digits).

Asterisk (*) will replace any multiple characters (including multiple hexadecimal digits).

No spaces allowed. For example, https://example.com .