AWS::Location::PlaceIndexCfnPlaceIndex
Specifies a place index resource in your AWS account. Use a place index resource to geocode addresses and other text queries by using the `SearchPlaceIndexForText` operation, and reverse geocode coordinates by using the `SearchPlaceIndexForPosition` operation, and enable autosuggestions by using the `SearchPlaceIndexForSuggestions` operation. > 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](https://docs.aws.amazon.com/service-terms) for more details.
Import
import { CfnPlaceIndex } from 'aws-cdk-lib/aws-location';Or use the module namespace:
import * as location from 'aws-cdk-lib/aws-location';
// location.CfnPlaceIndexProperties
Configuration passed to the constructor as CfnPlaceIndexProps.
dataSourceRequiredstringSpecifies the geospatial data provider for the new place index. > This field is case-sensitive. Enter the valid values as shown. For example, entering `HERE` returns an error. Valid values include: - `Esri` – For additional information about [Esri](https://docs.aws.amazon.com/location/previous/developerguide/esri.html) 's coverage in your region of interest, see [Esri details on geocoding coverage](https://docs.aws.amazon.com/https://developers.arcgis.com/rest/geocode/api-reference/geocode-coverage.htm) . - `Grab` – Grab provides place index functionality for Southeast Asia. For additional information about [GrabMaps](https://docs.aws.amazon.com/location/previous/developerguide/grab.html) ' coverage, see [GrabMaps countries and areas covered](https://docs.aws.amazon.com/location/previous/developerguide/grab.html#grab-coverage-area) . - `Here` – For additional information about [HERE Technologies](https://docs.aws.amazon.com/location/previous/developerguide/HERE.html) ' coverage in your region of interest, see [HERE details on goecoding coverage](https://docs.aws.amazon.com/https://developer.here.com/documentation/geocoder/dev_guide/topics/coverage-geocoder.html) . > If you specify HERE Technologies ( `Here` ) as the data provider, you may not [store results](https://docs.aws.amazon.com//location-places/latest/APIReference/API_DataSourceConfiguration.html) for locations in Japan. For more information, see the [AWS service terms](https://docs.aws.amazon.com/service-terms/) for Amazon Location Service. For additional information , see [Data providers](https://docs.aws.amazon.com/location/previous/developerguide/what-is-data-provider.html) on the *Amazon Location Service developer guide* .
indexNameRequiredstringThe name of the place index resource. Requirements: - Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_). - Must be a unique place index resource name. - No spaces allowed. For example, `ExamplePlaceIndex` .
dataSourceConfigurationOptionalIResolvable | DataSourceConfigurationPropertySpecifies the data storage option requesting Places.
descriptionOptionalstringThe optional description for the place index resource.
pricingPlanOptionalstringNo longer used. If included, the only allowed value is `RequestBasedUsage` . *Allowed Values* : `RequestBasedUsage`
tagsOptionalCfnTag[]An array of key-value pairs to apply to this resource.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-locationAWS::Location::PlaceIndex